Skip to main content

Otterize OSS Helm chart

The Otterize OSS Helm chart is a chart that installs all Otterize components and supporting components together, and configures them to work with each other. For example, it configures the credentials operator to work with the deployed SPIRE server, and the intents operator to get mTLS credentials from the credentials operator.

Parameters

Deployment parameters

KeyDescriptionDefault
deployment.spireWhether or not to deploy spire.true
deployment.credentialsOperatorWhether or not to deploy credentials-operator.true
deployment.intentsOperatorWhether or not to deploy intents-operator.true
deployment.networkMapperWhether or not to deploy network-mapper.true

Global parameters

These parameters are used by multiple charts, and must be kept the same for the correct functioning of the separate components.

KeyDescriptionDefault
global.spiffe.CASubjectThe Subject that CA certificates should use (see below).
global.spiffe.CASubject.countrySPIRE's CA certificates Country value."US"
global.spiffe.CASubject.organizationSPIRE's CA certificates Organization Value."SPIRE"
global.spiffe.trustDomainThe trust domain that SPIRE will use."example.org"
global.spire.serverServiceNameName of the Kubernetes service that will be created for SPIRE-server.
global.allowGetAllResourcesIf defined overrides allowGetAllResources in subcharts. Gives get, list and watch permission to watch on all resources. This is used to resolve service names when pods have owners that are custom resources. When disabled, a limited set of permissions is used that only allows access to built-in Kubernetes resources that deploy Pods and Pods themselves - Deployments, StatefulSets, DaemonSets, ReplicaSets and Services. Resolving may not be able to complete if the owning resource is not one of those.

Cloud parameters

KeyDescriptionDefault
global.otterizeCloud.useCloudToGenerateTLSCredentialsUse Otterize Cloud for certificate management instead of SPIREfalse
global.otterizeCloud.credentials.clientIdClient ID for connecting to Otterize Cloud.(none)
global.otterizeCloud.credentials.clientSecretClient secret for connecting to Otterize Cloud.(none)
global.otterizeCloud.apiAddressOverrides Otterize Cloud default API address.(none)
global.otterizeCloud.apiExtraCAPEMSecretThe name of a secret containing a single CA.pem file for an extra root CA used to connect to Otterize Cloud. The secret should be placed in the same namespace as the Otterize deployment.(none)

Intents operator parameters

All configurable parameters of intents-operator can be configured under the alias intentsOperator. Further information about intents-operator parameters can be found in the intents operator's Helm chart.

KeyDescriptionDefault
intentsOperator.autoGenerateTLSUsingCredentialsOperatorUse credentials-operator to create TLS cert for intents-operator.true
intentsOperator.operator.enableEnforcementIf set to false, enforcement is disabled globally (both for network policies and Kafka ACL). If true, you may use the other flags for more granular enforcement settingstrue
intentsOperator.operator.enableNetworkPolicyCreationWhether the operator should create network policies according to the ClientIntentstrue
intentsOperator.operator.enableKafkaACLCreationWhether the operator should create Kafka ACL rules according to the ClientIntents of type Kafkatrue
intentsOperator.operator.autoCreateNetworkPoliciesForExternalTrafficAutomatically allow external traffic, if a new ClientIntents resource would result in blocking external (internet) traffic and there is an Ingress/Service resource indicating external traffic is expected.true

SPIRE parameters

All configurable parameters of SPIRE can be configured under the alias spire. Further information about SPIRE parameters can be found in SPIRE's Helm chart.

Network mapper parameters

All configurable parameters of the network mapper can be configured under the alias networkMapper. Further information about network mapper parameters can be found in the network mapper's chart.

Resource configuration

ComponentKeyDefault
Intents operatorintentsOperator.operator.resources(none)
Intents operator - watcherintentsOperator.watcher.resources(none)
SPIRE Serverspire.server.resources(none)
SPIRE Agentspire.agent.resources(none)
credentials operatorcredentialsOperator.resources(none)