Setup Self-Managed Shipa - Quickstart

📘

Follow the instructions in this section if you prefer to self-manage Shipa in your cluster. Otherwise, feel free to jump to the Setup Shipa Cloud section to register with Shipa Cloud.

Setting up a self-managed Shipa is easy. We'll install the Shipa components inside your Kubernetes cluster and we'll make sure that the cluster is added as a target inside the Shipa platform.

Requirements

The only requirement for running self-managed Shipa is a Kubernetes cluster. If using the free version of Shipa, the cluster must be running in a single-zone. Regional clusters are reserved for the Enterprise version.

This quickstart assumes that a Kubernetes cluster is already running and can be accessed through kubectl.

The list of more detailed requirements can be found in Installation Requirements.

🚧

All the commands in this quickstart were verified in macOS, Linux, and Windows Subsystem for Linux (WSL). You might need to modify the commands if you are using Windows (without WSL).

If this is your first time using Shipa, you might need to download the shipa command-line interface (CLI) onto your local machine.

📘

The CLI is highly recommended. The CLI is needed to expose the WebUI Dashboard Address post installation.

Install Shipa onto your cluster

It's time to install Shipa inside your remote Kubernetes cluster. More detailed instructions, including those for running Shipa in a local Kubernetes cluster, can be found in Installing Shipa.

📘

Follow the Installing Helm instructions if you do not already have helm CLI.

🚧

Please change the values of the --set arguments in the helm upgrade command to match the desired initial username and password.

Bear in mind that the minimum password length is seven characters.

helm repo add shipa-charts https://shipa-charts.storage.googleapis.com

helm repo update

helm upgrade --install shipa shipa-charts/shipa \
  --set [email protected] --set auth.adminPassword=this-is-a-secret \
  --namespace shipa-system --create-namespace --timeout=1000s --wait

It might take a couple of minutes until the process is finished and Shipa is fully operational.

Install Shipa CLI

Install the Shipa CLI

curl -s https://storage.googleapis.com/shipa-client/install.sh | bash

Add the Shipa Installation as a Shipa Target via the CLI

We are almost done. All that's left is to add the newly installed Shipa instance as a target so that CLI knows how to find the API.

shipa target add shipa -c -s

shipa login

Above command add a Shipa API target name shipa that shipa CLI communicates with.

• -c, --from-current-context: Shipa uses your current kubernetes context to determine shipa API address to use
• -s, --set-current: Adds and set this Shipa API endpoint as current target

📘

Please use the values specified as adminUser and adminPassword in the helm upgrade command.

📘

Please visit Shipa Target Management for more information about targets.

Expose the UI via the CLI

You can get the Self-Managed Dashboard e.g the UI from the CLI with Shipa App List.

shipa app list

+-------------+-----------+---------------+------------------------------------------------------------+
| Application | Status    | Shipa Managed | Address                                                    |
+-------------+-----------+---------------+------------------------------------------------------------+
| dashboard   | 1 running | true          | http://dashboard.                                        ↵ |
|             |           |               | a292fd2b956d445e3b0955101a03af-626390810.us-east-1↵ |
|             |           |               | .elb.amazonaws.com.shipa.cloud                             |
+-------------+-----------+---------------+------------------------------------------------------------+

You can open dashboard in the browser using following command

shipa dashboard open

License Management

New Shipa install comes with Free License.

shipa license info

*License:
Name: Free
Last Activated:
Expires On:
Entitlement:
app-auto-discovery: true
app-autoscaler: false
autoscaler: false
canary: true
dependency: true
limits:
appLimits: 5
resource-plan: true
saml: false
saml-group-sync: false
security-scanner: true
volumes: true

• Update license

  CLI

shipa license update -f PATH-TO-SHIPA-LICENSE

License:
Name: Pro
Last Activated: 2020/03/27
Expires On: 2023/03/27
Entitlement:
app-auto-discovery: true
app-autoscaler: true
autoscaler: true
canary: true
dependency: true
limits:
appLimits: unlimited
resource-plan: true
saml: true
saml-group-sync: true
security-scanner: true
volumes: true

• Upgrade License using Dashboard *