Environment
doohickey environment allows you to interact with environment objects in Doohickey Cloud.
An environment object represents an instance of an integration platform, such as Open Integration Hub (OIH).
Arguments
doohickey environment accepts one argument - an alias for the environment
Common Flags
All environment commands use the optional --environment flag for specifying a Doohickey Cloud project workspace.
Create
doohickey environment create creates an environment record in Doohickey Cloud. The UUID for this environment will be saved for
Doohickey CLI to reference later.
Environments can be created either from a file (using the --file flag to specify a file path), or from an existing OIH
project workspace. When creating from an existing OIH project workspace flags may be used to specify service url endpoints.
| flags | type | description |
|---|---|---|
--file (-F) | string | Optional flag to provide filepath for environment body |
--name (-n) | string | Name of the Doohickey Cloud environment object |
--description (-d) | string | Description of the Doohickey Cloud environment object |
--componentRepoUrl (-c) | string | OIH service url for Component Repository |
--flowRepoUrl (-f) | string | OIH service url for Flow Repository |
--secretServiceUrl (-s) | string | OIH service url for Secret Service |
--iamUrl (-i) | string | OIH service url for IAM Service |
--webhookUrl (-w) | string | OIH service url for webhook service |
--componentAliases (-C) | string | Comma separated list of component aliases, ex: rest,jsonata |
--user (-u) | string | The user ID to assign to Doohickey Cloud environment |
When creating an environment make sure that you have an user alias called admin. This OIH user aliased will be used to create tenants in OIH.
For more information look at the Tenant - Doohickey Cloud CLI command.
Create from a Project Workspace
If no --file flag is passed to the create command then the CLI will prompt you to create an environment record from an existing
OIH project workspace in your .doohickey.json file. You will first be prompted on whether to use the current OIH project
environment, or whether you would like to select a different one. Ensure that you have added all components you wish to use to
your OIH project workspace before running the create environment command. The other flags can be used to fill in additional
information.
Create from a File
Using the --file flag, you can pass the path to a JSON file that contains the information necessary for creating the Doohickey
environment record. This data should follow the same format as the POST request to the Doohickey Cloud /environments/ endpoint.
Delete
doohickey environment delete will remove an environment from Doohickey Cloud. The environment must be specified by an alias. If
the environment is not aliased locally you must first run doohickey environment init to add a local alias.
Init
doohickey environment init will provide a list of environments that currently exist in Doohickey Cloud. You can select one of
these environments to alias and save to your local doohickey configuration.
Update
doohickey environment update will apply an update to an existing environment. The environment must be specified by an alias. If
the environment is not aliased locally you must first run doohickey environment init to add a local alias.
Details for the environment may be provided via a JSON file (with the --file flag), or an existing OIH project workspace
may be selected interactively in the same manner as the create command.
| flags | type | description |
|---|---|---|
--file (-F) | string | Optional flag to provide filepath for environment body |
--name (-n) | string | Name of the Doohickey Cloud environment object |
--description (-d) | string | Description of the Doohickey Cloud environment object |
--componentRepoUrl (-c) | string | OIH service url for Component Repository |
--flowRepoUrl (-f) | string | OIH service url for Flow Repository |
--secretServiceUrl (-s) | string | OIH service url for Secret Service |
--iamUrl (-i) | string | OIH service url for IAM Service |
--webhookUrl (-w) | string | OIH service url for webhook service |
--componentAliases (-C) | string | Comma separated list of component aliases, ex: rest,jsonata |
--user (-u) | string | The user ID to assign to Doohickey Cloud environment |
View
You are able to view a single environment as well as viewing all environments available in Doohickey Cloud.
View One Environment
To view a single environment, run the command doohickey environment view myEnvironmentAlias, replacing myEnvironmentAlias
with the alias of the environment you would like to view.
View All Environments
To view all environments, run the command doohickey environment view and Doohickey Cloud will retrieve all environments and
return limited information about them. To retrieve additional information, you can pass the --verbose flag.
| flags | type | description |
|---|---|---|
--verbose (-v) | boolean | Verbose mode for view command to list all columns |
--json (-j) | boolean | Output data as JSON |