Skip to main content

Installation

Install Otterize without Otterize Cloud (OSS only)​

include file not found: ../../_common/install-otterize.md --> /home/runner/work/docs/docs/_common/install-otterize.md

If you are installing Otterize for network policies, make sure your cluster supports network policies.
Expand to see how.

Before you start, you need to have a Kubernetes cluster with a CNI that supports NetworkPolicies.

include file not found: ../../_common/../cluster-setup.md --> /home/runner/work/docs/docs/cluster-setup.md

Upgrade Otterize​

include file not found: ../../_common/upgrade-otterize.md --> /home/runner/work/docs/docs/_common/upgrade-otterize.md

Connect Otterize OSS to Otterize Cloud, or install Otterize with Otterize Cloud​

To connect Otterize OSS to Otterize Cloud you will need to login, create a cluster, and follow the instructions.

In a nutshell, you need to helm upgrade the same Helm chart, but provide Otterize Cloud credentials. Upon creating a cluster, a guide will appear that walks you through doing this with the new credentials jut created.

Install just the Otterize network mapper​

include file not found: ../../_common/install-otterize-network-mapper.md --> /home/runner/work/docs/docs/_common/install-otterize-network-mapper.md

Install the Otterize CLI​

The Otterize CLI is a command-line utility used to control and interact with the Otterize network mapper, manipulate local intents files, and interact with Otterize Cloud.

To install the CLI:

include file not found: ../../_common/install-otterize-cli.md --> /home/runner/work/docs/docs/_common/install-otterize-cli.md

Uninstall Otterize​

Before uninstalling​

Before uninstalling Otterize, you should make sure to delete any resources created by users: ClientIntents and KafkaServerConfigs.

When you remove these resources, the intents operator will clean up network policies and Kafka ACLs it created. If you remove the operator before doing so, it will not be able to clean up.

If, however, you want the network policies and ACLs to stay in place (because you're redeploying with different configuration, for example), don't remove them.

  1. First check if any ClientIntents exist: kubectl get clientintents --all-namespaces
  2. If so, remove them.
  3. Check if any KafkaServerConfigs exist: kubectl get kafkaserverconfig --all-namespaces
  4. If so, remove them.

It's important to remove ClientIntents before removing KafkaServerConfigs, as once you remove the KafkaServerConfig for a Kafka cluster, the intents operator will no longer know how to connect to it and perform cleanup.

Uninstallation​

helm uninstall otterize -n otterize-system