@gkoplus/confirmafacil-cli

    1.1.0 • Public • Published

    Confirma Fácil CLI

    Ferramenta de command line interface para o Confirma Fácil. Seu objetivo é centralizar todos os scripts de automatização de tarefas e deploy.

    Instalação

    Requisitos

    • Linux
    • node 8.1 ou superior.

    $ npm install @gkoplus/confirmafacil-cli -g

    Importante:

    1. A pasta ~/app/scripts/ deve existir.
    2. O local do projeto eclipse deve ser ~/app/eclipse-workspace/confirmafacil-eclipse/

    Ajuda

    A execução do comando confirmafacil sem nenhum parâmetro resulta na tela de ajuda.

    $ confirmafacil

    Quando não ficar claro o que um comando faz, basta digitar o parâmetro --help para obter auxílio.

    $ confirmafacil backend-context --help

    Usage: backend-context [options]
    generate context for a client.
    
    Options:
      -e --env <type>   Environment type.
      -d, --dir <type>  Directory to deploy context.
      -h, --help        output usage information
    

    Frontend

    Funcionalidades: ##### 1. Instalar dependencias do projeto

    $ confirmafacil frontend-install

    ##### 2. Rodar a aplicação.

    Aceita os seguintes parâmetros:

    • --env: Qual o ambiente em questão.

    $ confirmafacil frontend-serve -e homologation

    ##### 3. Realizar o build da aplicação.

    Aceita os seguintes parâmetros:

    • --env: Qual o ambiente em questão.

    $ confirmafacil frontend-build -e homologation

    ##### 4. Realizar o deploy da aplicação.

    Aceita os seguintes parâmetros:

    • --env: Qual o ambiente em questão.
    • --key: Local da chave privada da amazon.

    $ confirmafacil frontend-deploy --env production -k $AWS_KEY

    Backend

    Funcionalidades: ##### 1. Gerar o context de acordo com o ambiente.

    Aceita os seguintes parâmetros:

    • --env: Qual o ambiente em questão.
    • --dir: Qual o diretório de saída do context.

    $ confirmafacil backend-context -e production -dir $PWD

    ##### 2. Realizar o build da aplicação.

    Aceita os seguintes parâmetros:

    • --env: Qual o ambiente em questão.
    • --project: Nome do projeto a ser buildado.

    $ confirmafacil backend-build -e homologation -proj gko-ms-pcf-audit-remote

    ##### 3. Gera ambiente SFTP para um cliente.

    Aceita os seguintes parâmetros:

    • --key: Local da chave privada da amazon.
    • --client: Qual o cliente em questão.

    $ confirmafacil backend-sftp -k $AWS_KEY --client baxter

    $PWD significa o caminho atual aonde o script foi chamado

    ##### 4. Realizar o deploy da aplicação.

    Aceita os seguintes parâmetros:

    • --key: Local da chave privada da amazon.
    • --env: Qual o ambiente em questão.
    • --project: Qual o projeto em questão.

    $ confirmafacil backend-deploy -k $AWS_KEY --env homologation --project audit

    $PWD significa o caminho atual aonde o script foi chamado

    Exemplos

    ##### Definição de variável de ambiente da chave AWS (.pem) Necessário para a maioria dos casos de uso do CLI. Cria uma variável de ambiente que aponta para a chave .pem da AWS.

    export AWS_KEY=/home/usuario/app/servers/gko-virginia.pem
    echo $AWS_KEY
    

    --

    ##### Geração de ambiente SFTP para o cliente 'teste' Loga na máquina de SFTP e executa o script de geração de ambiente SFTP passando como cliente o argumento 'teste'.

    confirmafacil backend-sftp -k $AWS_KEY --client teste
    

    --

    ##### Geração de context via mongoDB Acessa a collection devops do mongoDB e busca todos os clientes de um context, de acordo com o ambiente especificado. Gera um context.xml com os dados em questão e copia para a pasta META-INF de cada projeto remote.

    cf backend-context -env homologation --dir $PWD
    

    --

    ##### Geração do war de um projeto Realiza o Build do projeto especificado, resultando em um .war na pasta ~/app/wars. Importante esta pasta estar criada antes de execuar este comando.

    cf backend-build -p gko-ms-pcf-audit-remote
    ou
    confirmafacil backend-build --project audit
    

    O projeto pode ser:

    • audit ou gko-ms-pcf-audit-remote
    • eventos ou gko-ms-pcf-eventos-remote
    • filtros ou gko-ms-pcf-filtros-remote
    • loader ou gko-ms-pcf-loader-remote
    • remote ou gko-ms-pcf-remote

    --

    ##### Deploy do backend para homologação Realizar o deploy do war do projeto remote localizado na pasta ~/app/wars para o servidor remoto de homologação do backend.

    confirmafacil backend-deploy -k $AWS_KEY --env homologation --project remote
    

    O projeto pode ser:

    • audit ou gko-ms-pcf-audit-remote
    • eventos ou gko-ms-pcf-eventos-remote
    • filtros ou gko-ms-pcf-filtros-remote
    • loader ou gko-ms-pcf-loader-remote
    • remote ou gko-ms-pcf-remote

    --

    Install

    npm i @gkoplus/confirmafacil-cli

    DownloadsWeekly Downloads

    19

    Version

    1.1.0

    License

    ISC

    Unpacked Size

    151 kB

    Total Files

    12

    Last publish

    Collaborators

    • filipeoliveira