diff --git a/README.md b/README.md index 21a978e..c71c91e 100644 --- a/README.md +++ b/README.md @@ -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/)