Commands for Environment Management¶
We do not recommend using VCS-related commands manually or through CI/CD processes, as these are commands designed to be used by the Administration Tool and the Design Studio.
Environments, in the VCS integration context, consist on a name and an optional description (see section Environment Management of the Administration Guide). The following figure shows the syntax to create, modify and delete environments, and to list the environments available in the configured version control repository:
CREATE ENVIRONMENT <name:identifier> [ <description:literal> ]
ALTER ENVIRONMENT <name:identifier> <description:literal>
DROP ENVIRONMENT <name:identifier>
VCS must be configured and activated in order to execute any environment-related command. In addition, only global administrator users are allowed to create, alter or drop an environment.
By creating an environment, a properties file named like the
environment and containing the environment’s name and description is
checked into the VCS repository configured for the VDP server.
Environment files are located under
<path_to_remote_repository>/environments in the remote repository
When dropping an environment, all the properties files associated to the environment are also removed from the corresponding remote repository.