Environment configuration file

Definition

An environment is a way to declare and manipulate sets of environment variables and attach them to pipelines within a workflow. It is also a way to organize your workflow and keep it clear and still readable.

Format

name: MyEnvironment

values:
  myBooleanVariable:
    type: boolean
    value: true

  myNumberVariable:
    type: number
    value: 1

  mySecretVariable:
    type: password
    value: f1a2b3dd756e4db381d7a88631c67355

  myStringVariable:
    value: myStringValue

  myTextVariable:
    type: text
    value: |
      This
      Is a
      multiline text value
      with a project variable inside {{.cds.proj.var}}

All variables in CDS have a type: string (the default type that can be omitted), number, boolean, and text. You can also define password, the value in the file is encrypted. You can generate an encrypted value with the command cdsctl encrypt MYPROJECT my-data my-super-secret-value.

All values can reference other variables, thanks to the CDS interpolation engine:

  myTextVariable:
    type: text
    value: |
      This
      Is a
      multiline text value
      with a project variable inside {{.cds.proj.var}}

File usage

The environment files can be exported and imported from CDS with the following command.

➜  ~ cdsctl environment export

➜  ~ cdsctl environment import

The files can also lie in your git repositories if your workflow definition is stored in your git repository.

Usage in a pipeline

While running a pipeline attached to this environment, you can manipulate those variables in too ways:

Note that the variable names are exposed as following:

Name Exposed variables
MyStringVariable {{.cds.env.MyStringVariable}}, CDS_ENV_MYSTRINGVARIABLE, CDS_ENV_MyStringVariable, MYSTRINGVARIABLE, MyStringVariable
My.String.Variable {{.cds.env.My.String.Variable}}, CDS_ENV_MY_STRING_VARIABLE, CDS_ENV_My.String.Variable, MY_STRING_VARIABLE, My.String.Variable
My-String-Variable {{.cds.env.My-String-Variable}}, CDS_ENV_MY_STRING_VARIABLE, CDS_ENV_My-String-Variable, MY_STRING_VARIABLE, My-String-Variable
My_String_Variable {{.cds.env.My_String_Variable}}, CDS_ENV_MY_STRING_VARIABLE, CDS_ENV_My_String_Variable, MY_STRING_VARIABLE, My_String_Variable