Skip to content

Commit

Permalink
Change config file name to be consistent with Helm Chart to config.ya…
Browse files Browse the repository at this point in the history
…ml (grafana#3506)

Currently the Grafana Agent config files is given many names in the documentation. This is a change to keep the name consistent with the Helm Chart. More detail in this issue: 
grafana#3496

Co-authored-by: Clayton Cornell <clayton.cornell@grafana.com>
  • Loading branch information
SSharp-VB and clayton-cornell committed May 17, 2023
1 parent b1356db commit 323c1eb
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/sources/static/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The YAML file is used to configure settings which are dynamic and can be
changed at runtime. The command-line flags then configure things which cannot
change at runtime, such as the listen port for the HTTP server.

This file describes the YAML configuration, which is usually in a file named `agent.yaml`.
This file describes the YAML configuration, which is usually in a file named `config.yaml`.

- [server_config]({{< relref "./server-config" >}})
- [metrics_config]({{< relref "./metrics-config" >}})
Expand Down Expand Up @@ -102,7 +102,7 @@ Generic placeholders are defined as follows:
- `<string>`: a regular string
- `<secret>`: a regular string that is a secret, such as a password

Support contents and default values of `agent.yaml`:
Support contents and default values of `config.yaml`:

```yaml
# Configures the server of the Agent used to enable self-scraping.
Expand Down

0 comments on commit 323c1eb

Please sign in to comment.