Installation guide

this guide applies to the on prem/cloud deployment (customer managed) models step 1 infrastructure setup prior to the installation of kubeark, it is important to ensure that the requisite infrastructure is appropriately configured options for this infrastructure include physical machines, virtual machines, or a private cloud solution to host the necessary resources prerequisites resource allocation a minimum of 3 machines need to be configured hw/sw requirements ensure that each machine meets or exceeds the minimum hardware requirements such as cpu, ram, and disk space hardware requirements docid\ tuunhjqlceo zeueo70rp software requirements docid\ ry0afasnfj8xposaf753h network configuration and firewall please follow the recommended setup here network configuration & firewall docid onoomaz65esxrxqoav v step 2 configuration file setup once the necessary infrastructure has been established, the subsequent step involves generating a configuration file this file is a mandatory component in tailoring the kubeark installation process to align with your organization's requirements create configuration file utilize a text editor to generate a new configuration file, ensuring it is saved with the relevant file extension, such as yaml edit parameters incorporate the requisite settings into the configuration file to reflect the specifications of your operational environment such settings may include machine ip addresses, network configurations, and additional variables integral to the system's proper functioning mandatory parameters optional parameters # sample kubeark configuration file \# general settings name "mykubearkcluster" version "1 0 0" \# networking network type "flannel" podcidr "10 244 0 0/16" servicecidr "10 96 0 0/12" \# master node configurations master nodes \ hostname "master1" ip "192 168 1 101" \ hostname "master2" ip "192 168 1 102" \# worker node configurations worker nodes \ hostname "worker1" ip "192 168 1 201" \ hostname "worker2" ip "192 168 1 202" \# storage storage type "local" path "/var/lib/kubeark" \# custom url (change this to your custom url) custom url "https //mycustom kubeark url" \# additional settings additional settings log level "info" enable metrics true save and copy after customization, save the configuration file then securely copy this file onto each machine in your infrastructure setup step 3 run the installation 3 1 online installation for an online installation of kubeark, you will need to download specific packages and use ssh for secure data transfer and commands the process involves both local and remote operations on your infrastructure nodes receive custom url once your kubeark license is activated, check your email for a message containing your unique custom url this url is specifically generated for your organization specifically generated for your organization and will guide you through the online installation process the url would typically look like this kubeark installer 3 0 0 beta 4566 kubeark installer 3 0 0 beta 4566 set permissions open your terminal and navigate to the directory where the installer binary is saved use the chmod command to set the necessary execution permissions chmod +x kk prepare ssh key ensure you have an ssh key pair to securely communicate with your nodes if not, generate one and then use scp to copy the private key to your first infrastructure node this will be used to comunicate with the other nodes, as alternative you can use user/pass but is not that secure scp / ssh/id ecdsa kubeark\@192 168 x 1 / ssh/id ecdsa transfer configuration and installer use scp to copy the configuration file and installer binary to the target node scp online install yaml kubeark\@192 168 x 1 / scp kk 3 0 0 beta 4566 kubeark\@192 168 x 1 / ssh into the node connect to the first infrastructure node using ssh replace 192 168 xx xx with the ip address of the node you're connecting to ssh kubeark\@192 168 x 1 run the installer execute the installer with the following command this uses the transferred configuration file (e g online install yaml ) and initiates the cluster creation process sudo /kk 3 0 0 beta 4566 create cluster f online install yaml y 3 2 offline (airgapped) installation the offline installation method is intended for environments without internet connectivity unlike the online installation, this method requires you to download the complete installation package image files, which are approximately 5gb in size you'll then run the installation locally on your target infrastructure nodes download required files navigate to the kubeark download page kubeark download page and download the installer and image files e g kk artifact 3 0 0 beta 4566 tar gz this specific download page url will be provided to the customer through an email communication following the license activation set permissions open your terminal and navigate to the directory where the installer binary is saved use the chmod command to set the necessary execution permissions chmod +x kk transfer files to node use a secure method, such as scp , to transfer the downloaded installer and image files to the first infrastructure node scp kk 3 0 0 beta 4566 kubeark\@192 168 x 1 / scp kk artifact 3 0 0 beta 4566 tar gz kubeark\@192 168 x 1 / prepare ssh key ensure you have an ssh key pair to securely communicate with your nodes if not, generate one and then use scp to copy the private key to your first infrastructure node this will be used to comunicate with the other nodes, as alternative you can use user/pass but is not that secure scp / ssh/id ecdsa kubeark\@192 168 x 1 / ssh/id ecdsa initialize the local container registry before running the installer to create your cluster, you'll first initialize a local container registry and populate it with the necessary images these commands also use the kk artifact 3 0 0 beta 4566 tar gz package, which should be located in the same directory as your offline install yaml file sudo /kk 3 0 0 beta 4566 init registry f offline install yaml a kk artifact 3 0 0 beta 4566 tar gz push the artifact images to the registry sudo /kk 3 0 0 beta 4566 artifact image push f offline install yaml a kk artifact 3 0 0 beta 4566 tar gz create the cluster using the local registry and packages sudo /kk 3 0 0 beta 4566 create cluster f offline install yaml a kk artifact 3 0 0 beta 4566 tar gz with packages y step 4 post installation validation after successfully completing the installation of kubeark, please validate that the deployment is operational and configured as expected this step involves accessing the custom kubeark url that you specified earlier in the configuration file (refer to step 2) by doing so, you can verify that the service is accessible and functioning correctly