Skip to content

Commit

Permalink
Fix broken links in migrate topics
Browse files Browse the repository at this point in the history
  • Loading branch information
clayton-cornell committed Apr 2, 2024
1 parent 03a1b8e commit 40089ba
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 21 deletions.
17 changes: 5 additions & 12 deletions docs/sources/tasks/migrate/from-operator.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,18 @@ weight: 320

# Migrate from Grafana Agent Operator to {{% param "FULL_PRODUCT_NAME" %}}

With the release of {{< param "PRODUCT_NAME" >}}, Grafana Agent Operator is no longer the recommended way to deploy {{< param "PRODUCT_NAME" >}} in Kubernetes.
Some of the Operator functionality has moved into {{< param "PRODUCT_NAME" >}} itself, and the Helm Chart has replaced the remaining functionality.
You can migrate from Grafana Agent Operator to {{< param "PRODUCT_NAME" >}}.

- The Monitor types (`PodMonitor`, `ServiceMonitor`, `Probe`, and `PodLogs`) are all supported natively by {{< param "PRODUCT_NAME" >}}.
You are no longer required to use the Operator to consume those CRDs for dynamic monitoring in your cluster.
- The parts of the Operator that deploy the {{< param "PRODUCT_NAME" >}} itself (`GrafanaAgent`, `MetricsInstance`, and `LogsInstance` CRDs) are deprecated.
Operator users should use the {{< param "PRODUCT_NAME" >}} [Helm Chart][] to deploy {{< param "PRODUCT_NAME" >}} directly to your clusters.

This guide provides some steps to get started with {{< param "PRODUCT_NAME" >}} for users coming from Grafana Agent Operator.

## Deploy {{% param "PRODUCT_NAME" %}} with Helm

1. Create a `values.yaml` file, which contains options for deploying {{< param "PRODUCT_NAME" >}}.
You can start with the [default values][] and customize as you see fit, or start with this snippet, which should be a good starting point for what the Operator does.

```yaml
agent:
mode: 'flow'
alloy:
configMap:
create: true
clustering:
Expand All @@ -42,7 +36,7 @@ This guide provides some steps to get started with {{< param "PRODUCT_NAME" >}}
This is one of many deployment possible modes. For example, you may want to use a `DaemonSet` to collect host-level logs or metrics.
See the {{< param "PRODUCT_NAME" >}} [deployment guide][] for more details about different topologies.

1. Create an {{< param "PRODUCT_NAME" >}} configuration file, `alloy.alloy`.
1. Create an {{< param "PRODUCT_NAME" >}} configuration file, `config.alloy`.

In the next step, you add to this configuration as you convert `MetricsInstances`. You can add any additional configuration to this file as you need.

Expand Down Expand Up @@ -136,8 +130,7 @@ Our current recommendation is to create an additional DaemonSet deployment of {{
These values are close to what the Operator currently deploys for logs:

```yaml
agent:
mode: 'flow'
alloy:
configMap:
create: true
clustering:
Expand Down Expand Up @@ -281,7 +274,7 @@ The [reference documentation][component documentation] should help convert those
<!-- ToDo: Validate path -->
[default values]: https://github.com/grafana/alloy/blob/main/operations/helm/charts/alloy/values.yaml
[clustering]: ../../../concepts/clustering/
[deployment guide]: ../../../get-started/deploy-alloy
[deployment guide]: ../../../get-started/deploy/
<!-- ToDo: check link syntax -->
[operator guide]: https://grafana.com/docs/agent/latest/operator/deploy-agent-operator-resources/#deploy-a-metricsinstance-resource

Expand Down
2 changes: 1 addition & 1 deletion docs/sources/tasks/migrate/from-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,6 @@ The following list is specific to the convert command and not {{< param "PRODUCT
[convert]: ../../../reference/cli/convert/
[run]: ../../../reference/cli/run/
[run alloy]: ../../../get-started/run/
[DebuggingUI]: ../../tasks/debug/
[DebuggingUI]: ../../debug/
[{{< param "PRODUCT_NAME" >}} configuration]: ../../../concepts/config-language/
[UI]: ../../debug/#alloy-ui
6 changes: 3 additions & 3 deletions docs/sources/tasks/migrate/from-promtail.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ scrape_configs:
__path__: /var/log/*.log
```

The convert command takes the YAML file as input and outputs a [{{< param "PRODUCT_NAME" >}} configuration][] file.
The convert command takes the YAML file as input and outputs an [{{< param "PRODUCT_NAME" >}} configuration][configuration] file.

```shell
alloy convert --source-format=promtail --output=<OUTPUT_CONFIG_PATH> <INPUT_CONFIG_PATH>
Expand Down Expand Up @@ -189,5 +189,5 @@ The following list is specific to the convert command and not {{< param "PRODUCT
[run]: ../../../reference/cli/run/
[run alloy]: ../../../get-started/run/
[DebuggingUI]: ../../../tasks/debug/
[{{< param "PRODUCT_NAME" >}} configuration]: ../../../concepts/config-language/
[UI]: ../../tasks/debug/#alloy-ui
[configuration]: ../../../concepts/configuration-syntax/
[UI]: ../../debug/#alloy-ui
9 changes: 4 additions & 5 deletions docs/sources/tasks/migrate/from-static.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Your configuration file must be a valid Grafana Agent Static configuration file.

1. You can follow the convert CLI command [debugging][] instructions to generate a diagnostic report.

1. Refer to the {{< param "PRODUCT_NAME" >}} [debugging UI][DebuggingUI] for more information about running {{< param "PRODUCT_NAME" >}}.
1. Refer to the {{< param "PRODUCT_NAME" >}} [debugging UI][UI] for more information about running {{< param "PRODUCT_NAME" >}}.

1. If your Grafana Agent Static configuration can't be converted and loaded directly into {{< param "PRODUCT_NAME" >}}, diagnostic information is sent to `stderr`.
You can use the `--config.bypass-conversion-errors` flag with `--config.format=static` to bypass any non-critical issues and start {{< param "PRODUCT_NAME" >}}.
Expand Down Expand Up @@ -172,7 +172,7 @@ logs:
- url: https://USER_ID:[email protected]/loki/api/v1/push
```
The convert command takes the YAML file as input and outputs a [{{< param "PRODUCT_NAME" >}} configuration][] file.
The convert command takes the YAML file as input and outputs a [{{< param "PRODUCT_NAME" >}} configuration][configuration] file.
```shell
alloy convert --source-format=static --output=<OUTPUT_CONFIG_PATH> <INPUT_CONFIG_PATH>
Expand Down Expand Up @@ -316,7 +316,7 @@ The following list is specific to the convert command and not {{< param "PRODUCT
[run]: ../../../reference/cli/run/
[run alloy]: ../../../get-started/run/
[DebuggingUI]: ../../debug/
[{{< param "PRODUCT_NAME" >}} configuration]: ../../../concepts/config-language/
[configuration]: ../../../concepts/configuration-syntax/

<!--ToDo: Check path -->
[Integrations next]: https://grafana.com/docs/agent/latest/static/configuration/integrations/integrations-next/
Expand All @@ -330,5 +330,4 @@ The following list is specific to the convert command and not {{< param "PRODUCT
<!--ToDo: Check path -->
[Metrics]: https://grafana.com/docs/agent/latest/static/configuration/metrics-config/
[Logs]: https://grafana.com/docs/agent/latest/static/configuration/logs-config/

[UI]: ../../debug/#grafana-agent-flow-ui
[UI]: ../../debug/#alloy-ui

0 comments on commit 40089ba

Please sign in to comment.