mirror of
https://gitlab.com/psuapp/psu.git
synced 2024-08-30 18:12:34 +00:00
87 lines
3.6 KiB
Markdown
87 lines
3.6 KiB
Markdown
# Portainer Stack Utils
|
|
|
|
[](https://hub.docker.com/r/greenled/portainer-stack-utils/)
|
|
[](https://hub.docker.com/r/greenled/portainer-stack-utils/)
|
|
[](http://microbadger.com/images/greenled/portainer-stack-utils "Image size")
|
|
|
|
Bash script to deploy/undeploy stacks in a [Portainer](https://portainer.io/) instance from a [docker-compose](https://docs.docker.com/compose) [yaml file](https://docs.docker.com/compose/compose-file). Based on previous work by [@vladbabii](https://github.com/vladbabii) on [docker-how-to/portainer-bash-scripts](https://github.com/docker-how-to/portainer-bash-scripts).
|
|
|
|
## Supported Portainer API
|
|
|
|
Script was created for the latest Portainer API, which at the time of writing is [1.9.2](https://app.swaggerhub.com/apis/deviantony/Portainer/1.19.2).
|
|
|
|
## Requirements
|
|
|
|
- [bash](https://www.gnu.org/software/bash/)
|
|
- [httpie](https://httpie.org/)
|
|
- [jq](https://stedolan.github.io/jq/)
|
|
|
|
## How to use
|
|
|
|
The provided `psu` script allows to deploy/update/undeploy portainer stacks. Settings can be passed through envvars and/or flags. Both envars and flags can be mixed but flags will always overwrite envvar values. When deploying a stack, if it doesn't exist a new one is created, otherwise it's updated.
|
|
|
|
### With envvars
|
|
|
|
This is particularly useful for CI/CD pipelines.
|
|
|
|
- `ACTION` (string, required): deploy/undeploy
|
|
- `PORTAINER_USER` (string, required): Username
|
|
- `PORTAINER_PASSWORD` (string, required): Password
|
|
- `PORTAINER_URL` (string, required): URL to Portainer
|
|
- `PORTAINER_STACK_NAME` (string, required): Stack name
|
|
- `DOCKER_COMPOSE_FILE` (string, required if action=deploy): Path to doker-compose file
|
|
- `PORTAINER_PRUNE` ("true" or "false", optional): Whether to prune unused containers or not. Defaults to `"false"`.
|
|
- `PORTAINER_ENDPOINT` (int, optional): Which endpoint to use. Defaults to `1`.
|
|
- `HTTPIE_VERIFY_SSL` ("yes" or "no", optional): Whether to verify SSL certificate or not. Defaults to `"yes"`.
|
|
|
|
#### Examples
|
|
|
|
```bash
|
|
export ACTION="deploy"
|
|
export PORTAINER_USER="admin"
|
|
export PORTAINER_PASSWORD="password"
|
|
export PORTAINER_URL="http://portainer.local"
|
|
export PORTAINER_STACK_NAME="mystack"
|
|
export DOCKER_COMPOSE_FILE="/path/to/docker-compose.yml"
|
|
|
|
./psu
|
|
```
|
|
|
|
```bash
|
|
export ACTION="undeploy"
|
|
export PORTAINER_USER="admin"
|
|
export PORTAINER_PASSWORD="password"
|
|
export PORTAINER_URL="http://portainer.local"
|
|
export PORTAINER_STACK_NAME="mystack"
|
|
|
|
./psu
|
|
```
|
|
|
|
### With flags
|
|
|
|
This is more suitable for standalone script usage.
|
|
|
|
- `-a` (string, required): deploy/undeploy
|
|
- `-u` (string, required): Username
|
|
- `-p` (string, required): Password
|
|
- `-l` (string, required): URL to Portainer
|
|
- `-n` (string, required): Stack name
|
|
- `-c` (string, required if action=deploy): Path to doker-compose file
|
|
- `-r` ("true" or "false", optional): Whether to prune unused containers or not. Defaults to `"false"`.
|
|
- `-e` (int, optional): Which endpoint to use. Defaults to `1`.
|
|
- `-s` ("yes" or "no", optional): Whether to verify SSL certificate or not. Defaults to `"yes"`.
|
|
|
|
#### Examples
|
|
|
|
```bash
|
|
./psu -a deploy -u admin -p password -l http://portainer.local -n mystack -c /path/to/docker-compose.yml
|
|
```
|
|
|
|
```bash
|
|
./psu -a undeploy -u admin -p password -l http://portainer.local -n mystack
|
|
```
|
|
|
|
## License
|
|
|
|
Source code contained by this project is licensed under the [GNU General Public License version 3](https://www.gnu.org/licenses/gpl-3.0.en.html). See [LICENSE](LICENSE) file for reference.
|