Including orchestration in an environment group
You can include orchestration in a TNCO environment group.
The TNCO environment in a group must be provided under the key tnco
,
lm
, or alm
with the following properties:
environments:
example:
description: a short example environment
tnco:
address: https://app.lm:32443
secure: true
username: jack
password:
example_with_details:
description: an example environment
tnco:
###############
# General #
###############
## The full HTTP(s) address used to access the API gateway (Ishtar route) of your TNCO instance
address: https://ishtar-route.ocp.example.com
## Set to true if TNCO is secure and requires authentication to use the APIs
secure: True
#####################################################################
# Zen Authentication #
# Required if "secure" is true and not using Oauth or Token #
#####################################################################
# Indicate environment is using Zen
auth_mode: zen
## The full HTTP(s) address and path used to access the Zen authentication APIs E.g. https://<hostname>/icp4d-api/v1/authorize
auth_address: https://cpd-lifecycle-manager.apps.example.com/icp4d-api/v1/authorize
## The username to authenticate with
username: example-user
## The API key for the specified user
#api_key: enter-your-api-key
#####################################################
# Oauth Authentication #
#####################################################
# Indicate the environment is using oauth
#auth_mode: oauth
#=========================#
# Oauth Option 1: #
# TNCO Client credentials #
#=========================#
## ID of the client credentials to authenticate with
#client_id: LmClient
## Secret for the specified client
#client_secret: enter-your-secret
#=========================#
# Oauth Option 2: #
# TNCO User based access #
#=========================#
## ID of the client credentials with password scope authentication enabled
#client_id: LmClient
## Secret for the specified client
#client_secret: enter-your-secret
## The username to authenticate with
#username: jack
## The password for the specified user
#password: enter-your-pass
#=================================#
# Oauth Option 3: #
# "unofficial" user based access #
#=================================#
## Using username/password without client credentials is not supported by TNCO so could stop functioning in any future release
## The username to authenticate with
#username: jack
## The password for the specified user
#password: enter-your-pass
#####################################################
# Token Authentication #
#####################################################
# Indicate the environment is using token based auth
#auth_mode: token
#token: enter-your-token