add Environment variable section to README.md

This commit is contained in:
Roberto Cirillo 2022-10-17 10:36:27 +02:00
parent eb8b09115b
commit f48df8bc6a
1 changed files with 5 additions and 0 deletions

View File

@ -17,6 +17,11 @@ Jenkins Pipeline script to manage one or more gCube components deployment
* Manually from Jenkins GUI
## Expected environment variables
The variables below must be specified as environment variables on the agent where the deployments will be executed:
* IS_SCHEDULED (True | False): if true all the deployment requests will be performed periodically as specified by cron
* ENVIRONMENT: ( DEV | PREPROD | PROD) Indicates the target environment where will be deployed all the artifacts
* DEPLOY_CATEGORY: (Related to release build) one or more Component group on yaml file where search the components to deploy
* CD: (Continuous Deployment: True | False) if True the remote deploy will be performed
## References
* [Jenkins Pipeline](https://jenkins.io/doc/book/pipeline/)