Environment Management

Environments are deployment targets. They are logical groups of cluster + namespace + framework that allow Shipa to understand where to deploy an application, and which set of policies to enforce during such deployments (and post-deployment).

Creating an environment

Dashboard

You can create an environment by visiting the page "Environments"

13051305

Click the "Create" button and fill out the information required.

📘

Environment prerequisites

In order to create an environment you need to have a cluster previously connected (visit Connecting Clusters) and a framework created (visit Framework Management).

13081308

Enter a meaningful name for your environment, select the preferred cluster, choose a preferred framework and optionally enter a namespace to define where your apps should be deployed within your cluster. If the namespace is not provided, Shipa will generate a random namespace.

411411

Click "Create" and complete the process.

After a few seconds, the process should succeed and your new environment should appear in your list

13031303

CLI

The command below creates a new environment using an existing cluster and framework:

shipa environment create <environment> [-f/--framework] [-c/--cluster] [-n/--namespace] [flags]

Command options:

-c, --cluster The cluster to deploy your app to.
-k, --framework The framework to enforce during app deployments.
-n, --namespace The Namespace to create, generated if not passed within the provided cluster

Flags:

FlagDescription
-c, --cluster(= "") the cluster to deploy/discover apps
-k, --framework(= "") the framework to enforce policies with
-n, --namespace(= "") the namespace to create/use when deploying/discovering apps

Updating environments

Dashboard

To update an existing environment using the Dashboard, visit the section "Environments" on the left-hand menu, locate the wanted resource on the list, and click the Update button

13031303

The dashboard will prompt you with a screen with the current attributes of the selected environment. Change any of the permitted properties and click the button "Update".

13011301

When the update finishes, Shipa will automatically start enforcing the new framework over all the applications living within the selected environment.

CLI

To update existing environments, use the command below (indicating the name of the intended resource)

shipa environment update <environment> [flags]

Flags:

FlagDescription
-y, --assume-yes(= false) don't ask for confirmation
-k, --framework(="") the framework to enforce policies with

📘

Limitations

At the moment, the update process only supports changing the "name" of the environment and the "framework" associated with it. Other parameters cannot be updated after the environment has been created.

Removing environments

Dashboard

To delete an existing environment using the Dashboard, visit the section "Environments" on the left-hand menu, locate the wanted resource on the list, and click the Delete button

13051305

Confirm the process in the prompted screen and Shipa will start checking if the environment can be removed. If no applications managed by Shipa exist in such namespace, the environment will be deleted successfully

CLI

To remove existing environments simply use the environment remove command indicating the name of the environment that wants to be deleted

shipa environment remove <environment> [flags]

Flags

FlagDescription
-y, --assume-yes(= false) don't ask for confirmation