Skip to content

Commit 37f2f75

Browse files
docs: update (#1740)
1 parent fd3e9b3 commit 37f2f75

11 files changed

+19
-19
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing
22

33
Contributions are always welcome. Before contributing please read the
4-
[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,
4+
[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,
55
[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/).
66

77
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.

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ agents. It also integrates with New Relic fleet manager.
1717

1818
## Getting started
1919

20-
Follow the [installation steps](https://docs-preview.newrelic.com/docs/new-relic-agent-control#quickstart) to get
21-
started on Linux hosts and [running in Kubernetes](/docs/README.md#running-in-kubernetes) to run it in your cluster.
20+
Follow the [installation steps](https://docs.newrelic.com/docs/new-relic-control/agent-control/setup/) to install agent control.
2221

23-
For troubleshooting,
24-
see [Diagnose issues with agent logging](https://docs-preview.newrelic.com/docs/new-relic-agent-control#troubleshooting).
22+
To run the project locally, check out the [development](/docs/DEVELOPMENT.md) docs.
23+
24+
For troubleshooting, see [Diagnose issues with agent logging](https://docs.newrelic.com/docs/new-relic-control/agent-control/troubleshooting/).
2525

2626
## Documentation
2727

2828
Learn more from the [technical documentation in this repository](/docs/README.md) and
29-
the [Limited Preview Documentation](https://docs-preview.newrelic.com/docs/new-relic-agent-control).
29+
the [New Relic Documentation](https://docs.newrelic.com/docs/new-relic-control/agent-control/overview/).
3030

3131
## Support
3232

build/examples/agent-control-config-all-agents.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# fleet_control:
22
# endpoint: https://opamp.service.newrelic.com/v1/opamp
33
# signature_validation:
4-
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json
4+
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json
55
# headers:
66
# api-key: API_KEY_HERE
77
# fleet_id: FLEET_ID_HERE

build/examples/agent-control-config-no-agents.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# fleet_control:
22
# endpoint: https://opamp.service.newrelic.com/v1/opamp
33
# signature_validation:
4-
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json
4+
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json
55
# headers:
66
# api-key: API_KEY_HERE
77
# fleet_id: FLEET_ID_HERE

build/examples/agent-control-config-nr-infra-agent.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# fleet_control:
22
# endpoint: https://opamp.service.newrelic.com/v1/opamp
33
# signature_validation:
4-
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json
4+
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json
55
# headers:
66
# api-key: API_KEY_HERE
77
# fleet_id: FLEET_ID_HERE

build/examples/agent-control-config-nr-otel-collector.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# fleet_control:
22
# endpoint: https://opamp.service.newrelic.com/v1/opamp
33
# signature_validation:
4-
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/GLOBAL/AgentConfiguration/jwks.json
4+
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json
55
# headers:
66
# api-key: API_KEY_HERE
77
# fleet_id: FLEET_ID_HERE

docs/CONFIG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ fleet_control:
5959
fleet_id: "some-id" # Fleet identifier.
6060
signature_validation:
6161
certificate_server_url: "https://newrelic.com/" # Server to obtain the certificate for signature validation.
62-
public_key_server_url: "https://publickeys.newrelic.com/signing/blob-management/GLOBAL/AgentConfiguration" # Server to obtain the public key for signature validation.
62+
public_key_server_url: "https://publickeys.newrelic.com/signing/blob-management/global/agentconfiguration" # Server to obtain the public key for signature validation.
6363
certificate_pem_file_path: "/some/certificate/" # Optional, if set it uses a local certificated instead of fetching it from 'certicate_server_url'.
6464
enabled: true # Defaults to true, allows disabling the signature validation.
6565
```

docs/DEVELOPMENT.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ ulimit -n 4096
140140

141141
## Troubleshooting
142142

143-
See [diagnose issues with agent control logging](https://docs-preview.newrelic.com/docs/new-relic-agent-control#debug).
143+
See [diagnose issues with agent control logging](https://docs.newrelic.com/docs/new-relic-control/agent-control/troubleshooting/).
144144

145145
### Disable Fleet Control
146146

@@ -149,6 +149,8 @@ Users can disable remote management just by commenting its configuration out fro
149149
```yaml
150150
# fleet_control:
151151
# endpoint: https://opamp.service.newrelic.com/v1/opamp
152+
# signature_validation:
153+
# public_key_server_url: https://publickeys.newrelic.com/r/blob-management/global/agentconfiguration/jwks.json
152154
# headers:
153155
# api-key: API_KEY_HERE
154156
# fleet_id: FLEET_ID_HERE

docs/INTEGRATING_AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ All of these variable references will be replaced with actual values, either pro
150150

151151
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.
152152

153-
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.
153+
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.
154154

155155
##### Environment variable expansion on configuration values
156156

@@ -265,7 +265,7 @@ As of now, the `executables` field is array and is actually **optional**. This w
265265

266266
##### `enable_file_logging` (`bool`)
267267

268-
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`.
268+
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`.
269269

270270
##### `health` (on-host)
271271

docs/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The communication between AC and FC is done over HTTPS and is generally complian
3434

3535
> [...] a network protocol for remote management of large fleets of data collection Agents.
3636
37-
We maintain our own Rust library for OpAMP clients on a separate repository: [`opamp-rs`](https://github.com/newrelic/opamp-rs).
37+
We maintain our own Rust library for OpAMP clients on a separate repository: [`newrelic-opamp-rs`](https://github.com/newrelic/newrelic-opamp-rs).
3838

3939
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**.
4040

@@ -99,10 +99,7 @@ The avid reader might be asking at this point "*How does AC know the way to crea
9999

100100
## Getting started
101101

102-
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.
103-
104-
> [!CAUTION]
105-
> 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.
102+
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.
106103

107104
### Configuration
108105

0 commit comments

Comments
 (0)