Install from chart

Use Helm to install Otomi.

Visit the helm documentation page for more details on how to work with helm charts.

Before you begin verify if you have met the prerequisites

Add the Otomi repository#

helm repo add otomi https://otomi.io/otomi-core
helm repo update

See helm repo for command documentation.

Create and test the values file#

To view the required values.yaml file with detailed comments, view and download the chart's latest values.yaml. Run the following command to view all the values (which might be overwhelming):

helm show values otomi/otomi

To test wether the input values are correct run the following command:

helm template -f values.yaml otomi/otomi

Install the Chart#

Install the chart with the following command:

helm install -f values.yaml otomi otomi/otomi

Monitoring the Chart install#

The chart deploys a Job (otomi) in the default namespace. Monitor the chart install using kubectl:

# get the status of the job
kubectl get job otomi -w
# watch the helm chart install status:
watch helm list -Aa

Or view detailed info about kubernetes resources with k9s

For more detailed instructions on monitoring and other SRE tasks, visit the SRE section.

Once the chart is installed, you are ready to dive in to the console.

Next steps#

Once Otomi is installed, visit the Post Installation page to finish setting up Otomi.

Installing from source#

As an alternative, you can also clone the otomi-core source code from the Github and install otomi using the chart source code.

Download source#

git clone https://github.com/redkubes/otomi-core.git
cd otomi-core

Install from source#

Now customize the values.yaml file. See configuration below for more details.

Use the following command to install the chart with the name my-otomi-release (a custom name that you choose).

helm install -f values.yaml my-otomi-release chart/otomi

Uninstalling the Chart#

helm uninstall my-otomi-release

Doing a Helm uninstall will only remove the job used to deploy Otomi. It will not remove all the installed components. If you would like to do a complete uninstall, we advise to first clone the otomi/values repository (to secure the configuration) and then uninstall using Otomi CLI.