Commit 4f50b626e0a28422440945e5d83b92bc3aca166e
1 parent
1663956b
Exists in
master
and in
88 other branches
Support docs
Signed-off-by: msfernandes <matheus.souza.fernandes@gmail.com>
Showing
4 changed files
with
79 additions
and
9 deletions
Show diff stats
| ... | ... | @@ -0,0 +1,66 @@ |
| 1 | +Documentação de Apoio | |
| 2 | +===================== | |
| 3 | +.. _referencia: | |
| 4 | + | |
| 5 | +Gerar Chave SSH | |
| 6 | +--------------- | |
| 7 | +Antes de gerar a chave SSH, verifique se o seu sistema já não possui uma chave:: | |
| 8 | + | |
| 9 | + $ cat ~/.ssh/id_rsa.pub | |
| 10 | + | |
| 11 | +Se o comando acima retornar uma grande string que inicia com ``ssh-rsa`` ou ``ssh-dsa``, você já possui uma chave e, portanto, pode pular essa parte do guia. | |
| 12 | + | |
| 13 | +Para gerar a chave, apenas abra o terminal e digite o comando:: | |
| 14 | + | |
| 15 | + $ ssh-keygen -t rsa -C "seu_email" | |
| 16 | + | |
| 17 | +O comando acima irá perguntar em que arquivo e diretório você deseja armazenar sua chave, você pode apenas apertar ``Enter`` para usar o valor padrão. Também será perguntado se você deseja proteger sua chave com uma senha. A senha não é obrigatória, você pode ignorar essa configuraçao apenas apertando ``Enter``. Vale lembrar que essa senha não pode ser alterada posteriormente. | |
| 18 | + | |
| 19 | +Configurar Chave SSH no Portal SPB | |
| 20 | +---------------------------------- | |
| 21 | + | |
| 22 | +Primeiramente, para conseguir configurar sua chave SSH no seu perfil do SPB é necessário estar registrado no portal. O registro pode ser feito em: https://portal.softwarepublico.gov.br/account/register . | |
| 23 | + | |
| 24 | +Após efetuar o login no Portal SPB, clique em ``Código``, no menu principal do portal, e em seguida em ``Perfil``. Dentro do seu perfil, existe um outro menu e uma das suas opções é ``Chaves SSH``, clique nela. Nesta página você pode gerenciar suas chaves SSH, então clique em **Adicionar Chave SSH**. Utilize o comando abaixo no terminal para obter sua chave SSH:: | |
| 25 | + | |
| 26 | + $ cat ~/.ssh/id_rsa.pub | |
| 27 | + ssh-rsa AAARB3NzaC1yc2EAAAADAQEVAAABAQCops6nAMYWRR/ | |
| 28 | + w9fDZe6LIVh5y9YwW9c10F0DCUkvEYp8E3gtmKOIz5vQewqAtqUnHmFWcIzEPhqU/Pi2UCnPfFUz+MbBZSEmSbe9mJa/ | |
| 29 | + aVpR5uBfEscVPH+mN0bdsqDUHhSTboSe64D+MCbflKhVyjwL/wZuXdzmFtJ4Jv8D7aLm5bNQRfw0oCE7cWYc3O9PULSS9005nO91Tk4 | |
| 30 | + w5gaA9B4i3GNRnbhaUgjis6pD9ln9dY2LmCs1mLRkZg09ocMdzq3eohhfpPTykPE+I6WDAyYFPyIJDT+AQQQ1qvFnmgYg6HpgWpXBv2 | |
| 31 | + w8fWcPu5nc8pmKRwmzO2LSKvdfWIXgd nome-do-usuario@hostname | |
| 32 | + | |
| 33 | +Copie o output do comando ``cat ~/.ssh/id_rsa.pub``, digite um título para a chave no campo ``Titulo``, cole a chave no campo ``Chave`` e clique em **Adicionar Chave**. | |
| 34 | + | |
| 35 | +Pronto! Sua chave foi adicionada e vinculada à sua conta no Portal SPB. | |
| 36 | + | |
| 37 | +Copiar Chave SSH | |
| 38 | +---------------- | |
| 39 | +Para evitar o trabalho de ter que digitar a senha dos servidores toda vez que uma conexão SSH for feita, podemos apenas copiar a chave SSH para o servidor e, assim, o servidor já reconhece a sua chave e não solicita a senha. | |
| 40 | + | |
| 41 | +Os comandos que podem ser utilizados para realizar a cópia da chave são:: | |
| 42 | + | |
| 43 | + $ ssh-copy-id usuario@ip-hostname | |
| 44 | + $ ssh-copy-id ip-hostname | |
| 45 | + | |
| 46 | +Onde: | |
| 47 | + | |
| 48 | +* ``usuario``: é o usuário que você deseja usar para entrar na máquina destino. Caso esse parametro não seja passado, o próprio comando, automaticamente, utiliza o usuário logado na máquina no momento em que foi executado como parâmetro. | |
| 49 | +* ``ip-hostname``: é o ip ou hostname da máquina destino. | |
| 50 | + | |
| 51 | +Ao executar o comando, será solicitada a senha do usuário fornecido. Uma vez informada, as próximas conexões via SSH, utilizando esse usuário, não precisarão ser autenticadas. | |
| 52 | + | |
| 53 | +No contexto do SPB, é necessário que a chave da estação de trabalho seja copiada para **todas** as máquinas do ambiente @@SPB_ENV@@, ou seja, o comando acima deverá ser executado para cada ip listado em ``config/@@SPB_ENV@@/ips.yaml``:: | |
| 54 | + | |
| 55 | + @@config(ips.yaml)@@ | |
| 56 | + | |
| 57 | +Caso os ambientes já tenham sido convergidos anteriormente, não será possível executar o comando ``ssh-copy-id``, pois as portas SSH estarão fechadas pelo firewall. Nesse caso, a chave deverá ser copiada manualmente:: | |
| 58 | + | |
| 59 | + $ cat ~/.ssh/id_rsa.pub | |
| 60 | + ssh-rsa AAARB3NzaC1yc2EAAAADAQEVAAABAQCops6nAMYWRR/ | |
| 61 | + w9fDZe6LIVh5y9YwW9c10F0DCUkvEYp8E3gtmKOIz5vQewqAtqUnHmFWcIzEPhqU/Pi2UCnPfFUz+MbBZSEmSbe9mJa/ | |
| 62 | + aVpR5uBfEscVPH+mN0bdsqDUHhSTboSe64D+MCbflKhVyjwL/wZuXdzmFtJ4Jv8D7aLm5bNQRfw0oCE7cWYc3O9PULSS9005nO91Tk4 | |
| 63 | + w5gaA9B4i3GNRnbhaUgjis6pD9ln9dY2LmCs1mLRkZg09ocMdzq3eohhfpPTykPE+I6WDAyYFPyIJDT+AQQQ1qvFnmgYg6HpgWpXBv2 | |
| 64 | + w8fWcPu5nc8pmKRwmzO2LSKvdfWIXgd nome-do-usuario@hostname | |
| 65 | + | |
| 66 | +O output do comando acima é a sua chave pública, ela deverá ser copiada e colada, manualmente, em ``~/.ssh/authorized_keys`` do usuário desejado. Esse procedimento deve ser repetido em todas as máquinas listadas em ``config/@@SPB_ENV@@/ips.yaml``. | |
| 0 | 67 | \ No newline at end of file | ... | ... |
docs/arquitetura.rst.in
| ... | ... | @@ -50,7 +50,7 @@ originada da integration. Conexões na porta 22 da máquina reverseproxy são |
| 50 | 50 | redirecionadas para integration. As máquinas email, social e database aceitam |
| 51 | 51 | conexão SSH vindas da integration na porta 22 e a reverseproxy em uma porta |
| 52 | 52 | alternativa, especificada no arquivo de configuração do ambiente, |
| 53 | -config/$SPB_ENV/config.yaml pelo valor passado a 'alt_ssh_port'. | |
| 53 | +config/$SPB_ENV/config.yaml pelo valor passado a 'alt_ssh_port'. | |
| 54 | 54 | |
| 55 | 55 | Por exemplo, para se conectar na máquina email é necessário estabelecer conexão |
| 56 | 56 | SSH na porta 22 da reverseproxy, esta conexão será redirecionada para a máquina |
| ... | ... | @@ -77,7 +77,7 @@ ser obtido a partir do comando:: |
| 77 | 77 | $ git clone git@portal.softwarepublico.gov.br:softwarepublico/softwarepublico.git |
| 78 | 78 | |
| 79 | 79 | Note que para tal, é necessário possuir uma conta no Portal do SPB com chaves |
| 80 | -SSH configuradas. | |
| 80 | +SSH configuradas. Para mais informações sobre essas configurações, veja a :doc:`/apoio`. | |
| 81 | 81 | |
| 82 | 82 | Este repositório contém scripts que realizam todos os passos necessários |
| 83 | 83 | para a instalação, configuração e manutenção do ambiente. Isto é feito | ... | ... |
docs/implantacao.rst.in
| ... | ... | @@ -36,7 +36,7 @@ Obtendo o repositório de configuração |
| 36 | 36 | ------------------------------------- |
| 37 | 37 | |
| 38 | 38 | Para iniciar, é necessário uma conta e usuário no SPB, com uma chave SSH |
| 39 | -configurada. | |
| 39 | +configurada. Mais informações em :doc:`/apoio`. | |
| 40 | 40 | |
| 41 | 41 | Para obter o repositório de configuração, é necessário clonar o |
| 42 | 42 | repositório com ``git``:: |
| ... | ... | @@ -49,7 +49,6 @@ onde foi clonado o repositório:: |
| 49 | 49 | |
| 50 | 50 | $ cd softwarepublico/ |
| 51 | 51 | |
| 52 | - | |
| 53 | 52 | Preparação dos servidores |
| 54 | 53 | ------------------------- |
| 55 | 54 | |
| ... | ... | @@ -64,6 +63,7 @@ Preparação dos servidores |
| 64 | 63 | * ter acesso SSH configurado via chave SSH para evitar digitar senha, |
| 65 | 64 | a partir da estação de trabalho utilizada. Ou seja, a chave pública |
| 66 | 65 | SSH **da estação de trabalho** deve ser copiada para cada servidor. |
| 66 | + Para mais informações, veja a :doc:`/apoio`. | |
| 67 | 67 | |
| 68 | 68 | * O ``sudo`` não deve estar configurado com a opção ``requiretty``. Se |
| 69 | 69 | houver uma linha como a seguinte em ``/etc/sudoers``, ela deve ser |
| ... | ... | @@ -129,6 +129,8 @@ DNS: |
| 129 | 129 | |
| 130 | 130 | .. include:: dns.rst |
| 131 | 131 | |
| 132 | +.. _verificandoambiente: | |
| 133 | + | |
| 132 | 134 | Verificando o ambiente |
| 133 | 135 | ---------------------- |
| 134 | 136 | |
| ... | ... | @@ -159,7 +161,7 @@ ser omitido se você tiver configurado o *default* em ``local.rake``. |
| 159 | 161 | |
| 160 | 162 | Para testar a conectividade às máquinas, devemos antes realizar a |
| 161 | 163 | preconfiguração das máquinas, caso o sistema nunca tenha sido instalado. |
| 162 | -Note que se este passo só deve ser realizado uma única vez:: | |
| 164 | +Note que se este passo deve ser realizado uma **única vez**:: | |
| 163 | 165 | |
| 164 | 166 | $ rake preconfig SPB_ENV=@@SPB_ENV@@ |
| 165 | 167 | |
| ... | ... | @@ -186,9 +188,10 @@ parecido com o seguinte:: |
| 186 | 188 | reverseproxy: Qui Mai 14 18:59:28 BRT 2015 |
| 187 | 189 | |
| 188 | 190 | Se o resultado se parece com o exemplo acima, e você não precisou digitar a sua |
| 189 | -senha nehuma vez, significa que 1) você conseguiu conectar em todas as máquinas | |
| 190 | -e 2) o sudo sem senha está configurado corretamente. Está tudo certo para | |
| 191 | -começar! | |
| 191 | +senha nehuma vez, significa que: | |
| 192 | + | |
| 193 | +1) você conseguiu conectar em todas as máquinas. | |
| 194 | +2) o sudo sem senha está configurado corretamente. Está tudo certo para começar! | |
| 192 | 195 | |
| 193 | 196 | Nota sobre certificado SSL |
| 194 | 197 | -------------------------- |
| ... | ... | @@ -227,7 +230,7 @@ Primeira instalação |
| 227 | 230 | |
| 228 | 231 | Uma vez configurados os parâmetros em ``config/@@SPB_ENV@@/``, podemos |
| 229 | 232 | dar início à instalação. O primeiro passo é uma preconfiguração que |
| 230 | -precisamos fazer, caso não tenha sido feito em "Verificando o Ambiente":: | |
| 233 | +precisamos fazer, caso não tenha sido feito em :ref:`verificandoambiente`:: | |
| 231 | 234 | |
| 232 | 235 | $ rake preconfig SPB_ENV=@@SPB_ENV@@ |
| 233 | 236 | ... | ... |
docs/index.rst.in