Kubernetes installation

This guide provides a detailed walkthrough for setting up an UltiHash cluster in a Kubernetes environment, whether on-premises or in a cloud environment. The process is divided into four main steps:

1. Prerequisites: Gather the necessary credentials, tools, and environment configurations.

2. Cluster setup: Configure your Kubernetes cluster, including creating namespaces and provisioning secrets.

3. Helm installation: Deploy UltiHash using Helm, customizing the setup for your specific environment.

4. Post-installation: Verify the installation.

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 and registry_password).

  • Customer ID (referred to as customer_id).

  • Access token (referred to as access_token).

  • Monitoring token (referred to as monitoring_token).

• Kubernetes cluster:

  • Version: Ensure you have a Kubernetes cluster running version 1.20 or higher.

  • Controllers:

    • Ingress controller: Exposes the UltiHash cluster API endpoint outside the Kubernetes cluster.

    • CSI controller: Manages persistent volumes.

  • Note: You can use any Kubernetes version starting from 1.20, and any CSI controller that dynamically provisions and attaches persistent volumes. For optimal performance, use a CSI controller that imposes the least disk performance degradation.

• Local environment:

  • kubectl: Ensure Kubernetes command line tool kubectl is installed and configured to access the cluster.

  • Helm: Install Kubernetes package manager Helm (version 3.x) to manage Kubernetes packages.

Step 2: Cluster setup

1. Namespace creation:

   • Create a Kubernetes namespace for the UltiHash installation:

     kubectl create ns <namespace>
     

   • Replace <namespace> with your desired namespace name.

2. Secrets provisioning:

   • Registry credentials: Provision a secret in Kubernetes to store the UltiHash registry credentials:

     kubectl create secret docker-registry registry-credentials -n <namespace> --docker-server='registry.ultihash.io' --docker-username='<registry_login>' --docker-password='<registry_password>'
     

   • Replace <namespace> with the namespace name. Replace <registry_login>, and <registry_password> with the appropriate values obtained from your dashboard on the UltiHash website.
   • Ultihash credentials and monitoring token: Create a secret in Kubernetes for the license key and monitoring token:

     kubectl create secret generic ultihash -n <namespace> --from-literal=customer_id='<customer_id>' --from-literal=access_token='<access_token>' --from-literal=token='<monitoring_token>'
     

   • Replace <namespace> with the namespace name. Replace <customer_id>,<access_token>, and <monitoring_token> with the corresponding values found on your UltiHash dashboard.

Step 3: Helm installation

1. Helm chart deployment:

   • Deploy the Helm chart with a specific release name and namespace:

     helm install <release_name> oci://registry.ultihash.io/stable/ultihash-cluster -n <namespace> --values values.yaml --wait
     

   • Replace <release_name> and namespace with your chosen names. values.yaml should be configured as described below.

2. Component configuration:

   • Customize the values.yaml file with the necessary configurations:

     • Storage class: Specify the storage class name created by your CSI controller.

     • Domain name: Enter a valid domain name for your UltiHash cluster.

     • Service replicas and storage size: Adjust the number of replicas and storage size for services like etcd, entrypoint, storage, and deduplicator based on your requirements.

       global:                           
         logLevel: INFO                  # Default log level for all UltiHash services. Valid values are DEBUG, INFO, WARN, ERROR, or FATAL
         telemetryExportInterval: 30000  # Export interval for UltiHash services telemetry (in milliseconds). Could be overriden individually for each UltiHash service
       
       etcd:
         replicaCount: <number_of_replicas>
         persistence:
           storageClass: <storage_class>
       
       database:
         primary:
           persistence:
             storageClass: <storage_class>
             size: <storage_size>
       
       entrypoint:
         replicas: <number_of_replicas>
         ingress:
           host: <domain_name>  # FQDN to expose the entrypoint outside the cluster
       
       storage:
         replicas: <number_of_replicas>
         storageClass: <storage_class>
         storageSize: <storage_size>
       
       deduplicator:
         replicas: <number_of_replicas>
         storageClass: <storage_class>
         storageSize: <storage_size>
       
       exporter:
         enabled: true
       

Step 4: Post-installation

1. Verification:

   • After deployment, verify that all services are running correctly by checking the Kubernetes namespace:

     kubectl get all -n <namespace>

     Replace <namespace> with the namespace where UltiHash cluster has been deployed.

   • Ensure that all pods are either in the Running or in the Completed state with no errors.

2. Get access to the UltiHash cluster:

   • Obtain the UltiHash root user credentials:

     # Obtain credentials for the UltiHash root user
     aws_access_key_id=`kubectl get secret <release_name>-super-user-credentials -n <namespace> -o jsonpath="{.data.access-key-id}" | base64 --decode`
     aws_secret_access_key=`kubectl get secret <release_name>-super-user-credentials -n <namespace> -o jsonpath="{.data.secret-key}" | base64 --decode`
     
     # Set the credentials for the UltiHash root user
     export AWS_ACCESS_KEY_ID=$aws_access_key_id
     export AWS_SECRET_ACCESS_KEY=$aws_secret_access_key

   • 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:

     aws s3api list-buckets --endpoint-url <cluster-url>

   • Replace <cluster-url> with the appropriate scheme: either https://<domain_name> or http://<domain_name>, depending on whether your entrypoint.ingress object in the Helm values has been configured with or without TLS. The <domain_name> corresponds to the domain name chosen for the UltiHash cluster, as set in the entrypoint.ingress.host object.