Installing the HKT CLI

To successfully deploy you will need a few tools installed and we'd recommend getting some environment variables created as well to make life easier.

Supporting Tools

To deploy Hydrolix in GCP you will need to have some supporting tools installed. You should make sure these are installed first.

Hydrolix GCP uses Kubernetes and you will need the Google Cloud CLI and kubectl installed.

You can check if they are installed by:

which kubectl
which gcloud

Set-up Environment Variables

We'd also recommend setting up some environment variables, to make the installation easier:

export CLIENT_ID=<HYDROLIX WILL PROVIDE YOU>
export [email protected]
export OWNER=admin
export HYDROLIX_HOST= <CHOOSE A HOSTNAME>
export HYDROLIX_DOMAIN=hydrolix.net
export CLOUD=gcp
export REGION= <CHOOSE A GCP REGION e.g. us-central1>
export HKT_VERSION= < THE HKT VERSION YOU ARE USING e.g.v3.6.1>
export PROJECT_ID= <YOUR PROJECT ID WHERE THE PLATFORM WILL RESIDE>

More information on each of the values are below.

Variable

Description

Example

CLIENT_ID

The Hydrolix CLIENT_ID you have been provided when requesting a licence.

hdxcli-asdf1234

ADMIN_EMAIL

The email you will use as your initial login, in addition an email will be sent to

[email protected]

OWNER

The owner of the cluster. The deployment will be tagged with.

admin

HYDROLIX_HOST

The hostname to use to access the cluster.

myhdxdeploy

HYDROLIX_DOMAIN

The top level domain the cluster will be accessible from.

mycompany.com

CLOUD

Required field with value gcp

gcp

REGION

The GCP region the cluster will be deployed too.

us-central1

HKT_VERSION

The version of HKT you are going to use.

v3.8.2

PROJECT_ID

The Google Project ID for the project you will be deploying into.

prod-1234

Install hkt - Hydrolix Kubernetes Toolkit

The final tool you should install is hkt.

This tool is a binary which helps to generate the yaml configuration files you will need to deploy your Hydrolix platform. These configuration files include:

πŸ‘

Get the latest version of hkt

$curl -s -o hkt https://hdx-infrastructure.s3.amazonaws.com/hkt/hkt-`VERSION` && chmod +x hkt

πŸ‘

Move the binary to your local bin folder

$ sudo mv hkt ~/.local/bin/

OR

$ sudo mv hkt /usr/local/bin/

Verify the installation by typing hkt:

$ hkt
Usage: python -m hkt [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  get-resources
  hydrolix-cluster
  operator-resources
  scale-defaults

πŸ“˜

Hydrolix makes updates to the service and software regularly and it is advisable to check for the newest release. Release notes and previous versions can be found on the current release notes page

Congratulations that's the boring bit done! The next step is to deploy the platform! Huzzah!


Did this page help you?