Backport psu changelog and doc from version 1.0.5

This commit is contained in:
Tortue Torche 2020-07-29 16:49:25 +02:00
parent 021114e474
commit 3e52f311bf
4 changed files with 14 additions and 11 deletions

View File

@ -5,12 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [Unreleased]
### Added
- Test <abbr title="Portainer Stack Utils">PSU</abbr> with Portainer [1.24.1](https://app.swaggerhub.com/apis/deviantony/Portainer/1.24.1) API
### Changed ### Changed
- Upgrade operating system of Docker based images, with [Alpine 3.12](https://hub.docker.com/_/alpine) and [Debian 10](https://hub.docker.com/_/debian) - Upgrade operating system of Docker based images, with [Alpine 3.12](https://hub.docker.com/_/alpine) and [Debian 10](https://hub.docker.com/_/debian)
## [1.0.5] - 2020-07-29
### Added
- Test <abbr title="Portainer Stack Utils">PSU</abbr> with Portainer [1.24.1](https://app.swaggerhub.com/apis/deviantony/Portainer/1.24.1) API
### Removed ### Removed
- Test <abbr title="Portainer Stack Utils">PSU</abbr> with Portainer [1.21.0](https://app.swaggerhub.com/apis/deviantony/Portainer/1.21.0) API - Test <abbr title="Portainer Stack Utils">PSU</abbr> with Portainer [1.21.0](https://app.swaggerhub.com/apis/deviantony/Portainer/1.21.0) API
@ -83,7 +84,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Debug mode - Debug mode
- Strict mode - Strict mode
[Unreleased]: https://gitlab.com/psuapp/psu/compare/v1.0.4...1-0-stable [Unreleased]: https://gitlab.com/psuapp/psu/compare/v1.0.5...1-0-stable
[1.0.5]: https://gitlab.com/psuapp/psu/-/tags/v1.0.5
[1.0.4]: https://gitlab.com/psuapp/psu/-/tags/v1.0.4 [1.0.4]: https://gitlab.com/psuapp/psu/-/tags/v1.0.4
[1.0.3]: https://gitlab.com/psuapp/psu/-/tags/v1.0.3 [1.0.3]: https://gitlab.com/psuapp/psu/-/tags/v1.0.3
[1.0.2]: https://gitlab.com/psuapp/psu/-/tags/v1.0.2 [1.0.2]: https://gitlab.com/psuapp/psu/-/tags/v1.0.2

View File

@ -66,7 +66,8 @@ For detailed instructions, see [How to use](#how-to-use) section.
Published Docker images are [tagged](https://hub.docker.com/r/psuapp/psu/tags) matching [GitLab tags](https://gitlab.com/psuapp/psu/-/tags): Published Docker images are [tagged](https://hub.docker.com/r/psuapp/psu/tags) matching [GitLab tags](https://gitlab.com/psuapp/psu/-/tags):
<!-- - `dev` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) --> <!-- - `dev` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) -->
- `1`, `1.0`, `1.0.4` -> [`v1.0.4`](https://gitlab.com/psuapp/psu/-/tags/v1.0.4) - `1`, `1.0`, `1.0.5` -> [`v1.0.5`](https://gitlab.com/psuapp/psu/-/tags/v1.0.5)
- `1.0.4` -> [`v1.0.4`](https://gitlab.com/psuapp/psu/-/tags/v1.0.4)
- `1.0.3` -> [`v1.0.3`](https://gitlab.com/psuapp/psu/-/tags/v1.0.3) - `1.0.3` -> [`v1.0.3`](https://gitlab.com/psuapp/psu/-/tags/v1.0.3)
- `1.0.2` -> [`v1.0.2`](https://gitlab.com/psuapp/psu/-/tags/v1.0.2) - `1.0.2` -> [`v1.0.2`](https://gitlab.com/psuapp/psu/-/tags/v1.0.2)
- `1.0.1` -> [`v1.0.1`](https://gitlab.com/psuapp/psu/-/tags/v1.0.1) - `1.0.1` -> [`v1.0.1`](https://gitlab.com/psuapp/psu/-/tags/v1.0.1)
@ -80,13 +81,13 @@ Published Docker images are [tagged](https://hub.docker.com/r/psuapp/psu/tags) m
The `core` variant doesn't include `docker-compose`, so it's a bit smaller. The `core` variant doesn't include `docker-compose`, so it's a bit smaller.
But you can't lint Docker compose/stack file before deploying a stack. But you can't lint Docker compose/stack file before deploying a stack.
<!-- - `dev-core` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) --> <!-- - `dev-core` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) -->
- `1-core`, `1.0-core`, `1.0.4-core`, `core` -> [`v1.0.4`](https://gitlab.com/psuapp/psu/-/tags/v1.0.4) - `1-core`, `1.0-core`, `1.0.5-core`, `core` -> [`v1.0.5`](https://gitlab.com/psuapp/psu/-/tags/v1.0.5)
The `debian` and `debian-core` variants use [Debian](https://www.debian.org) instead of [Alpine](https://alpinelinux.org/) as base image for `psu`. The `debian` and `debian-core` variants use [Debian](https://www.debian.org) instead of [Alpine](https://alpinelinux.org/) as base image for `psu`.
<!-- - `dev-debian` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) <!-- - `dev-debian` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev)
- `dev-debian-core` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) --> - `dev-debian-core` -> [`dev`](https://gitlab.com/psuapp/psu/-/tags/dev) -->
- `1-debian`, `1.0-debian`, `1.0.4-debian`, `debian` -> [`v1.0.4`](https://gitlab.com/psuapp/psu/-/tags/v1.0.4) - `1-debian`, `1.0-debian`, `1.0.5-debian`, `debian` -> [`v1.0.5`](https://gitlab.com/psuapp/psu/-/tags/v1.0.5)
- `1-debian-core`, `1.0-debian-core`, `1.0.4-debian-core`, `debian-core` -> [`v1.0.4`](https://gitlab.com/psuapp/psu/-/tags/v1.0.4) - `1-debian-core`, `1.0-debian-core`, `1.0.5-debian-core`, `debian-core` -> [`v1.0.5`](https://gitlab.com/psuapp/psu/-/tags/v1.0.5)
#### Testing/debugging: #### Testing/debugging:
@ -96,7 +97,7 @@ For testing/debugging, you can use this Docker image in interactive mode, to run
docker run -v $(pwd)/docker-compose.yml:/docker-compose.yml -it --rm --entrypoint bash psuapp/psu:1.0 docker run -v $(pwd)/docker-compose.yml:/docker-compose.yml -it --rm --entrypoint bash psuapp/psu:1.0
# Run any commands here! E.g. # Run any commands here! E.g.
$ psu --version $ psu --version
Portainer Stack Utils, version 1.0.4 Portainer Stack Utils, version 1.0.5
License GPLv3: GNU GPL version 3 License GPLv3: GNU GPL version 3
``` ```

View File

@ -729,5 +729,5 @@ The `psu` definition of a job is a Swarm [service](https://docs.docker.com/engin
Using a job is useful when you want to have a service who run a script (e.g. database migration). Using a job is useful when you want to have a service who run a script (e.g. database migration).
And shutdown this service when its script is successfully executed. And shutdown this service when its script is successfully executed.
See the service named `job` in the [`docker-stack-web-app.yml`](https://gitlab.com/psuapp/psu/tree/v1.0.4/tests/dockerfiles/docker-stack-web-app.yml) file, for a real use case. See the service named `job` in the [`docker-stack-web-app.yml`](https://gitlab.com/psuapp/psu/tree/v1.0.5/tests/dockerfiles/docker-stack-web-app.yml) file, for a real use case.
It has both a container's label `job-name` and a restart policy set to `none`. It has both a container's label `job-name` and a restart policy set to `none`.

2
psu
View File

@ -27,7 +27,7 @@ set -e
# None # # None #
############################ ############################
main() { main() {
VERSION="1.0.4" VERSION="1.0.5"
OPTIONS_TABLE=( OPTIONS_TABLE=(
# option_key;flag_text;option_text;description # option_key;flag_text;option_text;description