Skip to content

Commit

Permalink
Update topics to replace instances of Agent with Alloy (#34)
Browse files Browse the repository at this point in the history
* Replace agent with alloy in cli topics

* Replace agent with alloy in config blocks

* Replace agent with alloy in stdlib topics

* Replace agent with alloy in cli and tasks

* Repalce agent with alloy in get started and run topics

* Replace agent with alloy in loadbalancing topic

* Remove agent from convert command

* Update Mimir rules topic

* Clean up tutorial and fix broken link

* Update agent to alloy in migrate tasks

* Fix another grafana-agent and rename to grafana-alloy
  • Loading branch information
clayton-cornell authored Mar 18, 2024
1 parent 3337557 commit 69d4e55
Show file tree
Hide file tree
Showing 45 changed files with 357 additions and 325 deletions.
4 changes: 2 additions & 2 deletions docs/sources/get-started/install/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
canonical: https://grafana.com/docs/alloy/latest/get-started/install/
description: Learn how to install Grafana Agent Flow
description: Learn how to install Grafana Alloy
menuTitle: Install
title: Install Grafana Agent Flow
title: Install Grafana Alloy
weight: 50
---

Expand Down
29 changes: 14 additions & 15 deletions docs/sources/get-started/install/ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,23 +19,22 @@ You can use Ansible to install and manage {{< param "PRODUCT_NAME" >}} on Linux

To add {{% param "PRODUCT_NAME" %}} to a host:

1. Create a file named `grafana-agent.yml` and add the following:
1. Create a file named `grafana-alloy.yml` and add the following:

```yaml
- name: Install Grafana Agent Flow
- name: Install Grafana Alloy
hosts: all
become: true
tasks:
- name: Install Grafana Agent Flow
- name: Install Grafana Alloy
ansible.builtin.include_role:
name: grafana.grafana.grafana_agent
name: grafana.grafana.grafana_alloy
vars:
grafana_agent_mode: flow
# Destination file name
grafana_agent_config_filename: config.river
grafana_alloy_config_filename: config.river
# Local file to copy
grafana_agent_provisioned_config_file: "<path-to-config-file-on-localhost>"
grafana_agent_flags_extra:
grafana_alloy_provisioned_config_file: "<path-to-config-file-on-localhost>"
grafana_alloy_flags_extra:
server.http.listen-addr: '0.0.0.0:12345'
```
Expand All @@ -45,29 +44,29 @@ To add {{% param "PRODUCT_NAME" %}} to a host:
1. Run the Ansible playbook. Open a terminal window and run the following command from the Ansible playbook directory.

```shell
ansible-playbook grafana-agent.yml
ansible-playbook grafana-alloy.yml
```

## Validate

To verify that the {{< param "PRODUCT_NAME" >}} service on the target machine is `active` and `running`, open a terminal window and run the following command:

```shell
$ sudo systemctl status grafana-agent.service
$ sudo systemctl status grafana-alloy.service
```

If the service is `active` and `running`, the output should look similar to this:

```
grafana-agent.service - Grafana Agent
Loaded: loaded (/etc/systemd/system/grafana-agent.service; enabled; vendor preset: enabled)
grafana-alloy.service - Grafana Alloy
Loaded: loaded (/etc/systemd/system/grafana-alloy.service; enabled; vendor preset: enabled)
Active: active (running) since Wed 2022-07-20 09:56:15 UTC; 36s ago
Main PID: 3176 (agent-linux-amd)
Main PID: 3176 (alloy-linux-amd)
Tasks: 8 (limit: 515)
Memory: 92.5M
CPU: 380ms
CGroup: /system.slice/grafana-agent.service
└─3176 /usr/local/bin/agent-linux-amd64 --config.file=/etc/grafana-cloud/agent-config.yaml
CGroup: /system.slice/grafana-alloy.service
└─3176 /usr/local/bin/alloy-linux-amd64 --config.file=/etc/grafana-cloud/alloy-config.yaml
```

## Next steps
Expand Down
6 changes: 3 additions & 3 deletions docs/sources/get-started/install/binary.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
canonical: https://grafana.com/docs/alloy/latest/get-started/install/binary/
description: Learn how to install Grafana Agent Flow as a standalone binary
description: Learn how to install Grafana Alloy as a standalone binary
menuTitle: Standalone
title: Install Grafana Agent Flow as a standalone binary
title: Install Grafana Alloy as a standalone binary
weight: 600
---

Expand All @@ -23,7 +23,7 @@ To download {{< param "PRODUCT_NAME" >}} as a standalone binary, perform the fol

1. Scroll down to the **Assets** section.

1. Download the `grafana-agent` zip file that matches your operating system and machine's architecture.
1. Download the `grafana-alloy` zip file that matches your operating system and machine's architecture.

1. Extract the package contents into a directory.

Expand Down
14 changes: 7 additions & 7 deletions docs/sources/get-started/install/chef.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,26 +66,26 @@ To add {{< param "PRODUCT_NAME" >}} to a host:
end
```

1. Add the following resources to install and enable the `grafana-agent-flow` service:
1. Add the following resources to install and enable the `grafana-alloy` service:

```ruby
package 'grafana-agent-flow' do
package 'grafana-alloy' do
action :install
flush_cache [ :before ] if platform_family?('amazon', 'rhel', 'fedora')
notifies :restart, 'service[grafana-agent-flow]', :delayed
notifies :restart, 'service[grafana-alloy]', :delayed
end
service 'grafana-agent-flow' do
service_name 'grafana-agent-flow'
service 'grafana-alloy' do
service_name 'grafana-alloy'
action [:enable, :start]
end
```

## Configuration

The `grafana-agent-flow` package installs a default configuration file that doesn't send telemetry anywhere.
The `grafana-alloy` package installs a default configuration file that doesn't send telemetry anywhere.
The default configuration file location is `/etc/grafana-agent-flow.river`. You can replace this file with your own configuration or create a new configuration file for the service to use.
The default configuration file location is `/etc/grafana-alloy.river`. You can replace this file with your own configuration or create a new configuration file for the service to use.
## Next steps
Expand Down
16 changes: 7 additions & 9 deletions docs/sources/get-started/install/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,10 @@ To run {{< param "PRODUCT_NAME" >}} as a Linux Docker container, run the followi

```shell
docker run \
-e AGENT_MODE=flow \
-v <CONFIG_FILE_PATH>:/etc/agent/config.river \
-v <CONFIG_FILE_PATH>:/etc/alloy/config.river \
-p 12345:12345 \
grafana/agent:latest \
run --server.http.listen-addr=0.0.0.0:12345 /etc/agent/config.river
grafana/alloy:latest \
run --server.http.listen-addr=0.0.0.0:12345 /etc/alloy/config.river
```

Replace the following:
Expand All @@ -56,11 +55,10 @@ To run {{< param "PRODUCT_NAME" >}} as a Windows Docker container, run the follo

```shell
docker run \
-e AGENT_MODE=flow \
-v <CONFIG_FILE_PATH>:C:\etc\grafana-agent\config.river \
-v <CONFIG_FILE_PATH>:C:\etc\grafana-alloy\config.river \
-p 12345:12345 \
grafana/agent:latest-windows \
run --server.http.listen-addr=0.0.0.0:12345 C:\etc\grafana-agent\config.river
grafana/alloy:latest-windows \
run --server.http.listen-addr=0.0.0.0:12345 C:\etc\grafana-alloy\config.river
```

Replace the following:
Expand All @@ -83,4 +81,4 @@ To verify that {{< param "PRODUCT_NAME" >}} is running successfully, navigate to
[Windows containers]: #run-a-windows-docker-container
[Docker]: https://docker.io
[run]: ../../../reference/cli/run/
[UI]: ../../../tasks/debug/#grafana-agent-flow-ui
[UI]: ../../../tasks/debug/#grafana-alloy-ui
10 changes: 5 additions & 5 deletions docs/sources/get-started/install/kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
canonical: https://grafana.com/docs/alloy/latest/get-started/install/kubernetes/
description: Learn how to deploy Grafana Agent Flow on Kubernetes
description: Learn how to deploy Grafana Alloy on Kubernetes
menuTitle: Kubernetes
title: Deploy Grafana Agent Flow on Kubernetes
title: Deploy Grafana Alloy on Kubernetes
weight: 200
---

Expand Down Expand Up @@ -35,12 +35,12 @@ To deploy {{< param "PRODUCT_ROOT_NAME" >}} on Kubernetes using Helm, run the fo
1. Install {{< param "PRODUCT_ROOT_NAME" >}}:

```shell
helm install <RELEASE_NAME> grafana/grafana-agent
helm install <RELEASE_NAME> grafana/grafana-alloy
```

Replace the following:

- _`<RELEASE_NAME>`_: The name to use for your {{< param "PRODUCT_ROOT_NAME" >}} installation, such as `grafana-agent-flow`.
- _`<RELEASE_NAME>`_: The name to use for your {{< param "PRODUCT_ROOT_NAME" >}} installation, such as `grafana-alloy`.

For more information on the {{< param "PRODUCT_ROOT_NAME" >}} Helm chart, refer to the Helm chart documentation on [Artifact Hub][].

Expand All @@ -49,5 +49,5 @@ For more information on the {{< param "PRODUCT_ROOT_NAME" >}} Helm chart, refer
- [Configure {{< param "PRODUCT_NAME" >}}][Configure]

[Helm]: https://helm.sh
[Artifact Hub]: https://artifacthub.io/packages/helm/grafana/grafana-agent
[Artifact Hub]: https://artifacthub.io/packages/helm/grafana/grafana-alloy
[Configure]: ../../../tasks/configure/configure-kubernetes/
14 changes: 7 additions & 7 deletions docs/sources/get-started/install/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ sslcacert=/etc/pki/tls/certs/ca-bundle.crt' | sudo tee /etc/yum.repos.d/grafana.

{{< code >}}
```debian-ubuntu
sudo apt-get install grafana-agent-flow
sudo apt-get install grafana-alloy
```

```rhel-fedora
sudo dnf install grafana-agent-flow
sudo dnf install grafana-alloy
```

```suse-opensuse
sudo zypper install grafana-agent-flow
sudo zypper install grafana-alloy
```
{{< /code >}}

Expand All @@ -76,22 +76,22 @@ To uninstall {{< param "PRODUCT_NAME" >}} on Linux, run the following commands i
1. Stop the systemd service for {{< param "PRODUCT_NAME" >}}.

```All-distros
sudo systemctl stop grafana-agent-flow
sudo systemctl stop grafana-alloy
```

1. Uninstall {{< param "PRODUCT_NAME" >}}.

{{< code >}}
```debian-ubuntu
sudo apt-get remove grafana-agent-flow
sudo apt-get remove grafana-alloy
```

```rhel-fedora
sudo dnf remove grafana-agent-flow
sudo dnf remove grafana-alloy
```

```suse-opensuse
sudo zypper remove grafana-agent-flow
sudo zypper remove grafana-alloy
```
{{< /code >}}

Expand Down
8 changes: 4 additions & 4 deletions docs/sources/get-started/install/macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To install {{< param "PRODUCT_NAME" >}} on macOS, run the following commands in
1. Install {{< param "PRODUCT_NAME" >}}:

```shell
brew install grafana-agent-flow
brew install grafana-alloy
```

## Upgrade
Expand All @@ -43,21 +43,21 @@ To upgrade {{< param "PRODUCT_NAME" >}} on macOS, run the following commands in
1. Upgrade {{< param "PRODUCT_NAME" >}}:

```shell
brew upgrade grafana-agent-flow
brew upgrade grafana-alloy
```

1. Restart {{< param "PRODUCT_NAME" >}}:

```shell
brew services restart grafana-agent-flow
brew services restart grafana-alloy
```

## Uninstall

To uninstall {{< param "PRODUCT_NAME" >}} on macOS, run the following command in a terminal window:

```shell
brew uninstall grafana-agent-flow
brew uninstall grafana-alloy
```

## Next steps
Expand Down
22 changes: 11 additions & 11 deletions docs/sources/get-started/install/puppet.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
canonical: https://grafana.com/docs/alloy/latest/get-started/install/puppet/
description: Learn how to install Grafana Agent Flow with Puppet
description: Learn how to install Grafana Alloy with Puppet
menuTitle: Puppet
title: Install Grafana Agent Flow with Puppet
title: Install Grafana Alloy with Puppet
weight: 560
---

Expand Down Expand Up @@ -49,13 +49,13 @@ To add {{< param "PRODUCT_NAME" >}} to a host:
id => 'B53AE77BADB630A683046005963FA27710458545',
source => 'https://apt.grafana.com/gpg.key',
},
} -> package { 'grafana-agent-flow':
} -> package { 'grafana-alloy':
require => Exec['apt_update'],
} -> service { 'grafana-agent-flow':
} -> service { 'grafana-alloy':
ensure => running,
name => 'grafana-agent-flow',
name => 'grafana-alloy',
enable => true,
subscribe => Package['grafana-agent-flow'],
subscribe => Package['grafana-alloy'],
}
}
'redhat': {
Expand All @@ -68,12 +68,12 @@ To add {{< param "PRODUCT_NAME" >}} to a host:
enabled => '1',
gpgcheck => '1',
target => '/etc/yum.repo.d/grafana.repo',
} -> package { 'grafana-agent-flow':
} -> service { 'grafana-agent-flow':
} -> package { 'grafana-alloy':
} -> service { 'grafana-alloy':
ensure => running,
name => 'grafana-agent-flow',
name => 'grafana-alloy',
enable => true,
subscribe => Package['grafana-agent-flow'],
subscribe => Package['grafana-alloy'],
}
}
default: {
Expand All @@ -86,7 +86,7 @@ To add {{< param "PRODUCT_NAME" >}} to a host:
1. To use this class in a module, add the following line to the module's `init.pp` file:

```ruby
include grafana_agent::grafana_agent_flow
include grafana_alloy::grafana_alloy
```

## Configuration
Expand Down
14 changes: 7 additions & 7 deletions docs/sources/get-started/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ To do a standard graphical install of {{< param "PRODUCT_NAME" >}} on Windows, p

1. Scroll down to the **Assets** section.

1. Download the file called `grafana-agent-flow-installer.exe.zip`.
1. Download the file called `grafana-alloy-installer.exe.zip`.

1. Unzip the downloaded file.

1. Double-click on `grafana-agent-installer.exe` to install {{< param "PRODUCT_NAME" >}}.
1. Double-click on `grafana-alloy-installer.exe` to install {{< param "PRODUCT_NAME" >}}.

{{< param "PRODUCT_NAME" >}} is installed into the default directory `C:\Program Files\Grafana Agent Flow`.
{{< param "PRODUCT_NAME" >}} is installed into the default directory `C:\Program Files\Grafana Alloy`.

## Silent install

Expand All @@ -34,7 +34,7 @@ To do a silent install of {{< param "PRODUCT_NAME" >}} on Windows, perform the f

1. Scroll down to the **Assets** section.

1. Download the file called `grafana-agent-flow-installer.exe.zip`.
1. Download the file called `grafana-alloy-installer.exe.zip`.

1. Unzip the downloaded file.

Expand All @@ -57,10 +57,10 @@ To do a silent install of {{< param "PRODUCT_NAME" >}} on Windows, perform the f

## Service Configuration

{{< param "PRODUCT_NAME" >}} uses the Windows Registry `HKLM\Software\Grafana\Grafana Agent Flow` for service configuration.
{{< param "PRODUCT_NAME" >}} uses the Windows Registry `HKLM\Software\Grafana\Grafana Alloy` for service configuration.

* `Arguments` (Type `REG_MULTI_SZ`) Each value represents a binary argument for grafana-agent-flow binary.
* `Environment` (Type `REG_MULTI_SZ`) Each value represents a environment value `KEY=VALUE` for grafana-agent-flow binary.
* `Arguments` (Type `REG_MULTI_SZ`) Each value represents a binary argument for grafana-alloy binary.
* `Environment` (Type `REG_MULTI_SZ`) Each value represents a environment value `KEY=VALUE` for grafana-alloy binary.

## Uninstall

Expand Down
Loading

0 comments on commit 69d4e55

Please sign in to comment.