Mirrored_Repos/psu
1
0
Fork 0
mirror of https://gitlab.com/psuapp/psu.git synced 2024-08-30 18:12:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some examples for main commands in docs.

Browse Source
This commit is contained in:
Tortue Torche 2019-08-29 10:53:29 +02:00
parent 793382dcd0
commit 14eeee863d
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
docs/README.md
View File

@ -149,6 +149,12 @@ Deploy/update the given stack.
#### Usage:
`psu deploy [options]`
#### Examples:
```bash
psu deploy --user admin --password password --url https://portainer.local --name mystack --compose-file /path/to/docker-compose.yml --env-file /path/to/env_vars_file
```
#### Required options:
| Flag | Option | Description |
| ---------- | -------------------------------- | ----------- |
@ -184,6 +190,12 @@ Remove/undeploy the given stack.
#### Usage:
`psu rm [options]`
#### Examples:
```bash
psu rm --user admin --password password --url https://portainer.local --name mystack
```
#### Required options:
| Flag | Option | Description |
| ---------- | -------------------------------- | ----------- |
@ -294,9 +306,34 @@ Check if the stack is running/deployed correctly
If your stack has some services who acts as [jobs](#job), see the [`--detect-job`](#detect-job-option) option for more details.
This action is very useful in CI/CD pipelines, it's equivalent to the [`kubectl rollout status`](https://kubernetes.io/docs/reference/generated/kubectl/kubectl-commands#-em-status-em-) command of Kubernetes.
#### Usage:
`psu status [options]`
#### Examples:
```bash
psu status --user admin --password password --url https://portainer.local --name mystack
```
This command outputs nothing if the stack is correctly running or deployed.
It also has an exit code (or exit status).
The exit code value return based on a command or program will successfully execute _(return 0)_ or not _(return 1 or higher)_.
```bash
psu status --user admin --password password --url https://portainer.local --name mystack --timeout 20
if [ $? -eq 0 ]; then
echo "[OK] This stack is running/deployed correctly"
else
echo "[ERROR] This stack isn't running/deployed correctly!"
fi
```
For more informations about exit code, you can read this [article](https://tecadmin.net/tutorial/bash-scripting/bash-exit-codes/) and this [Wikipedia page](https://en.wikipedia.org/wiki/Exit_status)
#### Required options:
| Flag | Option | Description |
| ---------- | -------------------------------- | ----------- |