newrelic · paologallinaharbur · Oct 22, 2024
@@ -2,7 +2,7 @@ dependencies:
 - name: flux2
   repository: https://fluxcd-community.github.io/helm-charts
   version: 2.13.0
-- name: super-agent-deployment
+- name: agent-control-deployment
   repository: ""
   version: 0.0.25-beta
 - name: common-library

@@ -1,6 +1,6 @@
 apiVersion: v2
-name: super-agent
-description: Bootstraps New Relic' Super Agent
+name: agent-control
+description: Bootstraps New Relic' Agent Control
 
 type: application
 version: 0.0.22-beta
@@ -10,17 +10,17 @@ dependencies:
     repository: https://fluxcd-community.github.io/helm-charts
     version: 2.13.0
     condition: flux2.enabled
-  - name: super-agent-deployment
+  - name: agent-control-deployment
     version: 0.0.25-beta
-    condition: super-agent-deployment.enabled
-    # The following dependency is needed as sub-dependency of super-agent-deployment
+    condition: agent-control-deployment.enabled
+    # The following dependency is needed as sub-dependency of agent-control-deployment
   - name: common-library
     version: 1.3.0
     repository: https://helm-charts.newrelic.com
 
 keywords:
   - newrelic
-  - super-agent
+  - agent-control
 
 maintainers:
   - name: alvarocabanas

@@ -0,0 +1,104 @@
+[![Community Plus header](https://github.com/newrelic/opensource-website/raw/master/src/images/categories/Community_Plus.png)](https://opensource.newrelic.com/oss-category/#community-plus)
+
+# agent-control
+
+Bootstraps New Relic' Agent Control
+
+# Helm installation
+
+You can install this chart using directly this Helm repository:
+
+```shell
+helm repo add newrelic https://helm-charts.newrelic.com
+helm upgrade --install agent-control newrelic/agent-control -f your-custom-values.yaml
+```
+
+## Values managed globally
+
+This chart implements the [New Relic's common Helm library](https://github.com/newrelic/helm-charts/tree/master/library/common-library) which
+means that it honors a wide range of defaults and globals common to most New Relic Helm charts.
+
+> **Warning**: Note that the flux chart is not maintained by New Relic and thus does not support the `common-library`. Everything under the
+`flux2` belongs to the upstream chart and does not honor the [New Relic's common Helm library](https://github.com/newrelic/helm-charts/tree/master/library/common-library).
+>
+> For a complete list of `values.yaml` of this chart you can refer to the [upstream chart's `values.yaml`](https://github.com/fluxcd-community/helm-charts/blob/flux2-2.10.2/charts/flux2/values.yaml).
+
+Options that can be defined globally include `affinity`, `nodeSelector`, `tolerations`, `proxy` and others. The full list can be found at
+[user's guide of the common library](https://github.com/newrelic/helm-charts/blob/master/library/common-library/README.md).
+
+## Chart particularities
+
+> **TODO:** Here is where you should add particularities for this chart like what does the chart do with the privileged and
+low data modes or any other quirk that it could have.
+
+As of the creation of the chart, it has no particularities and this section can be removed safely.
+
+## Values
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| flux2 | object | See `values.yaml` | Values for the Flux chat. Ref.: https://github.com/fluxcd-community/helm-charts/blob/flux2-2.10.2/charts/flux2/values.yaml |
+| flux2.clusterDomain | string | `"cluster.local"` | This is the domain name of the cluster. |
+| flux2.enabled | bool | `true` | Enable or disable FluxCD installation. New Relic' Agent Control need Flux to work, but the user can use an already existing Flux deployment. With that use case, the use can disable Flux and use this chart to only install the CRs to deploy the Agent Control. |
+| flux2.helmController | object | Enabled | Helm controller is a Kubernetes operator that allows to declaratively manage Helm chart releases with Kubernetes manifests. The Helm release is defined in a CR ([Custom Resource](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#custom-resources)) named `HelmRelease` that the operator will reconcile on the apply, edit, or deletion of a `HelmRelease` resource.  New Relic' Agent Control will use this controller by creating `HelmRelease` CRs based in the configuration stored on OpAmp. This is the only controller that the Agent Control need for now, the other controllers are disabled by default.  On the other hand, user might want to leverage having FluxCD installed for their own purposes. Take a look to the `values.yaml` to see how to enable other controllers. |
+| flux2.installCRDs | bool | `true` | The installation of the CRDs is managed by the chart itself. |
+| flux2.rbac | object | Enabled (See `values.yaml`) | Create RBAC rules for FluxCD is able to deploy all kind of workloads on the cluster. |
+| flux2.sourceController | object | Enabled | Source controller provides a way to fetch artifacts to the rest of controllers. The source API (which reference [can be read here](https://fluxcd.io/flux/components/source/api/v1/)) is used by admins and various automated operators to offload the Git, OCO, and Helm repositories management. |
+| flux2.watchAllNamespaces | bool | `false` | As we are using Flux as a tool from the agent control to release new workloads, we do not want Flux to listen to all CRs created on the whole cluster. If the user does not want to use Flux and is only using it because of the agent control, this is the way to go so the cluster has deployed all operators needed by the agent control. But if the user want to use Flux for other purposes besides the agent control, this toggle can be used to allow Flux to work on the whole cluster. |
+| fullnameOverride | string | `""` | Override the full name of the release |
+| nameOverride | string | `""` | Override the name of the chart |
+| agent-control-deployment | object | See `values.yaml` | Values related to the agent control's Helm chart release. |
+| agent-control-deployment.affinity | object | `{}` | Sets pod/node affinities. Can be configured also with `global.affinity` |
+| agent-control-deployment.cleanupManagedResources | bool | `true` | Enable the cleanup of agent-control managed resources when the chart is uninstalled. If disabled, agents and/or agent configurations managed by the agent-control will not be deleted when the chart is uninstalled. |
+| agent-control-deployment.cluster | string | `""` | Name of the Kubernetes cluster monitored. Can be configured also with `global.cluster`. |
+| agent-control-deployment.config.opamp.auth.organizationId | string | `""` | Organization ID where fleets will live. |
+| agent-control-deployment.config.opamp.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. This options is mutually exclusive with `plain`. |
+| agent-control-deployment.config.opamp.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. This options is mutually exclusive with `base64`. |
+| agent-control-deployment.config.opamp.auth.secret.client_id.secret_key | string | `client_id` | Key inside the secret containing the client ID. |
+| agent-control-deployment.config.opamp.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. |
+| agent-control-deployment.config.opamp.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. This options is mutually exclusive with `plain_pem`. |
+| agent-control-deployment.config.opamp.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. This options is mutually exclusive with `base64_pem`. |
+| agent-control-deployment.config.opamp.auth.secret.private_key.secret_key | string | `private_key` | Key inside the secret containing the private key. |
+| agent-control-deployment.config.opamp.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. |
+| agent-control-deployment.config.subAgents | string | `newrelic/io.opentelemetry.collector` (See `values.yaml`) | Values that the fleet is going to have in the deployment. If empty, chart will automatically add `newrelic/io.opentelemetry.collector` subagent. On the other hand, if populated the list of agent created is the one specified overwriting the default. |
+| agent-control-deployment.config.agentControl | object | See `values.yaml` | Configuration for the Agent Control. |
+| agent-control-deployment.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. |
+| agent-control-deployment.config.agentControl.create | bool | `true` | Set if the configMap is going to be created by this chart or the user will provide its own. |
+| agent-control-deployment.containerSecurityContext | object | `{}` | Sets security context (at container level). Can be configured also with `global.containerSecurityContext` |
+| agent-control-deployment.customAttributes | object | `{}` | TODO: Adds extra attributes to the cluster and all the metrics emitted to the backend. Can be configured also with `global.customAttributes` |
+| agent-control-deployment.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` |
+| agent-control-deployment.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` |
+| agent-control-deployment.dnsConfig | object | `{}` | Sets pod's dnsConfig. Can be configured also with `global.dnsConfig` |
+| agent-control-deployment.enabled | bool | `true` | Enable the installation of the Agent Control. This an advanced/debug flag. It should be always be true unless you know what you are going. |
+| agent-control-deployment.extraEnv | list | `[]` | Add user environment variables to the agent |
+| agent-control-deployment.extraEnvFrom | list | `[]` | Add user environment from configMaps or secrets as variables to the agent |
+| agent-control-deployment.extraVolumeMounts | list | `[]` | Defines where to mount volumes specified with `extraVolumes` |
+| agent-control-deployment.extraVolumes | list | `[]` | Volumes to mount in the containers |
+| agent-control-deployment.fedramp.enabled | bool | `false` | TODO: Enables FedRAMP. Can be configured also with `global.fedramp.enabled` |
+| agent-control-deployment.hostNetwork | bool | `false` | Sets pod's hostNetwork. Can be configured also with `global.hostNetwork` |
+| agent-control-deployment.image | object | See `values.yaml` | Image for the New Relic Agent Control |
+| agent-control-deployment.image.pullSecrets | list | `[]` | The secrets that are needed to pull images from a custom registry. |
+| agent-control-deployment.labels | object | `{}` | Additional labels for chart objects. Can be configured also with `global.labels` |
+| agent-control-deployment.licenseKey | string | `""` | This set this license key to use. Can be configured also with `global.licenseKey` |
+| agent-control-deployment.nodeSelector | object | `{}` | Sets pod's node selector. Can be configured also with `global.nodeSelector` |
+| agent-control-deployment.nrStaging | bool | `false` | Send the metrics to the staging backend. Requires a valid staging license key. Can be configured also with `global.nrStaging` |
+| agent-control-deployment.podAnnotations | object | `{}` | Annotations to be added to all pods created by the integration. |
+| agent-control-deployment.podLabels | object | `{}` | Additional labels for chart pods. Can be configured also with `global.podLabels` |
+| agent-control-deployment.podSecurityContext | object | `{}` | Sets security context (at pod level). Can be configured also with `global.podSecurityContext` |
+| agent-control-deployment.priorityClassName | string | `""` | Sets pod's priorityClassName. Can be configured also with `global.priorityClassName` |
+| agent-control-deployment.proxy | string | `""` | TODO: Configures the integration to send all HTTP/HTTPS request through the proxy in that URL. The URL should have a standard format like `https://user:password@hostname:port`. Can be configured also with `global.proxy` |
+| agent-control-deployment.rbac.create | bool | `true` | Whether the chart should automatically create the RBAC objects required to run. |
+| agent-control-deployment.resources | object | `{}` | Resource limits to be added to all pods created by the integration. |
+| agent-control-deployment.serviceAccount | object | See `values.yaml` | Settings controlling ServiceAccount creation. |
+| agent-control-deployment.serviceAccount.create | bool | `true` | Whether the chart should automatically create the ServiceAccount objects required to run. |
+| agent-control-deployment.tolerations | list | `[]` | Sets pod's tolerations to node taints. Can be configured also with `global.tolerations` |
+| agent-control-deployment.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` |
+
+## Maintainers
+
+* [alvarocabanas](https://github.com/alvarocabanas)
+* [DavSanchez](https://github.com/DavSanchez)
+* [gsanchezgavier](https://github.com/gsanchezgavier)
+* [paologallinaharbur](https://github.com/paologallinaharbur)
+* [rubenruizdegauna](https://github.com/rubenruizdegauna)
+* [sigilioso](https://github.com/sigilioso)
@@ -13,7 +13,7 @@ You can install this chart using directly this Helm repository:
 
 ```shell
 helm repo add newrelic https://helm-charts.newrelic.com
-helm upgrade --install super-agent newrelic/super-agent -f your-custom-values.yaml
+helm upgrade --install agent-control newrelic/agent-control -f your-custom-values.yaml
 ```
 
 {{ template "chart.sourcesSection" . }}

@@ -1,5 +1,5 @@
 apiVersion: v2
-name: super-agent-deployment
+name: agent-control-deployment
 description: A Helm chart to install New Relic Super agent on Kubernetes
 
 type: application
@@ -8,7 +8,7 @@ version: 0.0.25-beta
 
 keywords:
   - newrelic
-  - super-agent
+  - agent-control
 
 maintainers:
   - name: sigilioso