Add task doc for chef (#6192)

* Add task doc for chef - Adds basic instructions to install Grafana Agent using Chef. - Fixes #5961 * Update docs/sources/flow/get-started/install/chef.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/flow/get-started/install/chef.md Co-authored-by: Clayton Cornell <[email protected]> * Update docs/sources/flow/get-started/install/chef.md Co-authored-by: Piotr <[email protected]> * Move link to the bottom and improve wording * Trigger CI --------- Co-authored-by: Clayton Cornell <[email protected]> Co-authored-by: Piotr <[email protected]>
grafana · Jan 22, 2024 · 42477fa · 42477fa
1 parent efb8144
commit 42477fa
Showing 1 changed file with 98 additions and 0 deletions.
diff --git a/docs/sources/flow/get-started/install/chef.md b/docs/sources/flow/get-started/install/chef.md
@@ -0,0 +1,98 @@
+---
+aliases:
+- /docs/grafana-cloud/agent/flow/get-started/install/chef/
+canonical: https://grafana.com/docs/agent/latest/flow/get-started/install/chef/
+description: Learn how to install Grafana Agent Flow with Chef
+menuTitle: Chef
+title: Install Grafana Agent Flow with Chef
+weight: 550
+---
+
+# Install {{% param "PRODUCT_NAME" %}} with Chef
+
+You can use Chef to install and manage {{< param "PRODUCT_NAME" >}}.
+
+## Before you begin
+
+- These steps assume you already have a working [Chef][] setup.
+- You can add the following resources to any new or existing recipe you choose.
+- These tasks install {{< param "PRODUCT_NAME" >}} from the package repositories. The tasks target Linux systems from the following families:
+  - Debian (including Ubuntu)
+  - RedHat Enterprise Linux
+  - Amazon Linux
+  - Fedora
+
+## Steps
+
+To add {{% param "PRODUCT_NAME" %}} to a host:
+
+1. Add the following resources to your [Chef][] recipe to add the Grafana package repositories to your system:
+    ```ruby
+    if platform_family?('debian', 'rhel', 'amazon', 'fedora')
+      if platform_family?('debian')
+        remote_file '/etc/apt/keyrings/grafana.gpg' do
+          source 'https://apt.grafana.com/gpg.key'
+          mode '0644'
+          action :create
+          end
+
+        file '/etc/apt/sources.list.d/grafana.list' do
+          content "deb [signed-by=/etc/apt/keyrings/grafana.gpg] https://apt.grafana.com/ stable main"
+          mode '0644'
+          notifies :update, 'apt_update[update apt cache]', :immediately
+        end
+
+        apt_update 'update apt cache' do
+          action :nothing
+        end
+      elsif platform_family?('rhel', 'amazon', 'fedora')
+        yum_repository 'grafana' do
+          description 'grafana'
+          baseurl 'https://rpm.grafana.com/oss/rpm'
+          gpgcheck true
+          gpgkey 'https://rpm.grafana.com/gpg.key'
+          enabled true
+          action :create
+          notifies :run, 'execute[add-rhel-key]', :immediately
+        end
+
+        execute 'add-rhel-key' do
+          command "rpm --import https://rpm.grafana.com/gpg.key"
+          action :nothing
+        end
+      end
+    else
+        fail "The #{node['platform_family']} platform is not supported."
+    end
+    ```
+1. Add the following resources to install and enable the `grafana-agent-flow` service:
+    ```ruby
+    package 'grafana-agent-flow' do
+      action :install
+      flush_cache [ :before ] if platform_family?('amazon', 'rhel', 'fedora')
+      notifies :restart, 'service[grafana-agent-flow]', :delayed
+    end
+
+    service 'grafana-agent-flow' do
+      service_name 'grafana-agent-flow'
+      action [:enable, :start]
+    end  
+    ```
+
+## Configuration
+
+The `grafana-agent-flow` 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. 
+
+## Next steps
+
+- [Configure {{< param "PRODUCT_NAME" >}}][Configure]
+
+[Chef]: https://www.chef.io/products/chef-infrastructure-management/
+
+{{% docs/reference %}}
+
+[Configure]: "/docs/agent/ -> /docs/agent/<AGENT_VERSION>/flow/tasks/configure/configure-linux.md"
+[Configure]: "/docs/grafana-cloud/ -> /docs/grafana-cloud/send-data/agent/flow/tasks/configure/configure-linux.md"
+{{% /docs/reference %}}