psu/README.md
Juan Carlos Mejías Rodríguez c14b86dfa3
Add license section to readme
2018-11-21 15:33:32 -05:00

2.1 KiB

Portainer Stack Utils

Docker Automated build Docker Pulls Microbadger

Bash scripts to deploy/undeploy stacks in a Portainer instance from a docker-compose yaml file. Based on previous work by @vladbabii on docker-how-to/portainer-bash-scripts.

Requirements

How to use

Two scripts are included: deploy.sh and undeploy.sh. Both scripts use the following environment variables to connect to the portainer instance:

  • PORTAINER_USER (string): Username
  • PORTAINER_PASSWORD (string): Password
  • PORTAINER_URL (string): URL to Portainer
  • PORTAINER_PRUNE ("true" or "false"): Whether to prune unused containers or not. Defaults to "false".
  • PORTAINER_ENDPOINT (int): Which endpoint to use. Defaults to 1.
  • HTTPIE_VERIFY_SSL ("yes" or "no"): Whether to verify SSL certificate or not. Defaults to "yes".

deploy.sh

This script deploys a stack. The stack is created if it does not exist, otherwise it is updated. You must pass the stack name and the path to the docker-compose file as arguments:

./deploy.sh mystack docker-compose.yml

undeploy.sh

This script removes a stack. You must pass the stack name as argument:

./undeploy.sh mystack

License

Source code contained by this project is licensed under the GNU General Public License version 3. See LICENSE file for reference.