Skip to content

Script que sobe localmente o OpenSearch para uso com LLMs

Notifications You must be signed in to change notification settings

4linux/opensearch-start-local

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

Open Search Start Local

Este script automatiza o processo de criação de um ambiente com OpenSearch e OpenSearch Dashboards utilizando Docker e Docker Compose, com suporte para comunicação segura via SSL. O script também realiza a configuração de volumes, senhas e variáveis de ambiente necessárias para rodar o OpenSearch e o OpenSearch Dashboards de maneira simples e segura.

Funcionalidades

  1. Busca pela Última Versão Estável do OpenSearch: O script verifica a versão mais recente estável do OpenSearch disponível no GitHub.
  2. Geração Automática de Senhas Fortes: O script cria senhas seguras para o OpenSearch, o OpenSearch Dashboards e para as chaves SSL utilizadas na comunicação segura.
  3. Verificação de Requisitos: Antes de iniciar, o script verifica se o Docker e o Docker Compose estão instalados no sistema.
  4. Gerenciamento de Volumes: O script verifica a existência de volumes Docker para armazenar os dados e permite reutilizar volumes existentes ou criar novos volumes conforme necessário.
  5. Geração de Arquivos de Configuração:
    • .env: Arquivo de variáveis de ambiente, que contém as configurações do OpenSearch e do OpenSearch Dashboards.
    • docker-compose.yml: Arquivo de configuração do Docker Compose para orquestrar a execução dos containers.
  6. Execução do Docker Compose: O script inicializa os containers do OpenSearch e OpenSearch Dashboards, habilitando SSL para comunicação segura.
  7. Exibição de Senhas Geradas: Após a execução, o script exibe as senhas geradas para o usuário, garantindo que as informações de acesso estejam facilmente acessíveis.

Requisitos

Antes de executar o script, é necessário ter o Docker e o Docker Compose instalados na sua máquina. Você pode verificar se esses programas estão instalados com os seguintes comandos:

docker --version
docker-compose --version

Caso não tenha o Docker ou o Docker Compose instalado, siga a documentação oficial do Docker para instalar.

Como Usar

  1. Baixe ou copie o script para o seu servidor ou máquina local.

  2. Dê permissão de execução ao script:

    chmod +x script.sh
  3. Execute o script:

    ./script.sh

    O script pode ser executado com alguns parâmetros adicionais:

    • -v <versão>: Define a versão específica do OpenSearch que você deseja usar. Exemplo:

      ./script.sh -v 2.9.0
    • -opensearchonly: Caso você deseje instalar apenas o OpenSearch, sem o OpenSearch Dashboards, adicione essa opção:

      ./script.sh -opensearchonly

    Caso a versão não seja fornecida, o script irá automaticamente buscar a última versão estável do OpenSearch.

  4. Verifique as senhas geradas: Após a execução, o script exibirá as senhas geradas para o OpenSearch, o OpenSearch Dashboards e os keystores SSL.

  5. Acesse o OpenSearch:

    • O OpenSearch estará disponível na URL https://localhost:9200.
    • O OpenSearch Dashboards estará disponível na URL https://localhost:5601.

Estrutura do Script

  • Funções principais:
    • get_latest_stable_version(): Busca a última versão estável do OpenSearch no GitHub.
    • generate_random_password(): Gera senhas fortes para o OpenSearch, o OpenSearch Dashboards e os keystores SSL.
    • check_requirements(): Verifica se o Docker e o Docker Compose estão instalados.
    • check_volume(): Verifica se o volume Docker para o OpenSearch já existe e oferece a opção de reutilizá-lo ou recriá-lo.
    • create_env_file(): Cria o arquivo .env com as variáveis de ambiente.
    • create_docker_compose_file(): Cria o arquivo docker-compose.yml com a configuração necessária para rodar os containers.
    • run_docker_compose(): Executa o Docker Compose para subir os containers.
    • show_password(): Exibe as senhas geradas para o OpenSearch e o OpenSearch Dashboards.

Configurações

O script permite a personalização de várias configurações:

  • Versão do OpenSearch (opensearch_version): Define a versão do OpenSearch a ser utilizada. Se não for especificada, o script buscará a última versão estável.
  • Configurações de Memória (opensearch_heap_init, opensearch_heap_max): Define as configurações de memória para o heap do OpenSearch.
  • Senhas: O script gera automaticamente senhas para o OpenSearch, o OpenSearch Dashboards e os keystores SSL.
  • Portas:
    • opensearch_port: Porta para o OpenSearch (padrão: 443).
    • opensearch_dashboards_port: Porta para o OpenSearch Dashboards (padrão: 5601).

Licença

Este script é mantido pela 4Linux através de mim, Samuel Gonçalves, Gerente de Tecnologia.

About

Script que sobe localmente o OpenSearch para uso com LLMs

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages