Skip to content

Commit

Permalink
Document helm values for AWS (#177)
Browse files Browse the repository at this point in the history
  • Loading branch information
@orishavit
orishavit authored Nov 26, 2023
1 parent 699e64b commit b7428fb
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
8 changes: 7 additions & 1 deletion docs/reference/configuration/credentials-operator/helm-chart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
| `global.otterizeCloud.credentials.secretKeyRef.secretKey` | If specified, the key for the clientSecret in a pre-created Kubernetes Secret to be used instead of creating a secret with the value of clientSecret. | `(none)` |
| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` |
| `global.otterizeCloud.apiExtraCAPEMSecret` | The 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)` |

| `global.aws.enabled` | Enable or disable AWS integration | `false` |
| `global.aws.eksClusterNameOverride` | EKS cluster name (overrides auto-detection) | `(none)` |


## SPIRE parameters
Expand All @@ -68,3 +69,8 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------|
| `allowGetAllResources` | 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. | `true` |
| `resources` | Resources of the container | `{}` |

## AWS integration parameters
| Key | Description | Default |
|---------------|----------------------------------------------------------|----------|
| `aws.roleARN` | ARN of the AWS role the operator will use to access AWS. | `(none)` |
8 changes: 7 additions & 1 deletion docs/reference/configuration/intents-operator/helm-chart.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
| `global.podAnnotations` | Annotations to add to all deployed pods. | {} |
| `global.podLabels` | Labels to add to all deployed pods. | {} |
| `global.serviceNameOverrideAnnotationName` | Which annotation to use (in the [service name resolution algorithm](/reference/service-identities#kubernetes-service-identity-resolution)) for setting a pod's service name, if not the default. Use this if you already have annotations on your pods that provide the correct service name. | `intents.otterize.com/service-name` |

| `global.aws.enabled` | Enable or disable AWS integration | `false` |
| `global.aws.eksClusterNameOverride` | EKS cluster name (overrides auto-detection) | `(none)` |

## Operator parameters
| Key | Description | Default |
Expand Down Expand Up @@ -70,3 +71,8 @@ If you would like to deploy it on its own, add the Otterize Helm chart repositor
| Key | Description | Default |
|:-----------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
| `allowGetAllResources` | 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. | `true` |

## AWS integration parameters
| Key | Description | Default |
|---------------|----------------------------------------------------------|----------|
| `aws.roleARN` | ARN of the AWS role the operator will use to access AWS. | `(none)` |
6 changes: 6 additions & 0 deletions docs/reference/configuration/otterize-chart/README.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,12 @@ These parameters are used by multiple charts, and must be kept the same for the
| `global.otterizeCloud.apiAddress` | Overrides Otterize Cloud default API address. | `(none)` |
| `global.otterizeCloud.apiExtraCAPEMSecret` | The 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)` |

## AWS Integration parameters
| Key | Description | Default |
|-------------------------------------|---------------------------------------------|----------|
| `global.aws.enabled` | Enable or disable AWS integration | `false` |
| `global.aws.eksClusterNameOverride` | EKS cluster name (overrides auto-detection) | `(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](https://github.com/otterize/helm-charts/tree/main/intents-operator).
Expand Down

0 comments on commit b7428fb

Please sign in to comment.