environment

Any transformer can have arbitrary environment variables provided by the client when a pipeline is executed.

An environment configuration has the following fields:

  • name: The name of the environment variable

  • description: A useful description that aids in documentation.

  • required: A boolean value indicating whether or not this environment variable has to be included in a Pipeline submission to be valid.

  • default_value: If unset in a Pipeline submission, what value should be used instead.

  • sensitive: A boolean value indicating whether this variable contains sensitive information (e.g. secrets or credentials).

NOTE:

Example

    "environment": [
        {
          "name": "SSH_SERVER",
          "description": "The SSH server to communicate with",
          "required": true
        },
        {
          "name": "SSH_USE_PASSWORD_AUTH",
          "description": "Boolean value to allow username/password ssh authentication",
          "default_value": "false"
        },
        {
          "name": "FILTERS",
          "description": "List of filters to use"
        }
    ]

When a Pipeline is submitted using this Transformer, the following environment variables will be set:

  • SSH_SERVER must be provided by the user who submits the Pipeline, or else it’ll return an error.

  • SSH_USE_PASSWORD_AUTH is optional, but if not set by the user who submits the Pipeline then "false" will be passed.

  • FILTERS is optional, but if not set by the user who submits the Pipeline then no value will be set (and FILTERS will not be provided in the Transformer’s environment).