|
| 1 | +[](https://opensource.newrelic.com/oss-category/#community-plus) |
| 2 | + |
| 3 | +# agent-control-deployment |
| 4 | + |
| 5 | +A Helm chart to install New Relic Agent Control on Kubernetes |
| 6 | + |
| 7 | +# Helm installation |
| 8 | + |
| 9 | +This chart is not intended to be installed on its own. Instead, it is designed to be installed as part of the [agent-control](https://github.com/newrelic/helm-charts/tree/master/charts/agent-control) chart. |
| 10 | + |
| 11 | +## Values managed globally |
| 12 | + |
| 13 | +This chart implements the [New Relic's common Helm library](https://github.com/newrelic/helm-charts/tree/master/library/common-library) which |
| 14 | +means that it honors a wide range of defaults and globals common to most New Relic Helm charts. |
| 15 | + |
| 16 | +Options that can be defined globally include `affinity`, `nodeSelector`, `tolerations`, `proxy` and others. The full list can be found at |
| 17 | +[user's guide of the common library](https://github.com/newrelic/helm-charts/blob/master/library/common-library/README.md). |
| 18 | + |
| 19 | +## Values |
| 20 | + |
| 21 | +| Key | Type | Default | Description | |
| 22 | +|-----|------|---------|-------------| |
| 23 | +| affinity | object | `{}` | Sets pod/node affinities. Can be configured also with `global.affinity` | |
| 24 | +| cluster | string | `""` | Name of the Kubernetes cluster monitored. Can be configured also with `global.cluster`. | |
| 25 | +| config.agentControl | object | See `values.yaml` | Configuration for the Agent Control. | |
| 26 | +| config.agentControl.content | object | `{}` | Overrides the configuration that has been created automatically by the chart. This configuration here will be **MERGED** with the configuration specified above. If you need to have you own configuration, disabled the creation of this configMap and create your own. | |
| 27 | +| config.agentControl.create | bool | `true` | Set if the configMap is going to be created by this chart or the user will provide its own. | |
| 28 | +| config.fleet_control.auth.organizationId | string | `""` | Organization ID where fleets will live. | |
| 29 | +| config.fleet_control.auth.secret.client_id.base64 | string | `nil` | In case `.config.auth.secret.create` is true, you can set these keys to set client ID directly as base64 if you want to skip its creation. This options is mutually exclusive with `plain`. | |
| 30 | +| config.fleet_control.auth.secret.client_id.plain | string | `nil` | In case `.config.auth.secret.create` is true, you can set these keys to set client ID directly as plain text if you want to skip its creation. This options is mutually exclusive with `base64`. | |
| 31 | +| config.fleet_control.auth.secret.client_id.secret_key | string | `client_id` | Key inside the secret containing the client ID. | |
| 32 | +| config.fleet_control.auth.secret.create | bool | `true` | | |
| 33 | +| config.fleet_control.auth.secret.name | string | release name suffixed with "-auth" | Name auth' secret provided by the user. If the creation of this secret is set to `true`, this is the same the secret will have. | |
| 34 | +| config.fleet_control.auth.secret.private_key.base64_pem | string | `nil` | In case `.config.auth.secret.create` is true, you can set these keys to set private key directly as base64 if you want to skip its creation. This options is mutually exclusive with `plain_pem`. | |
| 35 | +| config.fleet_control.auth.secret.private_key.plain_pem | string | `nil` | In case `.config.auth.secret.create` is true, you can set these keys to set private key directly as plain text if you want to skip its creation. This options is mutually exclusive with `base64_pem`. | |
| 36 | +| config.fleet_control.auth.secret.private_key.secret_key | string | `private_key` | Key inside the secret containing the private key. | |
| 37 | +| config.fleet_control.enabled | bool | `true` | Enables or disables the auth against fleet control. It implies to disable any fleet communication and running the agent in stand alone mode where only the agents specified on `.config.subAgents` will be launched. | |
| 38 | +| config.fleet_control.fleet_id | string | `""` | Specify a fleet_id to automatically connect the Agent Control to an existing fleet. | |
| 39 | +| config.status_server.port | int | See `values.yaml` | Set the status server port | |
| 40 | +| config.subAgents | string | `{}` (See `values.yaml`) | List of managed agents that will be deployed. The key represents the name of the agent and the value holds the configuration. | |
| 41 | +| containerSecurityContext | object | `{}` | Sets security context (at container level). Can be configured also with `global.containerSecurityContext` | |
| 42 | +| customIdentityClientIdSecretKey | string | `""` | | |
| 43 | +| customIdentityClientSecretSecretKey | string | `""` | | |
| 44 | +| customIdentitySecretName | string | `""` | In case you don't want to have the client_id and client_secret in your values, this allows you to point to a user created secret to get the key from there. | |
| 45 | +| customSecretLicenseKey | string | `""` | In case you don't want to have the license key in you values, this allows you to point to which secret key is the license key located. Can be configured also with `global.customSecretLicenseKey` | |
| 46 | +| customSecretName | string | `""` | In case you don't want to have the license key in you values, this allows you to point to a user created secret to get the key from there. Can be configured also with `global.customSecretName` | |
| 47 | +| dnsConfig | object | `{}` | Sets pod's dnsConfig. Can be configured also with `global.dnsConfig` | |
| 48 | +| extraEnv | list | `[]` | Add user environment variables to the agent | |
| 49 | +| extraEnvFrom | list | `[]` | Add user environment from configMaps or secrets as variables to the agent | |
| 50 | +| extraVolumeMounts | list | `[]` | Defines where to mount volumes specified with `extraVolumes` | |
| 51 | +| extraVolumes | list | `[]` | Volumes to mount in the containers | |
| 52 | +| hostNetwork | bool | `false` | Sets pod's hostNetwork. Can be configured also with `global.hostNetwork` | |
| 53 | +| identityClientId | string | `""` | Identity client_id to use. | |
| 54 | +| identityClientSecret | string | `""` | Identity client_secret to use. | |
| 55 | +| image | object | See `values.yaml` | Image for the New Relic Agent Control | |
| 56 | +| image.pullSecrets | list | `[]` | The secrets that are needed to pull images from a custom registry. | |
| 57 | +| labels | object | `{}` | Additional labels for chart objects. Can be configured also with `global.labels` | |
| 58 | +| licenseKey | string | `""` | This set this license key to use. Can be configured also with `global.licenseKey` | |
| 59 | +| nameOverride | string | See `values.yaml` | Override the name of the chart used to template resource names. | |
| 60 | +| nodeSelector | object | `{}` | Sets pod's node selector. Can be configured also with `global.nodeSelector` | |
| 61 | +| nrStaging | bool | `false` | Send the metrics to the staging backend. Requires a valid staging license key. Can be configured also with `global.nrStaging` | |
| 62 | +| podAnnotations | object | `{}` | Annotations to be added to all pods created by the integration. | |
| 63 | +| podLabels | object | `{}` | Additional labels for chart pods. Can be configured also with `global.podLabels` | |
| 64 | +| podSecurityContext | object | `{}` | Sets security context (at pod level). Can be configured also with `global.podSecurityContext` | |
| 65 | +| priorityClassName | string | `""` | Sets pod's priorityClassName. Can be configured also with `global.priorityClassName` | |
| 66 | +| rbac.create | bool | `true` | Whether the chart should automatically create the RBAC objects required to run. | |
| 67 | +| resources | object | `{}` | Resource limits to be added to all pods created by the integration. | |
| 68 | +| serviceAccount | object | See `values.yaml` | Settings controlling ServiceAccount creation. | |
| 69 | +| serviceAccount.create | bool | `true` | Whether the chart should automatically create the ServiceAccount objects required to run. | |
| 70 | +| systemIdentityRegistration | object | See `values.yaml` | Image for the system identity registration process | |
| 71 | +| tolerations | list | `[]` | Sets pod's tolerations to node taints. Can be configured also with `global.tolerations` | |
| 72 | +| verboseLog | bool | `false` | Sets the debug logs to this integration or all integrations if it is set globally. Can be configured also with `global.verboseLog` | |
| 73 | + |
| 74 | +## Maintainers |
| 75 | + |
| 76 | +* [ac](https://github.com/orgs/newrelic/teams/ac/members) |
0 commit comments