2.1.4 • Published 4 years ago

portainer-update v2.1.4

Weekly downloads
3
License
MIT
Repository
github
Last release
4 years ago

Portainer Update

This tool can be used to update a stack via the portainer project.

Feature list

  • Update existing stacks
  • Read a docker-compose file from file system
  • Make tool available through npx
  • Deploy new stacks

Usage

==Attention: Portainer only supports compose file version 2 at the moment==

Example Usage

npx portainer-update -p <Stackname> -u <Portainer Username> --password <Portainer Password> -f <Path to docker compose> -s <Portainer URL>

Parameters

ParameterNameDescriptionRequired
-h | --helpHelpShow this parameter table
-e | --envEnvrionmentAt the moment this parameter has no effect
-p | --projectStacknameThe name of the stack you want to updateX
-u | --userPortainer UsernameThe username of the user which will update the stack ==The user need the permission to edit the stack==X
--passwordPortainer PasswordThis tool is for use in CiCD pipelines so please provide the password as a secret variableX
-f | --composePath to composeFill in the path to the compose file, which you want to deployX
-s | --portainersystemPortainer API URLThe address where to find portainer API (The url you are browsing to in your browser)Default value: http://localhost:9000
--endpointEndpoint IDThe id of the endpoint where the stack should be deployedDefault value: 1