Create a Custom Environment
Available configurations
A custom environment allows you to choose the infrastructure you need to execute your project. Here are the available custom environments and their usage guidelines:
SMALL: 1 Core, 2GB Memory
MEDIUM: 2 Cores, 4GB Memory
LARGE: 4 Cores, 8GB Memory
CPU_LARGE: 8 Cores, 16GB Memory
MAX_LARGE: 12 Cores, 32GB Memory
EXTRA_MAX_LARGE: 12 Cores, 48GB Memory
Parameters
name
The name of the environment.
String
Yes
new_custom_env1
description
The description for the environment.
String
No
env for my projects
envType
The hardware requirements for the environment. Possible values: SMALL, MEDIUM, LARGE, CPU_LARGE, MAX_LARGE, EXTRA_MAX_LARGE
String
Yes
If you are selecting the hardware requirement as SMALL: 1 core, 2GB memory, then you must enter EnvType.SMALL.
requirements
The additional packages to install for the custom environment.
No
jq==1.2.2 yq==3.0.2
Deleting an environment
The following code block must be used to delete an environment.
Example code block for deleting an environment:
Editing the environment details
Use this code block to modify environment details of a specific environment. You must pass the environment ID for which you want to modify the environment details.
Sample code:
Example response:
Fetching all environments in a tenant
The following code block can be used to fetch all environments.
Example response:
Searching for an environment by name or ID
Use this code to search for an environment by its name.
Example code:
Use this code to search for an environment by its ID.
Example code:
Viewing the list of supported environments
Use this code to fetch the list of supported environment types.
Example response:
Fetching resources from a specific environment type
Use this code to fetch the resources such as cores and memory in a specific environment type.
Example code:
Example response:
Last updated