Skip to main content

A simple package to help deploy docker swarm stack.

Project description

pencilctl_lite

Repositório contendo o script pencilctl_lite, responsável por fazer deploy de projetos que utilizem uma estrutura de docker stack, mas que não serão executados no cluster principal da Pencil.

Quick Start

Para utilizar este script, existem algumas pré-requisitos:

  1. Um cluster swarm tem que existir na máquina em que ele será executado;
  2. O projeto que será alvo do deploy deve possuir uma pasta docker/production, contendo os arquivos Dockerfile (caso as stacks exigam imagens customizadas), e os arquivos de stack, que serão utilizados para realizar o deploy do projeto.
  3. O diretório docker/production, deve ter a seguinte estrutura:

estrutura

  • xpto: Diretório que centraliza todos os arquivos de uma stack. Um projeto pode ter mais de uma stack, por exemplo, uma stack para fazer deploy do servidor, e outra para um http proxy ou um redis. O pencilctl _lite permite fazer deploy de multiplas stacks. Diretório obrigatório;
  • xpto/stacks: Diretório contendo os arquivos de stack do projeto. Diretório obrigatório;
  • xpto/nginx_confs: Diretório contendo arquivos de configuração do nginx. Diretório optativo;
  • xpto/server: Diretório contendo o Dockerfile do serviço chamado server, declarado no arquivo de stack. Diretório optativo;
  • xpto/db: Diretório contendo o Dockerfile do serviço chamado db, declarado no arquivo de stack. Diretório optativo;
  • xpto/nginx: Diretório contendo o Dockerfile do serviço chamado nginx, declarado no arquivo de stack Diretório optativo;

Essa estrutura deve existir no repositório do projeto que será alvo do deploy. O papel do script é apenas acessar esse diretório e automatizar os processos de build e deploy. Essa estrutura também padroniza o nome/tag das imagens que são construidas via ./pencilctl_lite build.

Supondo a stack xpto, o comando para buildar a imagem do server seria:

./pencilctl_lite.sh build --docker_path=/home/user/xpto/docker --service=server --stack=xpto

Este comando geraria a imagem 127.0.0.1:5000/xpto_server:stable-prod.

O comando para fazer deploy da stack:

./pencilctl_lite.sh deploy --docker_path=/home/user/xpto/docker --stack=xpto

Este comando geraria a stack xpto_prod.

Para saber quais comandos o script possui e quais argumentos ele recebe, basta executar:

./pencilctl_lite.sh help

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pencilctl-lite-0.0.5.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pencilctl_lite-0.0.5-py3-none-any.whl (3.5 kB view details)

Uploaded Python 3

File details

Details for the file pencilctl-lite-0.0.5.tar.gz.

File metadata

  • Download URL: pencilctl-lite-0.0.5.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.11.0 Linux/6.0.10-300.fc37.x86_64

File hashes

Hashes for pencilctl-lite-0.0.5.tar.gz
Algorithm Hash digest
SHA256 3daba8e2742594463b70d4f07c623d40eb511b7adb4c0e00e2c22e0025ba2c4f
MD5 40c8330cf1eb685a2a67fca1eee4d8db
BLAKE2b-256 4d9f84c75eba754f09e283d47192f3d64e264604059695cde56c099d52dae99a

See more details on using hashes here.

File details

Details for the file pencilctl_lite-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: pencilctl_lite-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 3.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.11.0 Linux/6.0.10-300.fc37.x86_64

File hashes

Hashes for pencilctl_lite-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 5baee031ff88e333b544b0659e277165fb4cf253e6691f5aa0ca38ad04f9cc0e
MD5 698de2754cc47bf337386733c8174399
BLAKE2b-256 8fcabeff3586f21ceb8f03de489dcaee9d9911c4f9350f4f5019d74da906d120

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page