SEI - KUBERNETES

Padronização de implantação de Sistema Eletrônico de Informações e Gestão de Documentos (SEI) em PaaS Kubernetes públicas e privadas.
Explore»

Reporte um Bug · Solicite uma feature

Table of contents

1. Sobre o projeto
   1. Tecnologias utilizadas
2. Começando
   1. Arquitetura
   2. Pré-requisitos
   3. Imagens
   4. Instalação
   5. Desisntalação
3. Roadmap
4. Contribuições
5. Licença
6. Contatos
   1. Marcelo Lima
   2. Igor Oliveira
   3. Carlos Lima
7. Reconhecimentos

Sobre o projeto

O Sistema Eletrônico de Informações (SEI), desenvolvido pelo Tribunal Regional Federal da 4ª Região (TRF4), é um sistema de gestão de processos e documentos arquivísticos eletrônicos, com interface amigável e práticas inovadoras de trabalho. Uma das suas principais características é a libertação do papel como suporte físico para documentos institucionais e o compartilhamento do conhecimento com atualização e comunicação de novos eventos em tempo real.

O projeto atual visa permitir a instalação de um ambiente completo do SEI em Kubernetes via Helm.

Tecnologias utilizadas

Para a implantação do projeto é necessário o uso do Helm e Git.

As tecnologias utilizadas no ambiente foram:

• Helm
• Git
• Mysql
• Apache
• Php
• Jod-converter
• Memcached
• Solr
• Docker
• Podman
• Alpine
• Centos

Começando

Nesta sessão iremos demostrar a arquitetura e o processo de instalação e desinstalação do SEI em Kubernetes.

Arquitetura

A arquitetura do projeto SEI Kubernetes é composta pelos seguintes containers:

• Banco de dados Mysql
• Serviço de conversão para pdf Jodconverter
• Serviço Web Apache+PHP+Memcached
• Serviço de indexação Solr

Pré-requisitos

O Helm deve ser instalado:

• Helm

   $ curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3
   $ chmod 700 get_helm.sh
   $ ./get_helm.sh

Imagens

• sei-jodconverter
• sei-solr
• sei-mysql
• sei-apache
• memcached

Instalação

1. Realize o clone do repositório localmente:

   git clone https://github.com/seikubernetes/projeto-sei.git

2. Crie um namespace em seu ambiente kubernetes:

   kubectl create namespace projeto-sei

3. Defina a variável de namespace name no arquivo de nome values.yaml conforme nome do namespace criado anteriormente.
4. Configure as variáveis do values.yaml correspondentes ao seu ambiente kubernetes.
5. Instale o Helm Chart do SEI para criar o ambiente completo baseado nas definições estabelecidadas:

   helm install projeto-sei ./projeto-sei/sei

Desinstalação

1. Realize o clone do repositório localmente:

   git clone https://github.com/seikubernetes/projeto-sei.git

2. Defina a variável de namespace name no arquivo de nome values.yaml conforme nome do namespace onde o sei está instalado.
3. Desinstale o Helm Chart do SEI para deletar todos os recursos criados no namespace definido.

   helm uninstall projeto-sei

4. Caso não lembre o nome do Helm do SEI instalado execute:

   helm list

5. *Caso não apareça o Helm criado e se o namespace tenha sido criado conforme recomendado, pode-se apagar o namespace e os recursos criados dentro dele irão ser apagados também:

   kubectl delete namespace projeto-sei

   *OBS: Não execute o passo 5 se tiver instalado em namespaces que tem outras aplicações junto, pois, ele irá remover tudo que há no namespace

Roadmap

Veja problemas abertos para obter uma lista de recursos propostos (e problemas conhecidos).

Contribuições

Constribuições são o que tornam a comunidade de código aberto um lugar incrível para aprender, inspirar e criar. Quaisquer contribuições são ** muito apreciadas**.

1. Realize Fork do projeto
2. Crie sua Feature Branch (git checkout -b feature/AmazingFeature)
3. Realize o Commit das suas mudanças (git commit -m 'Add some AmazingFeature')
4. Realize o Push para a Branch (git push origin feature/AmazingFeature)
5. Abra um Pull Request

Licença

Distributed under the GLP-3.0. See LICENSE for more information.

Contatos

Carlos

Igor

Marcelo