diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6a0e2a76fc..9cb16dc83b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing Contributions are always welcome. Before contributing please read the -[code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) and [search the issue tracker](issues); your issue may have already been discussed or fixed in `main`. To contribute, +[code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) and [search the issue tracker](../../issues); your issue may have already been discussed or fixed in `main`. To contribute, [fork](https://help.github.com/articles/fork-a-repo/) this repository, commit your changes, and [send a Pull Request](https://help.github.com/articles/using-pull-requests/). Note that our [code of conduct](https://github.com/newrelic/.github/blob/main/CODE_OF_CONDUCT.md) applies to all platforms and venues related to this project; please follow it in all your interactions with the project and its participants. diff --git a/README.md b/README.md index 3da229855c..745c11c309 100644 --- a/README.md +++ b/README.md @@ -17,16 +17,16 @@ agents. It also integrates with New Relic fleet manager. ## Getting started -Follow the [installation steps](https://docs-preview.newrelic.com/docs/new-relic-agent-control#quickstart) to get -started on Linux hosts and [running in Kubernetes](/docs/README.md#running-in-kubernetes) to run it in your cluster. +Follow the [installation steps](https://docs.newrelic.com/docs/new-relic-control/agent-control/setup/) to install agent control. -For troubleshooting, -see [Diagnose issues with agent logging](https://docs-preview.newrelic.com/docs/new-relic-agent-control#troubleshooting). +To run the project locally, check out the [development](/docs/DEVELOPMENT.md) docs. + +For troubleshooting, see [Diagnose issues with agent logging](https://docs.newrelic.com/docs/new-relic-control/agent-control/troubleshooting/). ## Documentation Learn more from the [technical documentation in this repository](/docs/README.md) and -the [Limited Preview Documentation](https://docs-preview.newrelic.com/docs/new-relic-agent-control). +the [New Relic Documentation](https://docs.newrelic.com/docs/new-relic-control/agent-control/overview/). ## Support diff --git a/build/examples/agent-control-config-all-agents.yaml b/build/examples/agent-control-config-all-agents.yaml index 68d6665885..ac699766e7 100644 --- a/build/examples/agent-control-config-all-agents.yaml +++ b/build/examples/agent-control-config-all-agents.yaml @@ -1,7 +1,7 @@ # fleet_control: # endpoint: https://opamp.service.newrelic.com/v1/opamp # signature_validation: -# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json +# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json # headers: # api-key: API_KEY_HERE # fleet_id: FLEET_ID_HERE diff --git a/build/examples/agent-control-config-no-agents.yaml b/build/examples/agent-control-config-no-agents.yaml index 938dadd454..eb1be58750 100644 --- a/build/examples/agent-control-config-no-agents.yaml +++ b/build/examples/agent-control-config-no-agents.yaml @@ -1,7 +1,7 @@ # fleet_control: # endpoint: https://opamp.service.newrelic.com/v1/opamp # signature_validation: -# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json +# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json # headers: # api-key: API_KEY_HERE # fleet_id: FLEET_ID_HERE diff --git a/build/examples/agent-control-config-nr-infra-agent.yaml b/build/examples/agent-control-config-nr-infra-agent.yaml index c173615a4d..e3f7de3698 100644 --- a/build/examples/agent-control-config-nr-infra-agent.yaml +++ b/build/examples/agent-control-config-nr-infra-agent.yaml @@ -1,7 +1,7 @@ # fleet_control: # endpoint: https://opamp.service.newrelic.com/v1/opamp # signature_validation: -# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json +# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json # headers: # api-key: API_KEY_HERE # fleet_id: FLEET_ID_HERE diff --git a/build/examples/agent-control-config-nr-otel-collector.yaml b/build/examples/agent-control-config-nr-otel-collector.yaml index a353edf7cc..70f2cdddc0 100644 --- a/build/examples/agent-control-config-nr-otel-collector.yaml +++ b/build/examples/agent-control-config-nr-otel-collector.yaml @@ -1,7 +1,7 @@ # fleet_control: # endpoint: https://opamp.service.newrelic.com/v1/opamp # signature_validation: -# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json +# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json # headers: # api-key: API_KEY_HERE # fleet_id: FLEET_ID_HERE diff --git a/docs/CONFIG.md b/docs/CONFIG.md index 8688666401..17d2c01de9 100644 --- a/docs/CONFIG.md +++ b/docs/CONFIG.md @@ -59,7 +59,7 @@ fleet_control: fleet_id: "some-id" # Fleet identifier. signature_validation: certificate_server_url: "https://newrelic.com/" # Server to obtain the certificate for signature validation. - public_key_server_url: "https://publickeys.newrelic.com/signing/blob-management/GLOBAL/AgentConfiguration" # Server to obtain the public key for signature validation. + public_key_server_url: "https://publickeys.newrelic.com/signing/blob-management/global/agentconfiguration" # Server to obtain the public key for signature validation. certificate_pem_file_path: "/some/certificate/" # Optional, if set it uses a local certificated instead of fetching it from 'certicate_server_url'. enabled: true # Defaults to true, allows disabling the signature validation. ``` diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 6228748b8e..7465c92513 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -140,7 +140,7 @@ ulimit -n 4096 ## Troubleshooting -See [diagnose issues with agent control logging](https://docs-preview.newrelic.com/docs/new-relic-agent-control#debug). +See [diagnose issues with agent control logging](https://docs.newrelic.com/docs/new-relic-control/agent-control/troubleshooting/). ### Disable Fleet Control @@ -149,6 +149,8 @@ Users can disable remote management just by commenting its configuration out fro ```yaml # fleet_control: # endpoint: https://opamp.service.newrelic.com/v1/opamp +# signature_validation: +# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json # headers: # api-key: API_KEY_HERE # fleet_id: FLEET_ID_HERE diff --git a/docs/INTEGRATING_AGENTS.md b/docs/INTEGRATING_AGENTS.md index 80d75c6c98..b29f92c9a7 100644 --- a/docs/INTEGRATING_AGENTS.md +++ b/docs/INTEGRATING_AGENTS.md @@ -150,7 +150,7 @@ All of these variable references will be replaced with actual values, either pro When adding these values as a user, either as a local config for AC (a file in the filesystem for on-host or a ConfigMap for Kubernetes) or as remote configs made available from FC, the format used is a YAML file with the values following the same tree-like structure defined for the variables in the agent type definition, but the *leaf nodes* being the actual values. -For examples of this with actual agent type definitions, see [config examples](https://docs-preview.newrelic.com/docs/new-relic-agent-control-linux#config-examples) in the official New Relic documentation site. +For examples of this with actual agent type definitions, see [kubernetes config examples](https://docs.newrelic.com/docs/new-relic-control/agent-control/configuration/#kubernetes-configuration) and [host config examples](https://docs.newrelic.com/docs/new-relic-control/agent-control/configuration/#linux-configuration) in the official New Relic documentation site. ##### Environment variable expansion on configuration values @@ -265,7 +265,7 @@ As of now, the `executables` field is array and is actually **optional**. This w ##### `enable_file_logging` (`bool`) -When set, this redirects the `stdout` and `stderr` of the created process to files inside AC's logging directory (see [on-host troubleshooting](https://docs-preview.newrelic.com/docs/new-relic-agent-control-linux#debug) in the official public documentation). These log files will reside inside a directory dedicated to the current sub-agent, identifiable by its `agent_id`. +When set, this redirects the `stdout` and `stderr` of the created process to files inside AC's logging directory (see [on-host troubleshooting](https://docs.newrelic.com/docs/new-relic-control/agent-control/troubleshooting/#linux-hosts-troubleshooting) in the official public documentation). These log files will reside inside a directory dedicated to the current sub-agent, identifiable by its `agent_id`. ##### `health` (on-host) diff --git a/docs/README.md b/docs/README.md index 100f57ada1..8c6ef5d0ed 100644 --- a/docs/README.md +++ b/docs/README.md @@ -34,7 +34,7 @@ The communication between AC and FC is done over HTTPS and is generally complian > [...] a network protocol for remote management of large fleets of data collection Agents. -We maintain our own Rust library for OpAMP clients on a separate repository: [`opamp-rs`](https://github.com/newrelic/opamp-rs). +We maintain our own Rust library for OpAMP clients on a separate repository: [`newrelic-opamp-rs`](https://github.com/newrelic/newrelic-opamp-rs). From the point of view of OpAMP, AC is also an agent. That's why, even though each workload will have its own OpAMP communication channel when managed by AC, we commonly refer to the various observability workloads that AC can manage as **sub-agents**. @@ -99,10 +99,7 @@ The avid reader might be asking at this point "*How does AC know the way to crea ## Getting started -For the standard installation of Agent Control, either on-host or Kubernetes, head to the [official documentation](https://docs-preview.newrelic.com/docs/new-relic-agent-control#quickstart) on New Relic's website. - -> [!CAUTION] -> The link to documentation shared above currently leads to the **preview** version! This will be stabilized and moved to the main site shortly, so make sure this is updated. Remove this warning when the documentation links to the proper place. +For the standard installation of Agent Control, either on-host or Kubernetes, head to the [official documentation](https://docs.newrelic.com/docs/new-relic-control/agent-control/setup/) on New Relic's website. ### Configuration diff --git a/docs/ac-remote-update/how-it-works.md b/docs/ac-remote-update/how-it-works.md index ecb45be81c..0e0abcb741 100644 --- a/docs/ac-remote-update/how-it-works.md +++ b/docs/ac-remote-update/how-it-works.md @@ -91,6 +91,7 @@ The implementation is, of course, more complex. agents: nr-infra: newrelic/com.newrelic.infrastructure:0.1.0 chart_version: "1.0.0" + cd_chart_version: "1.0.0" ``` 2. **Report Initial State**: To provide visibility, Agent Control reports its status as `Applying`.