Search…
Use Cases
CLI Guides
References
Creating Blueprints (Alpha)
Admin Setup
Environment parameters
Control environment orchestration using dynamically set parameters
Environment parameters are placeholders defined in your Velocity account, allowing users to control their environment provisioning. When creating or updating an environment, the user can set custom values to the predefined parameters and control the environment provisioning.
Common use cases for environment parameters:
- Changing environment variables that affect your application's behavior. For example: selecting a tenant or enabling certain features.
- Changing environment size. For example, changing the number of instances of a certain service.
Please note that this feature is currently only available upon request.
Please contact Velocity support to enable this feature.
​
Defining parameters
Parameters are associated with your Velocity account and are currently defined by Velocity's support team. To define parameters in your account, please contact our support.
Changing the available parameters does not impact running environments.
To update running environments, use
veloctl env update as defined below. Listing the environment parameters
Once Velocity defines parameters in your account, you can list them by running
veloctl env list-parametersThe
list-parameters command prints the names of the parameters and their default values.​
Creating a new environment with parameters
When creating a new environment, you can change one or more of the predefined parameters by using the
--param flag. For example:
veloctl env create --param 'tenantId=3','dbLocation=west-2'If you don't assign a value to the environment parameters, Velocity will use the default value set for each parameter in your account.
​
Updating an existing environment with parameters
When you have an existing environment, you can update some of the services or all of them using the
veloctl env update command. Updating the environment allows you to change the predefined parameters using the --param flag. For example:
- Full update - updating all the services in the environment:
env update --param 'tenantId=3' - Partial update - updating selected services in the environment:
env update -s website --param 'tenantId=3'
Please note that when running a partial update, the new values set in the update command will only affect updated services.
​
​
​
​