4. Installation on Minikube
This guide provides a detailed walkthrough for setting up an UltiHash cluster in a Minikube environment. The process is divided into four main steps:
Prerequisites: Gather the necessary credentials, tools, and environment configurations.
Cluster setup: Configure your Minikube environment, including creating namespaces and provisioning secrets.
Helm installation: Deploy UltiHash using Helm, customizing the setup for your specific environment.
Post-installation: Verify the installation.
!!!Warning!!! This setup is intended for testing on local systems / developer hardware and not intended for production use.
Step 1: Prerequisites
Before you begin the installation, ensure you have the following:
UltiHash Account: Sign up at ultihash.io/signup and verify your email.
Credentials: After signing up on the UltiHash website, you will get the following credentials on your dashboard:
Registry login and password (referred to as
registry_login
andregistry_password
).License key (referred to as
license_key
).Monitoring token (referred to as
monitoring_token
).UltiHash ID (unique identifier of an UltiHash customer) - you need it only to upgrade your subscription.
Local environment:
docker: Ensure the Docker engine is installed on your computer.
minikube: Install Minikube to provision a local Kuberentes cluster.
kubectl: Ensure Kubernetes command line tool
kubectl
is installed.Helm: Install Kubernetes package manager Helm (version 3.x) to manage Kubernetes packages.
AWS CLI Install AWS CLI (version 2) to interact with the installed UltiHash cluster
Step 2: Cluster setup
Set up Minikube environment:
Create a local Kubernetes cluster:
Make sure
kubectl
has access to the cluster and the cluster node has been provisioned:The expected output should look like:
Install Nginx Ingress controller:
Namespace creation:
Create a Kubernetes namespace for the UltiHash installation:
Replace
<namespace>
with your desired namespace name.
Secrets provisioning:
Registry credentials: Provision a secret in Kubernetes to store the UltiHash registry credentials:
Replace
<namespace>
with the namespace name. Replace<registry_login>
, and<registry_password>
with the appropriate values obtained from your dashboard on the UltiHash website.License key and monitoring token: Create a secret in Kubernetes for the license key and monitoring token:
Replace
<namespace>
with the namespace name. Replace<license_key>
and<monitoring_token>
with the corresponding values otained from the UltiHash dashboard.
Step 3: Helm installation
Helm chart deployment:
Deploy the Helm chart with a specific release name and namespace:
Replace
<release_name>
andnamespace
with your chosen names.values.yaml
should be configured as described below.
Component configuration:
Customize the
values.yaml
file with the necessary configurations:Service replicas and storage size: Adjust the number of replicas and storage size for services like
etcd
,entrypoint
,database
,storage
, anddeduplicator
based on your requirements.
Step 4: Post-installation
Verification:
After deployment, verify that all services are running correctly by checking the Kubernetes namespace:
Ensure that all pods are either in the
Running
or in theCompleted
state with no errors.
Get access to the UltiHash cluster:
Obtain the UltiHash cluster URL and root user credentials:
Replace
<release-name>
and<namespace>
with the Helm release name and namespace name correspondingly.Use AWS CLI and AWS SDK to interact with the UltiHash cluster:
Last updated