diff --git a/src/content/docs/new-relic-control/agent-control/mirror-setup.mdx b/src/content/docs/new-relic-control/agent-control/mirror-setup.mdx new file mode 100644 index 000000000000..d9fa2945aaa8 --- /dev/null +++ b/src/content/docs/new-relic-control/agent-control/mirror-setup.mdx @@ -0,0 +1,94 @@ +--- +title: "Configure an OCI registry mirror for Agent Control" +metaDescription: "Learn how to configure Agent Control to use an OCI registry mirror." +tags: + - new-relic-control + - agent-control + - mirror-setup +freshnessValidatedDate: never +--- + + Agent Control and New Relic Control are now **generally available** for Kubernetes! Support for Linux hosts and Windows hosts is also in **public preview** program, pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy). + + +By default, Agent Control uses docker.io as the Open Container Initiative (OCI) registry to download agent packages. If your environment requires a different registry, you can configure a custom OCI registry or mirror. + +## Before you begin + +Before configuring a custom OCI registry, ensure you have: + +1. **Installed Agent Control:** Use the New Relic CLI to complete the [Agent Control installation](/docs/new-relic-control/agent-control/setup). +2. **Mirror registry available:** Ensure your custom OCI registry is accessible from the host machine. +3. **CA certificate installed:** Install the certificate authority certificate on the host machine required to communicate with the mirror. + +## Configure on hosts + +After installing Agent Control on your host, follow these steps to configure a custom OCI registry: + + + + + +### Edit the local configuration file + +Edit the Agent Control local configuration file: + +* Linux: `/etc/newrelic-agent-control/local-data/agent-control/local_config.yaml` +* Windows: `C:\Program Files\New Relic\newrelic-agent-control\local-data\agent-control\local_config.yaml` + +Add the following configuration sections to the file: + +```yaml +oci: + registry: YOUR_REGISTRY_URL +``` + +If you need to set up your username and password, use the following snippet: + +```yaml +oci: + registry: YOUR_REGISTRY_URL + auth: + basic: + username: YOUR_USERNAME + password: YOUR_PASSWORD +``` + +Replace the placeholder values: +- `YOUR_REGISTRY_URL`: The URL of your custom OCI registry (for example, `registry.example.com:5000` or `mirror.internal.company.com`) +- `YOUR_USERNAME`: Username for registry authentication +- `YOUR_PASSWORD`: Password for registry authentication + +This assumes the machine has access to the public keys of each agent and that the mirror contains all the signatures up to date. +If this cannot be met, we can disable signatures verification. We don't suggest it. + +```yaml +agent_packages: + signature_verification_enabled: false +``` + + + + + +### Restart Agent Control + +Restart the Agent Control service to apply the new configuration and verify that the service restarted successfully + +* Linux: + + ```bash + sudo systemctl restart newrelic-agent-control + sudo systemctl status newrelic-agent-control + ``` + +* Windows: + + ```powershell + Restart-Service -Name newrelic-agent-control + Get-Service -Name newrelic-agent-control + ``` + + + + diff --git a/src/nav/new-relic-control.yml b/src/nav/new-relic-control.yml index f106c5968d95..dbc69747ab8e 100644 --- a/src/nav/new-relic-control.yml +++ b/src/nav/new-relic-control.yml @@ -15,6 +15,8 @@ pages: path: /docs/new-relic-control/agent-control/reinstrumentation - title: Manage configurations path: /docs/new-relic-control/agent-control/configuration + - title: Configure an OCI registry mirror + path: /docs/new-relic-control/agent-control/mirror-setup - title: Upgrade agents path: /docs/new-relic-control/agent-control/upgrading - title: Monitor agent health