Configuring your environments
The watsonx Orchestrate ADK introduces the concept of environments (env). An environment can either be local
with watsonx Orchestrate Development Edition, or remote
with an account on a production watsonx Orchestrate IBM Cloud or AWS. When you activate an environment, every command other than orchestrate server
and orchestrate chat
is target to that environment, including but not limited to the importing, listing, and removal of agents, tools, and connections.
Environment commands
Creating an environment
Use the orchestrate env add
command to create an environment to your local CLI.
Arguments
--name
(-n
) - The name of the environment.--url
(-u
) - The service instance URL of the watsonx Orchestrate instance. This can be found on the service instance page.--type
(-t
) - Optional, usually inferred based on the URL provided, but this allows you to specify if your server uses IBM Cloud authentication or MCSP authentication (for AWS).--activate
(-a
) - Optional, allows you to activate the environment as soon as it’s added.
Activating an environment
Use the orchestrate env activate
command to authenticate against a given environment and target all commands other than orchestrate server
and orchestrate chat
to that environment.
run orchestrate env activate
again. This behavior does not exist in the local environment.To interactively activate an environment:
To non-interactively log in for scripting, use the following:
Listing all environments
Use the orchestrate env list command
to list all environments currently available to your CLI.
By default, you have one known as local
. Your local
environment refers to the watsonx Orchestrate Development Edition server. Others can be added by using the orchestrate env add
command. The currently active environment will be indicated by an indicator saying (active)
at the end of the line.
Removing an environment
Use the orchestrate env remove
command to remove an environment from your environment list.
Important configuration files
The watsonx Orchestrate CLI maintains two configuration files which are manipulated by the above env commands.
-
The first is
~/.config/orchestrate/config.yaml
. This configuration file records each of your environments as well as which environment is currently active. -
The second is
~/.cache/orchestrate/credentials.yaml
. This file contains the JWT token from your last env activation used to authenticate with your environment.