cliConfig is a resource used to store configuration information needed to setup a Command Line Interface.
You can create a
cliConfig resource by adding it to
Multiple cliConfig resources may be used as
INs and their respective CLIs are configured automatically. If more than one cliConfig of the same integration type is added, the last one used in
IN statements wins.
resources: - name: <string> type: cliConfig integration: <string> pointer: <object>
name-- should be an easy to remember text string
type-- is set to
integration-- name of the subscription integration. Currently supported integration types are:
pointer-- is an object that contains integration specific properties
For an Amazon ECR integration:
pointer: region: <AWS region, e.g., us-east-1, us-west-1, etc.>
For Google integrations, if region and clusterName are provided
kubectlwill be automatically configured to use that region and cluster. If not provided, just the authentication to Google Cloud is done automatically.
pointer: region: <region, e.g., us-central1-a, us-west1-b, etc.> clusterName: <cluster name>
Configured CLI tools
The runCLI and runSh job uses the subscription integration specified in the cliConfig to determine which CLI tools to configure. These tools are configured with the credentials contained in the subscription integration. Here is a list of the tools configured for each integration type:
|Integration Type||Configured Tools|
|AWS||AWS CLI; AWS Elastic Beanstalk CLI|
|Amazon EC2 Container Registry (ECR)||Docker Engine|
|Docker Hub||Docker Engine|
|Docker Private Registry||Docker Engine|
|Docker Trusted Registry||Docker Engine|
|Google Container Engine||gcloud; kubectl|
|Google Container Registry (GCR)||Docker Engine|
|JFrog Artifactory||JFrog CLI|
Used in Jobs
This resource is used as an
IN for the following jobs
Default Environment Variables
cliConfig is used as an
OUT for a job that can execute user defined scripts, a set of environment variables are configured by the platform that may be useful to set the context before user defined scripts execute as part of the job. These variables are available when this resource is used.
<NAME> is the the friendly name of the resource.
||The name of the resource.|
||The ID of the resource.|
||The type of the resource. In this case
||Values from the integration that was used. More info on the specific integration page.|
||The operation of the resource; either
||The directory containing files for the resource.|
||Region defined in the pointer. Available if the integration is AWS or Google.|
||ClusterName defined in the pointer. Available if the integration is Google.|
||The number of the version of the resource being used.|
||The versionName of the version of the resource being used.|
||The ID of the version of the resource being used.|
Shippable Utility Functions
To make it easy to use these environment variables, the platform provides a command line utility that can be used to work with these values.
How to use these utility functions is documented here.