Setup a New Project Workspace

When getting started with a new OIH environment we recommend you setup a new project workspace alias in your local development environment using the Doohickey CLI. You will typically want to do this when initially configuring connections to a pre-production or production environment.

The benefit of setting up a separate local project workspace alias is that you can use the same alias across project workspaces and associate it to different IDs in a particular OIH or Doohickey Cloud environment. This allows the Doohickey CLI commands to reuse those IDs across the applicable commands reducing repetative flag entry.

Alias New Workspace

You can create a new project workspace when using the login commands.

  1. First login to your OIH environment you are setting up by following the usage example. Provide your project workspace alias such as preproduction or production.

  2. Then login to your Doohickey Cloud account and provide the same alias as the OIH login command.

(Optionally) Initialize OIH Service URLs

You can initialize all the base URLs for each OIH service in a particular environment. If you do not use this step you can provide the url as a flag to each command or you will be prompted for the value. Once the command has successfully run, the base url for that service will be remembered for any other CLI commands which require it.

Initialize OIH Service URLs

Setup OIH Components

Aliasing the components using the CLI will allow the CLI to automatically fill in the IDs for a particular environment. There are two ways to setup components depending on whether the components already exist in an OIH environment.

If a component already exists then you want to initialize an existing component from the repository. If the components have not been created in the environment you will want to go ahead and create them. In either case you are creating an alias for the component that the Doohickey template will use to abstract away environment specific IDs.

Create a new component

Doohickey CLI Documentation

Initialize an existing component

Doohickey CLI Documentation

(Optionally) Register the OIH environment in Doohickey Cloud

Now that you have the project workspace setup and components created you can register the environment in Doohickey Cloud. This will allow your templates to map your aliases to specific OIH environment IDs.

To register the OIH environment run the doohickey environment create <pre-production, production, etc.> command and follow the prompts. For more option reference the Doohickey CLI documentation