Integration (aka Integration Config)

doohickey integration is for generating, modifying, and deploying integration configurations to Doohickey Cloud. Integrations are scoped to a Doohickey Cloud tenant, so you may be prompted to select a Doohickey Cloud tenant before proceeding, depending on the command and whether a specific integration was already identified by a flag or argument.

Arguments

doohickey integration accepts one argument - an alias for the integration

Common Flags

All integration commands use the optional --environment flag for specifying a Doohickey Cloud project workspace.

Create

doohickey integration create creates an integration record in Doohickey Cloud. The UUID for this integration will be saved for the Doohickey CLI to reference later.

Prerequisites:

• a Doohickey Cloud tenant
• a Doohickey Cloud integration definition
• a Doohickey Cloud environment with a valid OIH user
• one or more templates that will be part of the integration

The create command will prompt for the following information:

• the alias, if one is not provided as part of the command
• the display name for the integration
• the description for the integration
• the Doohickey Cloud tenant under which to create the integration (selected from the list of available tenants)
• the Doohickey Cloud integration definition to use (selected from the list of available integration definitions)
• the Doohickey Cloud templates to include (selected from the list of available templates)
• which of those templates will be set to active (active templates will be automatically started upon creation of the integration)
• any JSON configuration needed for this integration (entered as either raw JSON or a path to a JSON file)
• any secrets to add to the integration (selected from the list of available secrets)

The integration object will be previewed in the console prior to creation.

Delete

doohickey integration delete will remove an integration from Doohickey Cloud. The integration can be specified by the --id flag, the alias argument, or selected from the list of existing integrations if neither the flag nor the argument are provided.

Init

doohickey integration init will provide a list of integrations that currently exist in Doohickey Cloud. You can select one of these integrations to alias and save to your local doohickey configuration.

Status

doohickey integration status will return the deployment status of a flow.

When deployed through Doohickey Cloud, a flow is a combination of a template and an integration configuration. Thus to view the status of a deployed flow you must specify both the template and the integration configuration. The integration can be specified either by providing the integration alias as an argument, or by providing the integration id with the flag --id. The template can be specified by its alias, with the --template flag, or by its id, with the --templateId flag.

If the template, the integration configuration, or both are missing the command will prompt the user for the missing values.

For example, to retrieve the status of the flow created by a template with the alias of my_template and an integration configuration with the alias my_integration, run the command doohickey integration status my_integration --template my_template.

The result will be something like this:

{
  "id": "61f69022e379c6062a0c6e2b",
  "status": "success",
  "templateId": "2UMP5C4CYY4K8SEDTVBYDX1D77",
  "integrationId": "FIZ4NRB614T8DQRTAJNP568N4B",
  "message": "flow 61f69022e379c6062a0c6e2b processed"
}

Update

doohickey integration update will apply an update to an existing integration. The integration can be specified by the --id flag, the alias argument, or selected from the list of existing integrations if neither the flag nor the argument are provided.

View

You are able to view a single integration as well as viewing all integrations available under a tenant in Doohickey Cloud.

View One Integration

To view a single integration, run the command doohickey integration view myIntegrationAlias, replacing myIntegrationAlias with the alias of the integration you would like to view, or doohickey integration view --id 12345 replacing 12345 with the UUID of the integration. Outputs in JSON format.

View All Integrations

To view all integrations, run the command doohickey integration view and Doohickey Cloud will retrieve all integrations and return limited information about them. To retrieve additional information, you can pass the --verbose flag.