Installing the Console via Docker image

Prerequisites

Before installing the Capsule8 Console, create a Postgres database for the console.

gcloud

Capsule8 uses Google Cloud to host its container registry. In order to complete these steps, a user is required to have an appropriate service account key file (provided by Capsule8).

This service account key file should be saved to ~/.gcloud/key-file.json on a machine that will be used to pull/store the Capsule8 images, and where the images will be prepared for use. Below is an example service account key file.

{
  "type": "service_account",
  "project_id": "cap8-docker",
  "private_key_id": "<>",
  "private_key": "-----BEGIN PRIVATE KEY-----\\abcde12345678910\\abcde12345678910\\n-----END PRIVATE KEY-----\\n",
  "client_email": "< client name >@cap8-build.iam.gserviceaccount.com",
  "client_id": "12345678910111213",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://accounts.google.com/o/oauth2/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/< client name >%40cap8-docker.iam.gserviceaccount.com"
}

In order to pull images from the registry a user is required to install the gcloud tool. After the gcloud tool is installed and the service account key file is present, authorization can be performed using the command below.

gcloud auth activate-service-account < your name >@cap8-docker.iam.gserviceaccount.com --key-file=~/.gcloud/key-file.json

After a successful authorization, images can be pulled from the container registry using gcloud:

gcloud docker -- pull us.gcr.io/cap8-docker/capsule8-console:4.10.0

NOTE: If you get the following message:

WARNING: `gcloud docker` will not be supported for Docker client versions above 18.03.

and/or this error:

ERROR: gcloud crashed (TypeError): a bytes-like object is required, not 'str'

...use this command instead to pull the Docker image.

docker pull us.gcr.io/cap8-docker/capsule8-console:4.10.0