diff --git a/docs/features/istio/reference.mdx b/docs/features/istio/reference.mdx index edf4247bb..7df5d9741 100644 --- a/docs/features/istio/reference.mdx +++ b/docs/features/istio/reference.mdx @@ -25,14 +25,14 @@ spec: ### Helm Chart options -| Key | Description | Default | -|---------------------------------|-----------------------------------------|--------------------------------| -| `istiowatcher.enable` | Enable Istio watcher deployment (beta). | `false` | -| `istiowatcher.image.repository` | Istio watcher image repository. | `otterize` | -| `istiowatcher.image.image` | Istio watcher image. | `network-mapper-istio-watcher` | -| `istiowatcher.image.tag` | Istio watcher image tag. | `latest` | -| `istiowatcher.pullPolicy` | Istio watcher pull policy. | `(none)` | -| `istiowatcher.pullSecrets` | Istio watcher pull secrets. | `(none)` | -| `istiowatcher.resources` | Resources override. | `(none)` | +| Key | Description | Default | +|----------------------------|-----------------------------------------|--------------------------------| +| `istiowatcher.enable` | Enable Istio watcher deployment (beta). | `false` | +| `istiowatcher.repository` | Istio watcher image repository. | `otterize` | +| `istiowatcher.image` | Istio watcher image. | `network-mapper-istio-watcher` | +| `istiowatcher.tag` | Istio watcher image tag. | `(pinned to latest version as of this Helm chart version's publish)` | +| `istiowatcher.pullPolicy` | Istio watcher pull policy. | `(none)` | +| `istiowatcher.pullSecrets` | Istio watcher pull secrets. | `(none)` | +| `istiowatcher.resources` | Resources override. | `(none)` | View the [Helm chart reference](/reference/configuration/otterize-chart) for all other options \ No newline at end of file diff --git a/docs/features/kafka/reference.mdx b/docs/features/kafka/reference.mdx index a2f704193..cadbf8bcf 100644 --- a/docs/features/kafka/reference.mdx +++ b/docs/features/kafka/reference.mdx @@ -46,15 +46,15 @@ spec: ### Helm Chart options -| Key | Description | Default | -|---------------------------------|-------------------------------------------------------------|--------------------------------| -| `kafkawatcher.enable` | Enable Kafka watcher deployment (beta). | `false` | -| `kafkawatcher.image.repository` | Kafka watcher image repository. | `otterize` | -| `kafkawatcher.image.image` | Kafka watcher image. | `network-mapper-kafka-watcher` | -| `kafkawatcher.image.tag` | Kafka watcher image tag. | `latest` | -| `kafkawatcher.pullPolicy` | Kafka watcher pull policy. | `(none)` | -| `kafkawatcher.pullSecrets` | Kafka watcher pull secrets. | `(none)` | -| `kafkawatcher.resources` | Resources override. | `(none)` | -| `kafkawatcher.kafkaServers` | Kafka servers to watch, specified as `pod.namespace` items. | `(none)` | +| Key | Description | Default | +|-----------------------------|-------------------------------------------------------------|--------------------------------| +| `kafkawatcher.enable` | Enable Kafka watcher deployment (beta). | `false` | +| `kafkawatcher.repository` | Kafka watcher image repository. | `otterize` | +| `kafkawatcher.image` | Kafka watcher image. | `network-mapper-kafka-watcher` | +| `kafkawatcher.tag` | Kafka watcher image tag. | `(pinned to latest version as of this Helm chart version's publish)` | +| `kafkawatcher.pullPolicy` | Kafka watcher pull policy. | `(none)` | +| `kafkawatcher.pullSecrets` | Kafka watcher pull secrets. | `(none)` | +| `kafkawatcher.resources` | Resources override. | `(none)` | +| `kafkawatcher.kafkaServers` | Kafka servers to watch, specified as `pod.namespace` items. | `(none)` | View the [Helm chart reference](/reference/configuration/otterize-chart) for all other options \ No newline at end of file diff --git a/docs/reference/configuration/credentials-operator/helm-chart.mdx b/docs/reference/configuration/credentials-operator/helm-chart.mdx index d9f7e0e60..ec1f09231 100644 --- a/docs/reference/configuration/credentials-operator/helm-chart.mdx +++ b/docs/reference/configuration/credentials-operator/helm-chart.mdx @@ -37,12 +37,12 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor ## Operator parameters -| Key | Description | Default | -|-----------------------------|----------------------------|------------------------------| -| `operator.image.repository` | Operator image repository. | `otterize` | -| `operator.image.image` | Operator image. | `credentials-operator` | -| `operator.image.tag` | Operator image tag. | `latest` | -| `operator.pullPolicy` | Operator pull policy. | `(none)` | +| Key | Description | Default | +|-----------------------|----------------------------|------------------------| +| `operator.repository` | Operator image repository. | `otterize` | +| `operator.image` | Operator image. | `credentials-operator` | +| `operator.tag` | Operator image tag. | `(pinned to latest version as of this Helm chart version's publish)` | +| `operator.pullPolicy` | Operator pull policy. | `(none)` | ## Cloud parameters diff --git a/docs/reference/configuration/intents-operator/helm-chart.mdx b/docs/reference/configuration/intents-operator/helm-chart.mdx index 21f6bdb28..1e6faf410 100644 --- a/docs/reference/configuration/intents-operator/helm-chart.mdx +++ b/docs/reference/configuration/intents-operator/helm-chart.mdx @@ -32,9 +32,9 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor ## Operator parameters | Key | Description | Default | |---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| -| `operator.image.repository` | Intents Operator image repository. | `otterize` | -| `operator.image.image` | Intents Operator image. | `intents-operator` | -| `operator.image.tag` | Intents Operator image tag. | `latest` | +| `operator.repository` | Intents Operator image repository. | `otterize` | +| `operator.image` | Intents Operator image. | `intents-operator` | +| `operator.tag` | Intents Operator image tag. | `(pinned to latest version as of this Helm chart version's publish)` | | `operator.pullPolicy` | Intents Operator image pull policy. | `(none)` | | `operator.autoGenerateTLSUsingCredentialsOperator` | If set to true, adds the necessary pod annotations in order to integrate with credentials-operator, and gets the TLS certificate. | `false` | | `operator.mode` | `defaultActive` or `defaultShadow`.
When `defaultActive` is set, enforcement is enabled by default.
When `defaultShadow` is set, enforcement is disabled by default, but can be enabled per-service using a `ProtectedService` resource. | `defaultActive` | diff --git a/docs/reference/configuration/network-mapper/helm-chart.mdx b/docs/reference/configuration/network-mapper/helm-chart.mdx index 3a9ac28a0..292237c5e 100644 --- a/docs/reference/configuration/network-mapper/helm-chart.mdx +++ b/docs/reference/configuration/network-mapper/helm-chart.mdx @@ -15,9 +15,9 @@ Checkout the network mapper [tutorial](/features/network-mapping-network-policie ## Mapper parameters | Key | Description | Default | |--------------------------------|-------------------------------------------------------------------------------------------------|------------------| -| `mapper.image.repository` | Mapper image repository. | `otterize` | -| `mapper.image.image` | Mapper image. | `network-mapper` | -| `mapper.image.tag` | Mapper image tag. | `latest` | +| `mapper.repository` | Mapper image repository. | `otterize` | +| `mapper.image` | Mapper image. | `network-mapper` | +| `mapper.tag` | Mapper image tag. | `(pinned to latest version as of this Helm chart version's publish)` | | `mapper.pullPolicy` | Mapper pull policy. | `(none)` | | `mapper.resources` | Resources override. | `(none)` | | `mapper.uploadIntervalSeconds` | Interval for uploading data to cloud | `60` | @@ -38,9 +38,9 @@ Checkout the network mapper [tutorial](/features/network-mapping-network-policie ## Sniffer parameters | Key | Description | Default | |-----------------------------|---------------------------|--------------------------| -| `sniffer.image.repository` | Sniffer image repository. | `otterize` | -| `sniffer.image.image` | Sniffer image. | `network-mapper-sniffer` | -| `sniffer.image.tag` | Sniffer image tag. | `latest` | +| `sniffer.repository` | Sniffer image repository. | `otterize` | +| `sniffer.image` | Sniffer image. | `network-mapper-sniffer` | +| `sniffer.tag` | Sniffer image tag. | `(pinned to latest version as of this Helm chart version's publish)` | | `sniffer.pullPolicy` | Sniffer pull policy. | `(none)` | | `sniffer.resources` | Resources override. | `(none)` | | `sniffer.tolerations` | Tolerations override. | `(none)` | @@ -51,9 +51,9 @@ Checkout the network mapper [tutorial](/features/network-mapping-network-policie | Key | Description | Default | |---------------------------------|-------------------------------------------------------------|--------------------------------| | `kafkawatcher.enable` | Enable Kafka watcher deployment (beta). | `false` | -| `kafkawatcher.image.repository` | Kafka watcher image repository. | `otterize` | -| `kafkawatcher.image.image` | Kafka watcher image. | `network-mapper-kafka-watcher` | -| `kafkawatcher.image.tag` | Kafka watcher image tag. | `latest` | +| `kafkawatcher.repository` | Kafka watcher image repository. | `otterize` | +| `kafkawatcher.image` | Kafka watcher image. | `network-mapper-kafka-watcher` | +| `kafkawatcher.tag` | Kafka watcher image tag. | `(pinned to latest version as of this Helm chart version's publish)` | | `kafkawatcher.pullPolicy` | Kafka watcher pull policy. | `(none)` | | `kafkawatcher.pullSecrets` | Kafka watcher pull secrets. | `(none)` | | `kafkawatcher.resources` | Resources override. | `(none)` | @@ -63,9 +63,9 @@ Checkout the network mapper [tutorial](/features/network-mapping-network-policie | Key | Description | Default | |---------------------------------|-----------------------------------------|--------------------------------| | `istiowatcher.enable` | Enable Istio watcher deployment (beta). | `false` | -| `istiowatcher.image.repository` | Istio watcher image repository. | `otterize` | -| `istiowatcher.image.image` | Istio watcher image. | `network-mapper-istio-watcher` | -| `istiowatcher.image.tag` | Istio watcher image tag. | `latest` | +| `istiowatcher.repository` | Istio watcher image repository. | `otterize` | +| `istiowatcher.image` | Istio watcher image. | `network-mapper-istio-watcher` | +| `istiowatcher.tag` | Istio watcher image tag. | `(pinned to latest version as of this Helm chart version's publish)` | | `istiowatcher.pullPolicy` | Istio watcher pull policy. | `(none)` | | `istiowatcher.pullSecrets` | Istio watcher pull secrets. | `(none)` | | `istiowatcher.resources` | Resources override. | `(none)` | diff --git a/docs/reference/configuration/network-mapper/kafka-watcher.mdx b/docs/reference/configuration/network-mapper/kafka-watcher.mdx index 5161d9246..bdb29e25d 100644 --- a/docs/reference/configuration/network-mapper/kafka-watcher.mdx +++ b/docs/reference/configuration/network-mapper/kafka-watcher.mdx @@ -13,16 +13,16 @@ Make sure to include `--set kafkaServers={}` and provide a list of Kafka servers Servers in the list should be specified as `name.namespace`. ## Kafka watcher parameters -| Key | Description | Default | -|---------------------------------|-------------------------------------------------------------|--------------------------------| -| `kafkawatcher.enable` | Enable Kafka watcher deployment (beta). | `false` | -| `kafkawatcher.image.repository` | Kafka watcher image repository. | `otterize` | -| `kafkawatcher.image.image` | Kafka watcher image. | `network-mapper-kafka-watcher` | -| `kafkawatcher.image.tag` | Kafka watcher image tag. | `latest` | -| `kafkawatcher.pullPolicy` | Kafka watcher pull policy. | `(none)` | -| `kafkawatcher.pullSecrets` | Kafka watcher pull secrets. | `(none)` | -| `kafkawatcher.resources` | Resources override. | `(none)` | -| `kafkawatcher.kafkaServers` | Kafka servers to watch, specified as `pod.namespace` items. | `(none)` | +| Key | Description | Default | +|-----------------------------|-------------------------------------------------------------|--------------------------------| +| `kafkawatcher.enable` | Enable Kafka watcher deployment (beta). | `false` | +| `kafkawatcher.repository` | Kafka watcher image repository. | `otterize` | +| `kafkawatcher.image` | Kafka watcher image. | `network-mapper-kafka-watcher` | +| `kafkawatcher.tag` | Kafka watcher image tag. | `(pinned to latest version as of this Helm chart version's publish)` | +| `kafkawatcher.pullPolicy` | Kafka watcher pull policy. | `(none)` | +| `kafkawatcher.pullSecrets` | Kafka watcher pull secrets. | `(none)` | +| `kafkawatcher.resources` | Resources override. | `(none)` | +| `kafkawatcher.kafkaServers` | Kafka servers to watch, specified as `pod.namespace` items. | `(none)` | ## Enabling debug logs in Kafka servers The Kafka watcher periodically examines logs of Kafka servers provided by the user through configuration, diff --git a/docs/reference/configuration/otterize-chart/README.mdx b/docs/reference/configuration/otterize-chart/README.mdx index f2b29335d..2854c9d60 100644 --- a/docs/reference/configuration/otterize-chart/README.mdx +++ b/docs/reference/configuration/otterize-chart/README.mdx @@ -57,12 +57,12 @@ These parameters are used by multiple charts, and must be kept the same for the 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](https://github.com/otterize/helm-charts/tree/main/intents-operator). -## Operator parameters +## Intents Operator parameters | Key | Description | Default | |-------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------| -| `intentsOperator.operator.image.repository` | Intents Operator image repository. | `otterize` | -| `intentsOperator.operator.image.image` | Intents Operator image. | `intents-operator` | -| `intentsOperator.operator.image.tag` | Intents Operator image tag. | `latest` | +| `intentsOperator.operator.repository` | Intents Operator image repository. | `otterize` | +| `intentsOperator.operator.image` | Intents Operator image. | `intents-operator` | +| `intentsOperator.operator.tag` | Intents Operator image tag. | `(pinned to latest version as of this Helm chart version's publish)` | | `intentsOperator.operator.pullPolicy` | Intents Operator image pull policy. | `(none)` | | `intentsOperator.operator.autoGenerateTLSUsingCredentialsOperator` | If set to true, adds the necessary pod annotations in order to integrate with credentials-operator, and gets the TLS certificate. | `false` | | `intentsOperator.operator.mode` | `defaultActive` or `defaultShadow`.
When `defaultActive` is set, enforcement is enabled by default.
When `defaultShadow` is set, enforcement is disabled by default, but can be enabled per-service using a `ProtectedService` resource. | `defaultActive` |