Esta página contém os detalhes de um projeto de redação técnica aceito para a Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- O Projeto FreeBSD
- Redator técnico:
- Larry
- Nome do projeto:
- Atualizações nos manuais do FreeBSD
- Duração do projeto:
- Longa duração (cinco meses)
Project description
Este projeto do GSoD2020 vai consistir em dois capítulos nos manuais do FreeBSD:
- Testes: novo capítulo no Manual para Desenvolvedores do FreeBSD
- LDAP: artigo atualizado mesclado no capítulo do Manual do FreeBSD
Testes: novo capítulo no Manual para Desenvolvedores do FreeBSD:
OBSERVAÇÃO: no início, este projeto é mais exploratório. Os requisitos podem mudar durante a fase de escrita.
As tarefas de preparação incluem: * Revisão da documentação e observações atuais sobre estruturas de teste do desenvolvedor, práticas etc. para FreeBSD e outros BSDs. * Documentação e notas atuais ou mais antigas do FreeBSD. Por exemplo: * TestSuite: https://wiki.freebsd.org/TestSuite * Página ""TestingFreeBSD""": https://wiki.freebsd.org/TestingFreeBSD * Documentação e observações atuais de projetos relacionados. Por exemplo: * http://wiki.netbsd.org/tutorials/atf/ * Documentação principal das ferramentas envolvidas. Por exemplo: * Framework de teste Kyua: https://github.com/jmmv/kyua/ * Framework de teste automatizado (ATF): https://github.com/jmmv/atf/ * Instalar e configurar os frameworks relevantes para se familiarizar com eles. * Uso de frameworks de teste para executar testes atuais. * Programar um pequeno número de novos testes. * (MUITO importante) Consultar os leitores (desenvolvedores de software e testadores) sobre o que eles querem ver no capítulo.
A organização exata da documentação ainda precisa ser determinada. No entanto, após ler o capítulo, o leitor precisa ser capaz de fazer o seguinte, no mínimo:
- Instale e configure os frameworks de teste para testar o FreeBSD.
- Crie um teste para o framework de teste.
- Execute um teste no framework de teste.
Os seguintes pontos serão enfatizados sempre que possível: * Maximizar a automação para reduzir o trabalho de configuração da infraestrutura de teste, criação de testes e execução de testes. * adicionar casos de teste sempre que um novo bug for corrigido. * testes de regressão automatizados abrangentes. * (quando aplicável) que abrange exemplos de cenários de teste padrão, como testes de unidade, testes funcionais, testes de carga e assim por diante.
Sempre que possível, o objetivo é não apenas explicar e orientar o desenvolvedor sobre o framework de teste, mas também manter o processo o mais simples possível para que os desenvolvedores sejam incentivados a incorporar mais testes e novos desenvolvedores não sejam desencorajados a contribuir.
LDAP: artigo atualizado incorporado ao capítulo do Manual do FreeBSD:
Ao contrário do capítulo sobre testes, o escopo de um artigo ou capítulo atualizado sobre LDAP é bem compreendido.
O capítulo atual do Manual do FreeBSD e o artigo atual contêm muitas informações úteis. No entanto, elas precisam ser atualizadas. Uma nova revisão do artigo, que deveria se tornar o novo capítulo, foi iniciada, mas precisa ser concluída.
As tarefas incluem: * Revisar o capítulo atual do manual e o artigo atual. * Em preparação para o GSoD2020, uma primeira etapa foi realizada. * Testar cada seção do manual para confirmar o que funciona e o que precisa ser revisado. * Em preparação para o GSoD2020, a configuração do servidor foi testada e identificou melhorias. * Outras seções restantes. * Escrever novos conteúdos e revisar os atuais. * O conteúdo atualizado foi iniciado para a seção do servidor. Ela precisa ser preenchida. * Outras seções restantes. * Testar todo o conteúdo em sistemas FreeBSD limpos após a conclusão do rascunho final. * Essa tarefa é essencial, porque identifica lacunas.
O artigo final ou o capítulo do manual deve conter as seguintes seções:
(1) Introdução ao LDAP (2) Configuração do servidor: (a) um tutorial explicativo de uma configuração básica, mas funcional, do servidor OpenLDAP no FreeBSD. (b) Um exemplo completo de uma configuração básica, mas funcional, do servidor OpenLDAP, por exemplo, o resultado de (2a), no FreeBSD.
"Básico, mas funcional" inclui a configuração do servidor com senhas com hash, conexões seguras na rede e dados de usuário simulados, mas representativos.
(Opcional: será decidido durante o GSoD2020) A configuração do servidor também pode incluir cobertura equivalente do servidor de diretório 389 no FreeBSD. O FreeBSD experimental foi compatível com o servidor de diretório 389, mas o status atual precisa ser confirmado.
(3) Configuração do cliente: (a) um tutorial explicativo de uma configuração funcional do cliente no FreeBSD que pode se conectar com o exemplo de conexão do servidor fornecido em (2). (b) Um exemplo completo de configuração de cliente funcional, por exemplo, o resultado de (3a), no FreeBSD.
A seção de configuração do cliente inclui subseções sobre o seguinte: * Módulo de autenticação com plug-in (PAM), por exemplo, pam_ldap, pam_mkhomedir, nss-pam-ldapd * Comutador de serviço de nome (NSS), por exemplo, nss_ldap, nss-pam-ldapd * (Opcional - a ser decidido durante o GSoD2020) SSSD: o status do SSSD em produção no FreeBSD precisa ser confirmado. * (Opcional: a ser decidido durante o GSoD2020) FreeIPA: o uso e a funcionalidade do FreeIPA no FreeBSD precisam ser investigados. O FreeIPA abrange mais do que apenas LDAP. Portanto, o escopo da configuração do FreeIPA precisa ser avaliado antes da inclusão neste capítulo do manual.
(4) Considerações de segurança * A versão atual do artigo inclui uma seção sobre considerações de segurança. Parte desse conteúdo pode ser movida para a seção relevante. No entanto, ainda deve haver uma seção dedicada sobre considerações de segurança para fins de referência.
(5) Solução de problemas * Estratégias para solucionar problemas de configuração do LDAP.
(6) Apêndice do OpenSSL
Com o capítulo / artigo atualizado do manual, o leitor pode usar dois sistemas FreeBSD limpos, configurar um servidor e um cliente LDAP e autenticar o cliente no servidor.
Após ler o capítulo / artigo atualizado do manual, o leitor deve ter as bases necessárias para obter outras documentações mais especializadas ou abrangentes, por exemplo, documentação do OpenLDAP, RFCs do LDAP, e para criar ou refinar a configuração LDAP do FreeBSD para atender aos requisitos.