Skip to content

Commit d8e2e82

Browse files
feat(remoteUpdate): config
1 parent 369a190 commit d8e2e82

File tree

1 file changed

+12
-38
lines changed

1 file changed

+12
-38
lines changed

docs/CONFIG.md

Lines changed: 12 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# Agent Control Configuration
22

3-
Agent control will load the configuration from the file `config.yaml` in the corresponding directory (
4-
`/etc/newrelic-agent-control` or `/opt/homebrew/var/lib/newrelic-agent-control`).
3+
Agent control will load the configuration from the file `config.yaml` in the corresponding directory (`/etc/newrelic-agent-control` or `/opt/homebrew/var/lib/newrelic-agent-control`).
54

6-
Additionally, any configuration field can be set as an environment variable with the `NR_AC` prefix, using `__` to
7-
separate keys. Examples:
5+
Additionally, any configuration field can be set as an environment variable with the `NR_AC` prefix, using `__` to separate keys. Examples:
86

97
```bash
108
# Set log level to debug
@@ -15,24 +13,9 @@ NR_AC_FLEET_CONTROL__AUTH_CONFIG__CLIENT_ID="some-client-id"
1513

1614
## Configuration fields
1715

18-
### chart_version
19-
20-
The `chart_version` field is used to report the version of the helm chart used to upgrade Agent Control.
21-
This is currently not set by fleet control, but it can be used already to perform tests.
22-
This config is valid for K8s only, for on_host environments it will be ignored.
23-
24-
Example:
25-
26-
```yaml
27-
chart_version: "0.99.0"
28-
```
29-
30-
The behaviour if set locally is not defined yet.
31-
3216
### agents
3317

34-
List of agents configured locally. Check of [DEVELOPMENT](./DEVELOPMENT.md) for more information regarding agents and
35-
their corresponding local configuration.
18+
List of agents configured locally. Check of [DEVELOPMENT](./DEVELOPMENT.md) for more information regarding agents and their corresponding local configuration.
3619

3720
Example:
3821

@@ -81,19 +64,14 @@ fleet_control:
8164
8265
### proxy
8366
84-
Agent Control will use the system proxy (configured through the standard `HTTP_PROXY` / `HTTPS_PROXY` environment
85-
variables) but
86-
proxy options can also be configured using the proxy configuration field. If both are set, the precedence works as
87-
follows:
67+
Agent Control will use the system proxy (configured through the standard `HTTP_PROXY` / `HTTPS_PROXY` environment variables) but
68+
proxy options can also be configured using the proxy configuration field. If both are set, the precedence works as follows:
8869

8970
1. `proxy` configuration field
9071
2. `HTTP_PROXY` environment variable
9172
3. `HTTPS_PROXY` environment variable
9273

93-
⚠️ Proxy configuration is currently not compatible with fetching the certificate for signature validation. If you need
94-
to setup a proxy you will need to either use a local certificate through
95-
`fleet_control.signature_validation.certificate_pem_file_path` (recommended) or disable signature validation (highly
96-
discouraged).
74+
⚠️ Proxy configuration is currently not compatible with fetching the certificate for signature validation. If you need to setup a proxy you will need to either use a local certificate through `fleet_control.signature_validation.certificate_pem_file_path` (recommended) or disable signature validation (highly discouraged).
9775

9876
```yaml
9977
proxy:
@@ -105,8 +83,7 @@ proxy:
10583

10684
### server
10785

108-
Agent Control status server allows consulting the status of Agent Control and any controlled agent. It can be configured
109-
as follows:
86+
Agent Control status server allows consulting the status of Agent Control and any controlled agent. It can be configured as follows:
11087

11188
```yaml
11289
server:
@@ -126,17 +103,16 @@ health_check:
126103

127104
### self_instrumentation
128105

129-
Agent Control can be configured to instrument itself and report traces, logs and metrics through OpenTelemetry. If proxy
130-
is configured globally it will also apply to self-instrumentation.
106+
Agent Control can be configured to instrument itself and report traces, logs and metrics through OpenTelemetry. If proxy is configured globally it will also apply to self-instrumentation.
131107

132108
```yaml
133109
self_instrumentation:
134110
opentelemetry:
135111
insecure_level: "newrelic_agent_control=info,off" # It is considered insecure because setting it up for external dependencies could potentially leak secrets. The default `newrelic_agent_control=debug,opamp_client=debug,off` disables external dependencies and can be considered secure.
136112
endpoint: https://otlp.nr-data.net:4318 # HTTPS endpoint to report instrumentation to.
137-
headers: { } # Headers that will be included in any request to the endpoint
113+
headers: {} # Headers that will be included in any request to the endpoint
138114
client_timeout: 10s # Timeout for performing requests, defaults to 30s.
139-
custom_attributes: { } # Attributes to be decorated in all metrics, traces and logs
115+
custom_attributes: {} # Attributes to be decorated in all metrics, traces and logs
140116
metrics:
141117
enabled: true # Defaults to false.
142118
interval: 120s # Interval to report metrics, it defaults to 60s.
@@ -154,8 +130,7 @@ self_instrumentation:
154130
155131
### host_id
156132
157-
If the `host_id` is set it will be used to identify the host in Fleet Control instead of trying to fetch the identifier
158-
from the
133+
If the `host_id` is set it will be used to identify the host in Fleet Control instead of trying to fetch the identifier from the
159134
host where Agent Control is running. Order of precedence:
160135

161136
1. Configured `host_id`.
@@ -170,8 +145,7 @@ host_id: "some-host-id" # Defaults to "" (no host set).
170145

171146
### k8s
172147

173-
The `k8s` configuration field applies for k8s environments only and are automatically set up through the corresponding
174-
helm chart:
148+
The `k8s` configuration field applies for k8s environments only and are automatically set up through the corresponding helm chart:
175149

176150
```yaml
177151
k8s:

0 commit comments

Comments
 (0)