Skip to content

Environment Template

Environment templates are a collection of resource templates and static resources that contain environment variables, lifecycle hooks, dependencies, etc. For example, an environment template could represent a full operating environment required for a complex Kubernetes application.

Create an Environment Template

  1. In a project, select Environments > Environment Templates.
  2. Select New Environment Template.
  3. Type a name for the environment template. Optionally, type a description.
  4. See below for information about each configuration category.
  5. Select Save to save the environment template. Click Cancel to close the configuration and go back to the environment template list.

General

Setting Description
Version Name Enter the version for the resource. Examples: v1, 0.1, 3.
Name Enter a name for the resource.
Description Enter a description for the resource. This is optional.
Labels Add a label to the resource. Use labels to specify identifying attributes of objects that are meaningful and relevant to users, but do not directly imply semantics to the core system. This is a key-value pair. For example, the key is environment and the value is dev.
Annotations Add an annotation to the resource. Use annotations to attach arbitrary non-identifying metadata to the resource. This is a key-value pair. For example, the key is imageregistry and the value is https://hub.docker.com/.

Resources

Setting Description
Resource Type Select the type of resource. Supported values are: Dynamic and Static.

Dynamic Resource

Setting Description
Resource Kind Select the kind of resource. Supported value for Dynamic is: Resource Template.
Resource Template Name Select the resource template to associate with the environment template.
Version Select the resource version to use.
Dedicated This is for Dynamic resource types.
Depends On This is for Dynamic resource types.
-- Depends on Name Add a name of a dependency.

Static Resource

Setting Description
Resource Kind Select the kind of resource. Supported values for Static are: Resource and Environment.
Resource Name Select the name of the resource to associate with the environment template.

Hooks

Environment Hooks

Setting Description
On Completion Set a hook that is triggered when resource creation or updating is complete.
On Failure Set a hook that is triggered when resource creation or updating fails to complete.
On Init Set a hook that is triggered when resource creation or updating is initialized.
On Success Set a hook that is triggered when resource creation or updating is successful.

Agents

Parameter Description
Name Select an agent to associate with this resource.

Variables

Setting Description
Name The name of the variable.
Description A brief description of the variable.
Value The variable value.
Value Type The type of value.
-- HCL Hashicorp configuration language.
-- JSON JavaScript Object Notation (JSON) is a lightweight data-interchange format.
-- Expressions Expressions are valid units of code that resolve to a value.
-- Text Text value.
Override Type Controls if a user can change a variable or not.
-- Allowed Allows the user to override the value.
-- Not Allowed Does not allow the user to override the value.
-- Restricted Allows the user to override the value by selecting a different, pre-defined value.
Restricted Values If Restricted is selected for the Override Type, enter the values that are allowed.
Sensitive Does not display the value in the UI.
Required The variable is required when using this Context.

Contexts

Setting Description
Context Select a Context to associate with this resource.