Some improvements to install-agent.mdx (#5702)

* Broke up a step. Some small fixes. * Typo. * Small fixes. * Update advocacy_docs/edb-postgres-ai/console/agent/install-agent.mdx Co-authored-by: Dj Walker-Morgan <[email protected]> * Update advocacy_docs/edb-postgres-ai/console/agent/install-agent.mdx Co-authored-by: Dj Walker-Morgan <[email protected]> --------- Co-authored-by: Dj Walker-Morgan <[email protected]>
EnterpriseDB · May 29, 2024 · e5a9f1b · e5a9f1b · github-actions · May 29, 2024
1 parent 63bc661
commit e5a9f1b
Showing 1 changed file with 21 additions and 10 deletions.
diff --git a/advocacy_docs/edb-postgres-ai/console/agent/install-agent.mdx b/advocacy_docs/edb-postgres-ai/console/agent/install-agent.mdx
@@ -14,18 +14,25 @@ Before you begin, you need to have the following:
 
     First, find your EnterpriseDB Repos 2.0 token [here](https://www.enterprisedb.com/repos-downloads).
 
-    Next, download and run a script to configure your system to access the `beacon-agent` package from the repository. Be sure to replace `<your-token>` with your EDB Repos 2.0 token and replace `<your-subscription-type>` with your subscription type (`standard` or `enterprise`):
+    Next, set environmental variables for your repos subscription token and your EDB subscription type (standard or enterprise):
+
+    ```
+    export EDB_SUBSCRIPTION_TOKEN=<your-repos-token>
+    export EBD_SUBSCRIPTION_TYPE=<your-subscription-type>
+    ```
+
+    Then, download and run a script to configure your system to access the `beacon-agent` package from the repository. Be sure to replace `<your-token>` with your EDB Repos 2.0 token and replace `<your-subscription-type>` with your subscription type (`standard` or `enterprise`):
 
     For RHEL-like or SLES:
 
     ```
-    curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/<your-subscription-type>/setup.rpm.sh' | sudo -E bash
+    curl -1sSLf 'https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_SUBSCRIPTION_TYPE/setup.rpm.sh' | sudo -E bash
     ```
 
     For Debian or Ubuntu:
 
     ```
-    curl -1sLf 'https://downloads.enterprisedb.com/<your-token>/<your-subscription-type>>/setup.deb.sh' | sudo -E bash
+    curl -1sSLf 'https://downloads.enterprisedb.com/$EDB_SUBSCRIPTION_TOKEN/$EDB_SUBSCRIPTION_TYPE/setup.deb.sh' | sudo -E bash
     ```
 
 2. Install the `beacon-agent` package:
@@ -62,17 +69,21 @@ Before you begin, you need to have the following:
     mkdir ${HOME}/.beacon
     ```
 
-    Next, configure Beacon Agent by setting the access key (the one you obtained the [Creating a machine user]](create_machine_user)) and project ID, and specify the Beacon config directory for storing the configuration file created. Use the following commands:
-
-    ```
+    Next, configure Beacon Agent by setting the access key (the one you obtained the [Creating a machine user](create_machine_user)) and project ID:
+    
+     ```
     export BEACON_AGENT_ACCESS_KEY=<your-access-key>
     export BEACON_AGENT_PROJECT_ID=<your-project-id>
-    beacon-agent setup -file="$HOME/.beacon/beacon_agent.yaml"
     ```
+
+
+   Then, specify the Beacon config directory for storing the configuration file and the name of the configuration file to be created there.
 
-    These commands set up the necessary parameters for Beacon Agent and execute the setup command to generate the configuration file(`beacon_agent.yaml) in the specified directory.
+    ```
+    beacon-agent setup -file="$HOME/.beacon/beacon_agent.yaml"
+    ```
 
-    During this setup process, an authentication attempt occurs, utilizing the provided access key and project ID. This authentication is necessary for Beacon Agent to communicate with the Beacon server and register with the project successfully.
+    During the `beacon-agent setup` process, an authentication attempt occurs, utilizing the provided access key and project ID. This authentication is necessary for Beacon Agent to communicate with the Beacon server and register with the project successfully.
 
     If the commands execute as expected, you should see a message indicating that you have authenticated successfully to your EDB Postgres AI project.
 
@@ -121,7 +132,7 @@ provider:
           - "foo"
           - "bar"
     host:
-      resource_id: "Johns-MBP.lan"
+      resource_id: "postgresql.lan"
       tags: []
     poll_interval: 5m0s
 ```