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 successfully deploy you will need a few tools installed and we'd recommend getting some environment variables created as well to make life easier.

Hydrolix uses Kubernetes and you will need the kubectl installed.

You can check if they are installed by:

which kubectl

Set-up Environment Variables

We'd also recommend setting up some environment variables using a env.sh script, to make the installation easier:

cat <<<<EOT >>>> env.sh
export [email protected]
export OWNER=admin
export HYDROLIX_HOST=data
export HYDROLIX_DOMAIN=company.com
#need to use AWS even for Linode as it is an S3 compatible API
export CLOUD=aws
#region used for the K8s cluster and bucket
export REGION=us-southeast-1
export HKT_VERSION=v3.18.3
export HYDROLIX_NAMESPACE=hdx-company
#bucket name created previously
export HYDROLIX_DB_BUCKET=hdx-company
EOT

To add the variables to your environment you can use the following command.

source env.sh

If you want to check the environment variables are set.

printenv | sort

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-${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

Create a K8's Namespace

Create a dedicated namespace in your Kubernetes Cluster:

kubectl create namespace $HYDROLIX_NAMESPACE

For ease of use, set your new namespace as a default:

kubectl config set-context --current --namespace="$HYDROLIX_NAMESPACE"

What’s Next

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

Did this page help you?