From 932d3e46f9de68d2353d41c5a1d42aa0066fe1d1 Mon Sep 17 00:00:00 2001 From: ksnavely Date: Tue, 5 Nov 2024 15:13:30 -0500 Subject: [PATCH] Updates beacon agent on-prem DSN examples --- .../console/estate/agent/beacon-agent-ref.mdx | 13 ++++---- .../console/estate/agent/install-agent.mdx | 31 +++++++++---------- 2 files changed, 20 insertions(+), 24 deletions(-) diff --git a/advocacy_docs/edb-postgres-ai/console/estate/agent/beacon-agent-ref.mdx b/advocacy_docs/edb-postgres-ai/console/estate/agent/beacon-agent-ref.mdx index 8a501c7b4a3..41a80d7ee60 100644 --- a/advocacy_docs/edb-postgres-ai/console/estate/agent/beacon-agent-ref.mdx +++ b/advocacy_docs/edb-postgres-ai/console/estate/agent/beacon-agent-ref.mdx @@ -29,7 +29,7 @@ beacon-agent [subcommand] [options] #### Description -Runs the Beacon agent. +Runs the Beacon agent. In default mode, with no subcommand, this runs the Beacon Agent process, which sends data ingestions to the Beacon Server and maintains a local log of its activities. @@ -53,7 +53,7 @@ beacon-agent [-file=] Start Beacon Agent: ``` -beacon-agent +beacon-agent ``` ### `setup` @@ -81,17 +81,17 @@ beacon-agent setup [-file=] |---------------------|---------------------------------------------------------------------------------------------------| | `-file=` | Sets the filename (and path) of the generated configuration file. (default `"beacon_agent.yaml"`) | | `-verify=` | Verifies the project's credentials with the Beacon server. | - + #### Examples ##### Creating a configuration file, without authentication - + ``` beacon-agent setup -verify=false ``` ##### Creating a configuration file with a different name - + ``` beacon-agent setup -file my_beacon_config.yaml ``` @@ -158,8 +158,7 @@ agent: provider: onprem: databases: - sales_reporting: - dsn: "$DSN" + - dsn: "$DSN" tags: - "foo" - "bar" diff --git a/advocacy_docs/edb-postgres-ai/console/estate/agent/install-agent.mdx b/advocacy_docs/edb-postgres-ai/console/estate/agent/install-agent.mdx index fa6d7c26ca0..f8a4a42be69 100644 --- a/advocacy_docs/edb-postgres-ai/console/estate/agent/install-agent.mdx +++ b/advocacy_docs/edb-postgres-ai/console/estate/agent/install-agent.mdx @@ -16,7 +16,7 @@ Before you begin, you need to have the following: You need to enable the system you are planning on running the agent on to download packages from the EDB repositories for EDB Postgres AI. -Locate your EDB subscription token on the the [EnterpriseDB repos download page](https://www.enterprisedb.com/repos-downloads). +Locate your EDB subscription token on the the [EnterpriseDB repos download page](https://www.enterprisedb.com/repos-downloads). Using the retrieved subscription token, set an environmental variables (`EDB_SUBSCRIPTION_TOKEN`) to the token's value. Also set an environmental variable for your EDB subscription type (`EDB_SUBSCRIPTION_TYPE`) to one of `standard` or `enterprise` depending on which plan you are signed up to: @@ -84,7 +84,7 @@ export BEACON_AGENT_PROJECT_ID= Running the `beacon-agent setup` command creates a configuration file in the Beacon configuration directory. using those environment variables. -You also need to specify the Beacon configuration directory for storing the configuration file and the name of the configuration file to generate there. The `$HOME/.beacon/` file is one of the default locations which `beacon_agent` searches for `beacon_agent.yaml` when it starts. Using the `-file` flag tells the agent setup process to create its configuration file in a specific location. +You also need to specify the Beacon configuration directory for storing the configuration file and the name of the configuration file to generate there. The `$HOME/.beacon/` file is one of the default locations which `beacon_agent` searches for `beacon_agent.yaml` when it starts. Using the `-file` flag tells the agent setup process to create its configuration file in a specific location. ``` beacon-agent setup -file="$HOME/.beacon/beacon_agent.yaml" @@ -114,16 +114,14 @@ Entries under `databases` utilize the following format: ```yaml databases: - : - dsn: "$DSN1" - tags: - - "" - - "" - : - dsn: "$DSN2" - tags: - - "" - - "" + - dsn: "$DSN1" + tags: + - "" + - "" + - dsn: "$DSN2" + tags: + - "" + - "" ``` Here is an example `beacon_agent.yaml` file configured for a database named `sales_reporting`: @@ -141,12 +139,11 @@ agent: - "onprem" provider: onprem: - databases: - sales_reporting: - dsn: "$DSN" + databases: + - dsn: “$DSN” tags: - - "sales" - - "reports" + - "sales" + - "reports" host: resource_id: "postgresql.lan" tags: []