The helm chart is hosted on Docker Hub, where you can pull it using Helm.
The Kubernetes Monitor Helm chart follows Semantic Versioning. Generally, version updates can be interpreted as follows:
- major - Breaking changes to the chart. This may include adding or removing of resources, breaking changes in the Kubernetes monitor application image or breaking changes to the structure of the
values.yaml. - minor - New non-breaking features. New features or improvements to the Kubernetes monitor application or helm chart itself.
- patch - Minor non-breaking bug fixes or changes that do not introduce new features.
| Key | Type | Default | Description |
|---|---|---|---|
| global.serverApiUrl | string | "" |
This is overridden by registration.serverApiUrl if both are set |
| global.serverCertificate | string | "" |
This is overridden by registration.serverCertificate if both are set |
| global.serverCertificateSecretName | string | "" |
This is overridden by registration.serverCertificateSecretName if both are set |
| global.targetNamespaces | list | [] |
A list of namespaces that the monitor should monitor. If empty, all namespaces are monitored. |
| Key | Type | Default | Description |
|---|---|---|---|
| monitor.authenticationToken | string | "" |
If setting up the agent without automatic registration, this is the authentication token. If you provide this, you must also provide the installation ID. If you provide this, the monitor will not attempt to register with the server. |
| monitor.clusterScopedResources | bool | false |
Include cluster-scoped resources (Nodes, Namespaces, PVs, etc.) in monitoring. Only effective when global.targetNamespaces is set. When false (default), the monitor only watches namespace-scoped resources. When true, the chart auto-creates a ClusterRole and ClusterRoleBinding granting read access to all resources, replacing the per-namespace Roles. |
| monitor.containers.monitor.env | list | [] |
Additional env to apply to the monitor container - does not override any other configuration |
| monitor.containers.monitor.spec | object | {} |
Additional container spec to apply to the monitor container - does not override any other configuration |
| monitor.customCaCertificate | string | "" |
A base64 encoded string of the custom CA certificate to use to verify the Octopus Deploy server |
| monitor.installationId | string | "" |
If setting up the agent without automatic registration, this is the installation id. If you provide this, you must also provide the authentication token. If you provide this, the monitor will not attempt to register with the server. |
| monitor.serverGrpcUrl | string | "" |
The gRPC url (including the port) of the Octopus Deploy server to communicate with |
| monitor.serverThumbprint | string | "" |
The thumbprint of the Octopus Deploy server the monitor is communicating with. This should only be used if you wish to pin the certificate. |
| monitor.spec | object | {} |
Additional pod spec to apply to the monitor pod - does not override any other configuration |
| Key | Type | Default | Description |
|---|---|---|---|
| registration.configurationStoreType | string | "kubernetes" |
Can be "kubernetes" or "file" |
| registration.containers.registration.env | list | [] |
Additional env to apply to the registration container - does not override any other configuration |
| registration.containers.registration.spec | object | {} |
Additional container spec to apply to the registration container - does not override any other configuration |
| registration.machineName | string | "" |
The machine name of the agent this monitor is responsible for |
| registration.register | bool | true |
Automatically register the monitor with the Octopus Deploy server |
| registration.serverAccessToken | string | "" |
The access token to authenticate to Octopus Deploy to register with. Can be a bearer token or an API token. |
| registration.serverAccessTokenSecretKey | string | "SERVER_ACCESS_TOKEN" |
The key in the existing secret that contains the server access token. Defaults to SERVER_ACCESS_TOKEN. |
| registration.serverAccessTokenSecretName | string | "" |
The name of an existing secret containing the server access token. If specified, the registration secret will not be created. |
| registration.serverApiUrl | string | "" |
The API URL of Octopus Deploy for registration |
| registration.serverCertificate | string | "" |
The base64-encoded public key of the self-signed x509 certificate or root CA certificate used by the target Octopus Server. Must be in the PEM/CER format. |
| registration.serverCertificateSecretName | string | "" |
The name of a secret containing the base64-encoded public key of the self-signed x509 certificate or root CA certificate used by the target Octopus Server. Must be in the PEM/CER format. Value must be set in data.octopus-server-certificate.pem in secret. |
| registration.serviceAccount.annotations | object | {} |
Additional annotations for the service account |
| registration.serviceAccount.automountServiceAccountToken | bool | true |
Auto-mount service account token |
| registration.serviceAccount.create | bool | true |
Specifies whether a service account should be created for the registration hook |
| registration.serviceAccount.name | string | "" |
Custom service account name |
| registration.serviceAccount.projectedVolumeDefaultMode | int | 292 |
Default file mode for projected volume (only used when automountServiceAccountToken is false) Uses octal notation. Default: 0444 |
| registration.spaceId | string | "" |
The space id that the monitor is registering with |
| registration.spec | object | {} |
Additional pod spec to apply to the registration pod - does not override any other configuration |
| Key | Type | Default | Description |
|---|---|---|---|
| affinity | object | {} |
Custom affinity for kubernetes monitor pods |
| fullnameOverride | string | "" |
Override for the fully qualified app name for generated resources |
| image.pullPolicy | string | "IfNotPresent" |
Image pull policy |
| image.registry | string | "docker.io" |
Registry host to pull images from |
| image.repository | string | "octopusdeploy/kubernetes-monitor" |
Image name to use |
| image.tag | string | .Chart.AppVersion |
Image tag to use |
| image.tagSuffix | string | "" |
|
| imagePullSecrets | list | [] |
Optional array of imagePullSecrets containing private registry credentials Ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ |
| nameOverride | string | "" |
Override for the short name for generated resources |
| nodeSelector | object | {} |
Custom node selector for kubernetes monitor pods |
| podAnnotations | object | {} |
Annotations to be added to kubernetes monitor pods |
| podLabels | object | {} |
Labels to be added to kubernetes monitor pods |
| podSecurityContext | object | {} |
Security context for kubernetes monitor pods |
| resources | string | nil |
Resources to allocate for the kubernetes monitor pod |
| securityContext | object | {} |
Security context for kubernetes monitor containers |
| serviceAccount.annotations | object | {} |
Additional annotations for the service account |
| serviceAccount.automountServiceAccountToken | bool | true |
Auto-mount service account token or not |
| serviceAccount.create | bool | true |
Specifies whether a service account should be created |
| serviceAccount.name | string | "" |
Custom service account name |
| serviceAccount.projectedVolumeDefaultMode | int | 292 |
Default file mode for projected volume (only used when automountServiceAccountToken is false) Uses octal notation. Default: 0444 |
| tolerations | list | [] |
Custom tolerations for kubernetes monitor pods |
Autogenerated from chart metadata using helm-docs