From 165f481e1bffde1591b1e567faa6c2a5631fd889 Mon Sep 17 00:00:00 2001 From: Paulo Tada Date: Tue, 7 Jun 2016 15:22:57 -0300 Subject: [PATCH] Update documentation with Mezuro notes --- docs/arquitetura.rst.in | 9 ++------- docs/implantacao.rst.in | 4 ---- docs/index.rst.in | 1 + docs/introducao.rst.in | 11 ++++++++++- docs/mezuro.rst.in | 25 +++++++++++++++++++++++++ 5 files changed, 38 insertions(+), 12 deletions(-) create mode 100644 docs/mezuro.rst.in diff --git a/docs/arquitetura.rst.in b/docs/arquitetura.rst.in index fbf78a2..3f79dc3 100644 --- a/docs/arquitetura.rst.in +++ b/docs/arquitetura.rst.in @@ -14,7 +14,7 @@ máquina, onde são distribuidas para os serviços solicitados. Todos os bancos de dados relevantes estão concentrados em uma única máquina e todos os emails disparados pelo sistema partem de um mesmo *relay*. -O ambiente é composto por 7 máquinas com funções distintas: +O ambiente é composto por 6 máquinas com funções distintas: * **Reverseproxy** @@ -47,11 +47,6 @@ O ambiente é composto por 7 máquinas com funções distintas: * Servidor de banco de dados PostgreSQL; -* **Mezuro** - - * Servidor de análise de código Mezuro; - - * **Monitor** * Monitoramento de informações dos outros serviços; @@ -67,7 +62,7 @@ Conexões na porta 22 da máquina reverseproxy são redirecionadas para integrat Todas as máquinas aceitam conexões **ssh** originadas apenas da máquina integration, ou seja, não é possível realizar conexões **ssh** nas demais máquinas se a conexão não for originada da integration. -As máquinas **email**, **social**, **database** e **mezuro** aceitam conexão **ssh** +As máquinas **email**, **social** e **database** aceitam conexão **ssh** vindas da integration na porta 22 e a reverseproxy em uma porta alternativa, especificada no arquivo de configuração do ambiente, `config/$SPB_ENV/config.yaml` pelo valor `alt_ssh_port`. diff --git a/docs/implantacao.rst.in b/docs/implantacao.rst.in index 58d5d6d..e93062c 100644 --- a/docs/implantacao.rst.in +++ b/docs/implantacao.rst.in @@ -175,7 +175,6 @@ O comando acima deve dar o seguinte resultado:: email ssh social ssh database ssh - mezuro ssh monitor ssh reverseproxy ssh @@ -217,8 +216,6 @@ parecido com o seguinte:: social: Qui Mai 14 18:59:24 BRT 2015 database: $ sudo date database: Qui Mai 14 18:59:27 BRT 2015 - mezuro: $ sudo date - mezuro: Qui Mai 14 18:59:24 BRT 2015 monitor: $ sudo date monitor: Qui Mai 14 18:59:25 BRT 2015 reverseproxy: $ sudo date @@ -337,7 +334,6 @@ atualização em ambientes especificos, por meio dos comandos abaixo: * Atualizar a integration: rake converge:social SPB_ENV=homologa * Atualizar a email: rake converge:email SPB_ENV=homologa * Atualizar a database: rake converge:database SPB_ENV=homolga - * Atualizar a mezuro: rake converge:mezuro SPB_ENV=homolga * Atualizar a monitor: rake converge:monitor SPB_ENV=homolga * Atualizar a reverseproxy: rake converge:reverseproxy SPB_ENV=homologa diff --git a/docs/index.rst.in b/docs/index.rst.in index e8bef57..cf83b96 100644 --- a/docs/index.rst.in +++ b/docs/index.rst.in @@ -14,3 +14,4 @@ Software Público Brasileiro: Manual de Operação (@@SPB_ENV@@) apoio busca_global pacotes + mezuro diff --git a/docs/introducao.rst.in b/docs/introducao.rst.in index 58238f6..7c5fea9 100644 --- a/docs/introducao.rst.in +++ b/docs/introducao.rst.in @@ -48,8 +48,17 @@ consistente. .. _`GNU Mailman`: http://www.gnu.org/software/mailman/ +* O Mezuro_ é uma plataforma web livre para avaliação colaborativa de código + fonte. Aqui você pode avaliar seu código fonte com os SCMs mais populares + (como Git e SVN), apenas fornecendo sua URL. Por enquanto, você pode + avaliar códigos em C, C++, Java, Ruby, Python e PHP mas nós pretendemos + dar suporte a mais linguagens no futuro. + **Nota**: nas configurações atuais do SPB, o Mezuro não está incluso. Leia + :doc:`/mezuro`. + +.. _Mezuro: http://mezuro.org/ + O restando deste manual descreve a arquitetura do SPB bem como os procedimentos necessários para sua implantação, manutenção, backup e restauração e gestão de firewall. - diff --git a/docs/mezuro.rst.in b/docs/mezuro.rst.in new file mode 100644 index 0000000..f620525 --- /dev/null +++ b/docs/mezuro.rst.in @@ -0,0 +1,25 @@ +Mezuro +========== + +O Mezuro no ambiente do SPB foi adicionado em suas últimas release. +A integração e funcionamento foi validado pela equipe de desenvolvimento. +Entretanto não foi colocado em produção. Há uma versão do SPB com a adição +do Mezuro em uma branch separada `mezuro_spb`_. O converge a partir desta branch +e com a devida máquina disponível no ambiente, é possível subir a instancia do +SPB com a integração do Mezuro. + +.. _`mezuro_spb`: + +Disponibilização das Máquinas +--------------------------------- + +A configuração da arquitetura do SPB muda com a adição do Mezuro. É necessário +uma máquina dedicada para o serviço. Os três componentes principais do Mezuro +são: kalibro processor, kalibro configurations e prezento. Ambos os kalibros +são implantados na máquina `mezuro` e são responsáveis pela coleta das métricas +de códigos disponíveis nos projetos. O prezento é implantado na máquina +integration e é responsável pela interface gráfica de interação com o usuário. + +A comunicação entre os componentes é feito por webserver, ou seja, os kalibros +disponibilizam as métricas por serviços TCP port 80 para o componente prezento +realizar a apresentação dos dados. -- libgit2 0.21.2