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

Update changelog

Browse Source
This commit is contained in:
Juan Carlos Mejías Rodríguez 2019-08-17 00:36:21 -04:00
parent f2b30892ac
commit 9b0dd79146
1 changed files with 55 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
CHANGELOG.md
View File

@ -6,50 +6,66 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
### Added
- `config` command to get and set configuration options.
- `config list|ls` command to list configuration options.
- `--keys` flag to show only config keys.
- `endpoint list|ls` command to print the endpoints list as a table.
- `--format` flag to format output using a Go template.
- `stack list|ls` command to print the stacks list as a table.
- `--swarm` flag sets a filter by swarm Id.
- `--endpoint` flag sets a filter by endpoint Id.
-`-q, --quiet`) flag causes stack list to print only stack names.
- `--format` flag to format output using a Go template.
- `stack deploy|up|create` command to deploy a stack.
- `-c, --stack-file` flag sets the stack file to use.
- `-e, --env-file` flag sets the environment variables file to use.
- `--replace-env` flag causes environment variables to be replaced instead of merged while updating a stack.
- `--endpoint` flag sets the endpoint to use.
- `-r, --prune` flag causes services that are no longer referenced to be removed.
- `stack remove|rm|down` command to remove a stack.
- `--strict` flag causes a failure if the stack does not exist.
- `status` command to show Portainer status as a table.
- `--format` flag to format output using a Go template.
- `help` command and `-h, --help` global flag to print global help.
- `-h, --help` flags on each command to print its help.
- `-t, --timeout` global flag to set a timeout for requests execution.
- `--config` global flag to set the path to a configuration file.
- `--version` global flag to print the client version.
- All commands are self documented.
- If an endpoint is not set while deploying/updating/removing a stack, the program will try to guess it.
- Log messages contain a main message field and may contain several fields with context details, like stack name, endpoint name, warning implications, error fixing suggestions, etc.
- A Custom User-Agent header is sent on requests to the Portainer server to identify the client.
- Supported platforms and architectures linux 32/64 bit, darwin 32/64 bit, windows 32/64 bit, and arm7 32/64 bit.
- `completion` command to print Bash completion script.
- `config set` command to set configuration options.
- `config get` command to get configuration options.
- `config list|ls` command to print configuration options.
- `--format` flag to select output format from "table", "json" or a custom Go template. Defaults to "table".
- `endpoint list|ls` command to print endpoints.
- `--format` flag to select output format from "table", "json" or a custom Go template. Defaults to "table".
- `endpoint group list|ls` command to print endpoint groups.
- `--format` flag to select output format from "table", "json" or a custom Go template. Defaults to "table".
- `help` command to print global help.
- `login` command to authenticate against Portainer server.
- `--print` flag to print the retrieved auth token.
- `stack deploy|up|create` command to deploy/update a stack.
- `--endpoint` flag to set the endpoint to use.
- `-e, --env-file` flag to set the file with environment variables to use with the stack.
- `-r, --prune` flag to remove services that are no longer referenced.
- `--replace-env` flag to replace environment variables instead of merging them while updating a stack.
- `-c, --stack-file` flag to set the file with the YAML definition of the stack.
- `stack list|ls` command to print stacks.
- `--format` flag to select output format from "table", "json" or a custom Go template. Defaults to "table".
- `--endpoint` flag to filter stacks by endpoint name.
- `stack remove|rm|down` command to remove a stack.
- `--endpoint` flag to set the endpoint to use.
- `--strict` flag to fail if the stack does not exist.
- `status` command to show Portainer server status.
- `--format` flag to select output format from "table", "json" or a custom Go template. Defaults to "table".
- `-h, --help` flags on each command to print its help.
- `-A, --auth-token` global flag to set Portainer auth token.
- `--config` global flag to set the path to a configuration file. Supported file formats are JSON, TOML, YAML, HCL, envfile and Java properties config files. Defaults to "$HOME/.psu.yaml".
- `-h, --help` global flag to print global help.
- `-v, --log-level` global flag to set log level from "panic", "faltal", "error", "warning", "info", "debug" and "trace". Defaults to "info".
- `--password` long name for `-p` global flag.
- `-t, --timeout` global flag to set a timeout for requests execution.
- `--url` long name for `-l` global flag.
- `--user` long name for `-u` global flag.
- `--version` global flag to print the program version. It includes the version number (major.minor.patch), the commit hash it was built from, the platform and architecture it was compiled for, and the build date.
### Removed
- `-a` flag, which used to select an action to execute. There is a command now for each action.
- `bash`, `jq` and `httpie` programs in the Docker image. The client doesn't use them anymore.
- `-a` global flag to select an action to execute. The sytax is now `COMMAND ARG --FLAG`, with a command for each action.
- Verbose and debug mode, which used to be enabled through `-v` and `-d` global flags respectively. The Debug and Trace log levels are the new equivalents.
- Requirement off `bash`, `jq` and `httpie` to run the program (they have also been removed from the Docker image). The new executable binary is self-sufficient.
### Changed
- Single executable binary instead of a bash script. Project has been rewritten in Go language.
- No external programs (bash, httpie, jq) dependency. The new executable binary is self-sufficient.
- `-s` global flag renamed to `-i`. It does not receive a value anymore, it is a boolean flag.
- `-v` global flag renamed to `-v, --verbose`. It does not receive a value anymore, it is a boolean flag.
- `-d` global flag renamed to `-d, --debug`. It does not receive a value anymore, it is a boolean flag.
- `-n` global flag moved as a parameter to the `stack deploy` command.
- `-c` global flag renamed to `-c, --stack-file` and moved to the `stack deploy` command.
- `-g` global flag renamed to `-e, --env-file` and moved to the `stack deploy` command.
- `-r` global flag renamed to `-p, --prune` and moved to the `stack deploy` command. It does not receive a value anymore, it is a boolean flag.
- `-e` global flag renamed to `--endpoint` and moved to the `stack deploy` command.
- `-t` global flag renamed to `--strict` and moved to the `stack remove` command.
- All environment variables prefixed with "PSU_" and renamed to match command and flag names.
- Single executable binary instead of a bash script. The program has been rewritten in Go language.
- Supported Portainer API raised to `1.22.0`. **Previous versions may still work.**
- Endpoints are refered to by their name instead of their id.
- Base Docker image fixed to `alpine:3.10`.
- `-s` global flag to disable SSL certificate validation renamed to `-i, --insecure`. It does not receive a value anymore, it is a boolean flag.
- `-n` global flag to set the stack name moved as a parameter to the `stack deploy`, `stack list` and `stack remove` commands.
- `-c` global flag to set the file with the YAML definition of the stack renamed to `-c, --stack-file` and moved to the `stack deploy` command.
- `-g` global flag to set the file with the environment variables to use with the stack renamed to `-e, --env-file` and moved to the `stack deploy` command.
- `-r` global flag to remove no longer referenced services renamed to `-p, --prune` and moved to the `stack deploy` command.
- `-e` global flag renamed to `--endpoint` and moved to the `stack deploy`, `stack list` and `stack remove` commands. It now expects an endpoint name instead of its id.
- `-t` global flag renamed to `--strict` and moved to the `stack remove` command. It does not receive a value anymore, it is a boolean flag.
- All supported environment variables prefixed with "PSU_" and renamed to match command and flag names.
## [0.1.1] - 2019-06-05
### Fixed