From efee85a2eb30db48d2792caadc02d9dd8b363897 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:22:30 -0500 Subject: [PATCH 01/25] Adding provisioning and server db config docs Adding provisioning and server db config docs --- docs/docs/configuration/overview.md | 8 ++-- docs/docs/configuration/provisioning.md | 50 +++++++++++++++++++++++++ docs/docs/configuration/server.md | 29 ++++++++++++++ docs/sidebars.js | 10 +++++ 4 files changed, 92 insertions(+), 5 deletions(-) create mode 100644 docs/docs/configuration/provisioning.md create mode 100644 docs/docs/configuration/server.md diff --git a/docs/docs/configuration/overview.md b/docs/docs/configuration/overview.md index a6e7b25d62..3c780768bc 100644 --- a/docs/docs/configuration/overview.md +++ b/docs/docs/configuration/overview.md @@ -1,10 +1,8 @@ # Configuration Overview -There is one way you can set configuration options in Tracetest. By using a configuration file, commonly known as the `tracetest.config.yaml` file. - -When using Docker, ensure that the configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. - - +There are several configuration options with Tracetest: +- [Server configuration](./server) to set database connection information needed to connect to required PostgreSQL instance. +- [Provisioning configuration](./provisioning) to 'preload' the Tracetest server with resources when first running the Tracetest server. ## Supported Trace Data Stores diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md new file mode 100644 index 0000000000..41ae8a5bb8 --- /dev/null +++ b/docs/docs/configuration/provisioning.md @@ -0,0 +1,50 @@ +# Provisioning server + +Tracetest allows a server to be provisioned the first time a new Tracetest server is installed and launched. Provisioning sets certain resources in the server to the specified values, allowing you to configure the server. It is convenient in a CI/CD flow where you want to launch a server with a specified configuration. + +The server is provisioned by specifying a series of yaml snippets which will configure various resources. Each snippet is separated with the yaml separator, ---. + +Currently, the following resources can be provisioned: +- DataStore +- PollingProfile +- Config +- Demo + +For docker based installs, the provisioning file is placed in the ./tracetest/tracetest-provisioning.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The first time you start tracetest with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to provision the server. To provision differently, you would alter the contents of the tracetest-provisioning.yaml file before launching tracetest in docker. + +This is an example of a tracetest-provisioning.yaml file: + +```yaml +--- +type: DataStore +spec: + name: otlp + type: otlp + otlp: + type: otlp +--- +type: Config +spec: + analyticsEnabled: true +--- +type: PollingProfile +spec: + name: Custom Profile + strategy: periodic + default: true + periodic: + timeout: 2m + retryDelay: 3s +--- +type: Demo +spec: + name: pokeshop + type: pokeshop + enabled: true + pokeshop: + httpEndpoint: http://demo-api:8081 + grpcEndpoint: demo-api:8082 +``` + +Alternatively, we support setting an environment variable called TRACETEST_PROVISIONING to provision the server when it first is started. Take the provisioning YAML you want to utilize, base64 encode it, and set the TRACETEST_PROVISIONING environment variable with the result. The Tracetest server will then provision based on the base64 encoded provisioning data in this environment variable the first time it is launched. + diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md new file mode 100644 index 0000000000..d5e9d85605 --- /dev/null +++ b/docs/docs/configuration/server.md @@ -0,0 +1,29 @@ +# Configuring the Tracetest server + +Tracetest requires a very minimal configuration to be launched, needing just the connection information to connect with the PostgreSQL database which is installed as part of the server install. There are a couple ways to provide this database connection information. + +For docker based installs, the server configuration file is placed in the ./tracetest/tracetest.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When tracetest is run with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. + +This is an example of a tracetest.yaml file: + +```yaml +postgres: + host: postgres + user: postgres + password: postgres + port: 5432 + dbname: postgres + params: sslmode=disable +``` + +Alternatively, we support setting ana series of environment variables which can contain the connection information for the Postgres instance. If these environment variables are set, they will be used by the Tracetest server to connect to the database. The variables are: + +The list of environment variables, and example values is: +- TRACETEST_POSTGRES_HOST - example: postgres +- TRACETEST_POSTGRES_PORT - example: 5432 +- TRACETEST_POSTGRES_DBNAME - example: postgres +- TRACETEST_POSTGRES_USER - example: postgres +- TRACETEST_POSTGRES_PASSWORD - example: postgres + +You can also 'hydrate' the server with a number of resources the first time it is launched by using [provisioning](./provisioning). + diff --git a/docs/sidebars.js b/docs/sidebars.js index e084308965..4d14a49b36 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -119,6 +119,16 @@ const sidebars = { id: "configuration/opentelemetry-collector-configuration-file-reference", label: "OpenTelemetry Collector Configuration File Reference", }, + { + type: "doc", + id: "configuration/server", + label: "Tracetest Server Configuration", + }, + { + type: "doc", + id: "configuration/provisioning", + label: "Provisioning Server", + }, { type: "doc", id: "configuration/trace-polling", From e7b6e3a3d344cde7a7d4f775ac4a9f2a29c99c5b Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:47:21 -0500 Subject: [PATCH 02/25] Update docs/docs/configuration/provisioning.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index 41ae8a5bb8..9daee2e764 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -2,7 +2,7 @@ Tracetest allows a server to be provisioned the first time a new Tracetest server is installed and launched. Provisioning sets certain resources in the server to the specified values, allowing you to configure the server. It is convenient in a CI/CD flow where you want to launch a server with a specified configuration. -The server is provisioned by specifying a series of yaml snippets which will configure various resources. Each snippet is separated with the yaml separator, ---. +The server is provisioned by specifying a series of YAML snippets which will configure various resources. Each snippet is separated with the YAML separator, ---. Currently, the following resources can be provisioned: - DataStore From d427433390165818fb019a3ac01b926abd1981dc Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:47:53 -0500 Subject: [PATCH 03/25] Update docs/docs/configuration/provisioning.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index 9daee2e764..1e72718324 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -10,7 +10,7 @@ Currently, the following resources can be provisioned: - Config - Demo -For docker based installs, the provisioning file is placed in the ./tracetest/tracetest-provisioning.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The first time you start tracetest with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to provision the server. To provision differently, you would alter the contents of the tracetest-provisioning.yaml file before launching tracetest in docker. +For Docker based installs, the provisioning file is placed in the ./tracetest/tracetest-provisioning.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The first time you start Tracetest with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to provision the server. To provision differently, you would alter the contents of the tracetest-provisioning.yaml file before launching Tracetest in Docker. This is an example of a tracetest-provisioning.yaml file: From 227327807ec11d47a8e8efa4b40681810a147360 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:48:08 -0500 Subject: [PATCH 04/25] Update docs/docs/configuration/server.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index d5e9d85605..51d73557a4 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -1,4 +1,4 @@ -# Configuring the Tracetest server +# Configuring the Tracetest Server Tracetest requires a very minimal configuration to be launched, needing just the connection information to connect with the PostgreSQL database which is installed as part of the server install. There are a couple ways to provide this database connection information. From 270b10db0482fcd5a946f4d19668dbd72ef7ce25 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:48:23 -0500 Subject: [PATCH 05/25] Update docs/docs/configuration/server.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 51d73557a4..89db19e206 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -2,7 +2,7 @@ Tracetest requires a very minimal configuration to be launched, needing just the connection information to connect with the PostgreSQL database which is installed as part of the server install. There are a couple ways to provide this database connection information. -For docker based installs, the server configuration file is placed in the ./tracetest/tracetest.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When tracetest is run with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. +For Docker-based installs, the server configuration file is placed in the ./tracetest/tracetest.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When Tracetest is run with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. This is an example of a tracetest.yaml file: From 8c56841f6c8eead9fc4166a6c1e8865d7c49a681 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:48:58 -0500 Subject: [PATCH 06/25] Update docs/docs/configuration/server.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 89db19e206..a2f89d48e2 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -16,7 +16,7 @@ postgres: params: sslmode=disable ``` -Alternatively, we support setting ana series of environment variables which can contain the connection information for the Postgres instance. If these environment variables are set, they will be used by the Tracetest server to connect to the database. The variables are: +Alternatively, we support setting a series of environment variables which can contain the connection information for the Postgres instance. If these environment variables are set, they will be used by the Tracetest server to connect to the database. The list of environment variables, and example values is: - TRACETEST_POSTGRES_HOST - example: postgres From dae2477f80565cf4386057bfba3d74ec6b7e90e7 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:49:13 -0500 Subject: [PATCH 07/25] Update docs/docs/configuration/server.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index a2f89d48e2..3dc4e11c6c 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -18,7 +18,7 @@ postgres: Alternatively, we support setting a series of environment variables which can contain the connection information for the Postgres instance. If these environment variables are set, they will be used by the Tracetest server to connect to the database. -The list of environment variables, and example values is: +The list of environment variables and example values is: - TRACETEST_POSTGRES_HOST - example: postgres - TRACETEST_POSTGRES_PORT - example: 5432 - TRACETEST_POSTGRES_DBNAME - example: postgres From 04f9233727daf9521b812079b36c30b2cf517b8b Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:50:48 -0500 Subject: [PATCH 08/25] Update docs/docs/configuration/provisioning.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index 1e72718324..e9247f3d5a 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -46,5 +46,5 @@ spec: grpcEndpoint: demo-api:8082 ``` -Alternatively, we support setting an environment variable called TRACETEST_PROVISIONING to provision the server when it first is started. Take the provisioning YAML you want to utilize, base64 encode it, and set the TRACETEST_PROVISIONING environment variable with the result. The Tracetest server will then provision based on the base64 encoded provisioning data in this environment variable the first time it is launched. +Alternatively, we support setting an environment variable called TRACETEST_PROVISIONING to provision the server when it is first started. Base64 encode the provisioning YAML you want to utilize and set the TRACETEST_PROVISIONING environment variable with the result. The Tracetest server will then provision based on the Base64 encoded provisioning data in this environment variable the first time it is launched. From 19880b8ef3acc89145473a4098ec0eadf607574b Mon Sep 17 00:00:00 2001 From: kdhamric Date: Wed, 5 Apr 2023 19:51:02 -0500 Subject: [PATCH 09/25] Update docs/docs/configuration/server.md Co-authored-by: Julianne Fermi --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 3dc4e11c6c..e55fbf23e8 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -1,6 +1,6 @@ # Configuring the Tracetest Server -Tracetest requires a very minimal configuration to be launched, needing just the connection information to connect with the PostgreSQL database which is installed as part of the server install. There are a couple ways to provide this database connection information. +Tracetest requires a very minimal configuration to be launched, needing just the connection information to connect with the PostgreSQL database which is installed as part of the server install. There are a couple of ways to provide this database connection information. For Docker-based installs, the server configuration file is placed in the ./tracetest/tracetest.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When Tracetest is run with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. From bf15ba242a7ba510276021fb6293d16833034864 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:15:06 -0500 Subject: [PATCH 10/25] Update docs/docs/configuration/provisioning.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index e9247f3d5a..da1e8bfd2c 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -2,7 +2,7 @@ Tracetest allows a server to be provisioned the first time a new Tracetest server is installed and launched. Provisioning sets certain resources in the server to the specified values, allowing you to configure the server. It is convenient in a CI/CD flow where you want to launch a server with a specified configuration. -The server is provisioned by specifying a series of YAML snippets which will configure various resources. Each snippet is separated with the YAML separator, ---. +The server is provisioned by specifying a series of YAML snippets which will configure various resources. Each snippet is separated with the YAML separator, `---`. Currently, the following resources can be provisioned: - DataStore From d51629158b346b53cda101e7e192eb6d2c62eae9 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:15:36 -0500 Subject: [PATCH 11/25] Update docs/docs/configuration/provisioning.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index da1e8bfd2c..bf9944bbc6 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -10,7 +10,7 @@ Currently, the following resources can be provisioned: - Config - Demo -For Docker based installs, the provisioning file is placed in the ./tracetest/tracetest-provisioning.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The first time you start Tracetest with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to provision the server. To provision differently, you would alter the contents of the tracetest-provisioning.yaml file before launching Tracetest in Docker. +For Docker-based installs, the provisioning file is placed in the `./tracetest/tracetest-provisioning.yaml` file by default when you run the `tracetest server install` command and select the `Using Docker Compose` option. The first time you start Tracetest with a `docker compose -f tracetest/docker-compose.yaml up -d` command, the server will use the contents of this file to provision the server. To provision differently, you would alter the contents of the `tracetest-provisioning.yaml` file before launching Tracetest in Docker. This is an example of a tracetest-provisioning.yaml file: From ce2fc2993f6d6a0ddb9d8cbf2f2c0db9fb21829b Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:15:59 -0500 Subject: [PATCH 12/25] Update docs/docs/configuration/provisioning.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index bf9944bbc6..8acab32320 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -12,7 +12,7 @@ Currently, the following resources can be provisioned: For Docker-based installs, the provisioning file is placed in the `./tracetest/tracetest-provisioning.yaml` file by default when you run the `tracetest server install` command and select the `Using Docker Compose` option. The first time you start Tracetest with a `docker compose -f tracetest/docker-compose.yaml up -d` command, the server will use the contents of this file to provision the server. To provision differently, you would alter the contents of the `tracetest-provisioning.yaml` file before launching Tracetest in Docker. -This is an example of a tracetest-provisioning.yaml file: +This is an example of a `tracetest-provisioning.yaml` file: ```yaml --- From b715983f7b1f62527a341fc6f4647e77137b478a Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:16:09 -0500 Subject: [PATCH 13/25] Update docs/docs/configuration/provisioning.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/provisioning.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index 8acab32320..c0bfa1e0ca 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -46,5 +46,5 @@ spec: grpcEndpoint: demo-api:8082 ``` -Alternatively, we support setting an environment variable called TRACETEST_PROVISIONING to provision the server when it is first started. Base64 encode the provisioning YAML you want to utilize and set the TRACETEST_PROVISIONING environment variable with the result. The Tracetest server will then provision based on the Base64 encoded provisioning data in this environment variable the first time it is launched. +Alternatively, we support setting an environment variable called `TRACETEST_PROVISIONING` to provision the server when it is first started. Base64 encode the provisioning YAML you want to utilize and set the `TRACETEST_PROVISIONING` environment variable with the result. The Tracetest server will then provision based on the Base64 encoded provisioning data in this environment variable the first time it is launched. From 3124ee7ac5187e656f69bdfb46818c9cd12a5f6c Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:16:22 -0500 Subject: [PATCH 14/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index e55fbf23e8..bfacc07662 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -2,7 +2,7 @@ Tracetest requires a very minimal configuration to be launched, needing just the connection information to connect with the PostgreSQL database which is installed as part of the server install. There are a couple of ways to provide this database connection information. -For Docker-based installs, the server configuration file is placed in the ./tracetest/tracetest.yaml file by default when you run the 'tracetest server install' command and select the 'Using Docker Compose' option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When Tracetest is run with a 'docker compose -f tracetest/docker-compose.yaml up -d' command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. +For Docker-based installs, the server configuration file is placed in the `./tracetest/tracetest.yaml` file by default when you run the `tracetest server install` command and select the `Using Docker Compose` option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When Tracetest is run with a `docker compose -f tracetest/docker-compose.yaml up -d` command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. This is an example of a tracetest.yaml file: From 0e9c55181c8c22141f0813b6852e70fb9f156ed8 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:16:46 -0500 Subject: [PATCH 15/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index bfacc07662..7c3fd4c21b 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -21,7 +21,7 @@ Alternatively, we support setting a series of environment variables which can co The list of environment variables and example values is: - TRACETEST_POSTGRES_HOST - example: postgres - TRACETEST_POSTGRES_PORT - example: 5432 -- TRACETEST_POSTGRES_DBNAME - example: postgres +- `TRACETEST_POSTGRES_DBNAME: "postgres"` - TRACETEST_POSTGRES_USER - example: postgres - TRACETEST_POSTGRES_PASSWORD - example: postgres From f28f7634bb96dca1814bf0813b163984908c34cf Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:16:56 -0500 Subject: [PATCH 16/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 7c3fd4c21b..0962496c37 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -22,7 +22,7 @@ The list of environment variables and example values is: - TRACETEST_POSTGRES_HOST - example: postgres - TRACETEST_POSTGRES_PORT - example: 5432 - `TRACETEST_POSTGRES_DBNAME: "postgres"` -- TRACETEST_POSTGRES_USER - example: postgres +- `TRACETEST_POSTGRES_USER: "postgres"` - TRACETEST_POSTGRES_PASSWORD - example: postgres You can also 'hydrate' the server with a number of resources the first time it is launched by using [provisioning](./provisioning). From 965a23f04dd2905fdb6d8022c99d9e7d223839ff Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:17:04 -0500 Subject: [PATCH 17/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 0962496c37..62735c5167 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -23,7 +23,7 @@ The list of environment variables and example values is: - TRACETEST_POSTGRES_PORT - example: 5432 - `TRACETEST_POSTGRES_DBNAME: "postgres"` - `TRACETEST_POSTGRES_USER: "postgres"` -- TRACETEST_POSTGRES_PASSWORD - example: postgres +- `TRACETEST_POSTGRES_PASSWORD: "postgres"` You can also 'hydrate' the server with a number of resources the first time it is launched by using [provisioning](./provisioning). From b414d6771250e03c86a8f2420eeec34345ab2102 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:20:18 -0500 Subject: [PATCH 18/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 62735c5167..66655c2dba 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -25,5 +25,5 @@ The list of environment variables and example values is: - `TRACETEST_POSTGRES_USER: "postgres"` - `TRACETEST_POSTGRES_PASSWORD: "postgres"` -You can also 'hydrate' the server with a number of resources the first time it is launched by using [provisioning](./provisioning). +You can also provision the server with a number of resources the first time it is launched by using [provisioning](./provisioning). From bda8e47e2bc4604f80bf27763647bdaffa06dde3 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:20:40 -0500 Subject: [PATCH 19/25] Update docs/sidebars.js MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/sidebars.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sidebars.js b/docs/sidebars.js index 4d14a49b36..c0d435cd29 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -127,7 +127,7 @@ const sidebars = { { type: "doc", id: "configuration/provisioning", - label: "Provisioning Server", + label: "Provisioning a Tracetest Server", }, { type: "doc", From 2644606ffbf32890ebb9bcda35fb77b059e68f0b Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:21:19 -0500 Subject: [PATCH 20/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 66655c2dba..159f7697be 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -4,7 +4,7 @@ Tracetest requires a very minimal configuration to be launched, needing just the For Docker-based installs, the server configuration file is placed in the `./tracetest/tracetest.yaml` file by default when you run the `tracetest server install` command and select the `Using Docker Compose` option. The configuration file is mounted to `/app/config.yaml` within the Tracetest Docker container. When Tracetest is run with a `docker compose -f tracetest/docker-compose.yaml up -d` command, the server will use the contents of this file to connect to the Postgres database. All other configuration data is stored in the Postgres instance. -This is an example of a tracetest.yaml file: +This is an example of a `tracetest.yaml` file: ```yaml postgres: From f5d2623b1f48d8355d71b4a89d49607c1846842f Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:21:39 -0500 Subject: [PATCH 21/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 159f7697be..f24cda7a08 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -19,7 +19,7 @@ postgres: Alternatively, we support setting a series of environment variables which can contain the connection information for the Postgres instance. If these environment variables are set, they will be used by the Tracetest server to connect to the database. The list of environment variables and example values is: -- TRACETEST_POSTGRES_HOST - example: postgres +- `TRACETEST_POSTGRES_HOST: "postgres"` - TRACETEST_POSTGRES_PORT - example: 5432 - `TRACETEST_POSTGRES_DBNAME: "postgres"` - `TRACETEST_POSTGRES_USER: "postgres"` From 1975869bdd044e5f8517ff40da7cd5eb3637c981 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:21:52 -0500 Subject: [PATCH 22/25] Update docs/docs/configuration/server.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Adnan Rahić --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index f24cda7a08..2fc3f0a58a 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -20,7 +20,7 @@ Alternatively, we support setting a series of environment variables which can co The list of environment variables and example values is: - `TRACETEST_POSTGRES_HOST: "postgres"` -- TRACETEST_POSTGRES_PORT - example: 5432 +- `TRACETEST_POSTGRES_PORT: "5432"` - `TRACETEST_POSTGRES_DBNAME: "postgres"` - `TRACETEST_POSTGRES_USER: "postgres"` - `TRACETEST_POSTGRES_PASSWORD: "postgres"` From 8a74a65d9e12667fd275472b4c11c1876c8c3932 Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 11:26:09 -0500 Subject: [PATCH 23/25] Update server.md --- docs/docs/configuration/server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index 2fc3f0a58a..c267d43b61 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -25,5 +25,5 @@ The list of environment variables and example values is: - `TRACETEST_POSTGRES_USER: "postgres"` - `TRACETEST_POSTGRES_PASSWORD: "postgres"` -You can also provision the server with a number of resources the first time it is launched by using [provisioning](./provisioning). +You can also intitalize the server with a number of resources the first time it is launched by using [provisioning](./provisioning). From 711171627e3870c84af6ce172352027c01f315fa Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 12:37:28 -0500 Subject: [PATCH 24/25] Update docs/docs/configuration/provisioning.md Co-authored-by: Jorge Padilla --- docs/docs/configuration/provisioning.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/configuration/provisioning.md b/docs/docs/configuration/provisioning.md index c0bfa1e0ca..a4f4259954 100644 --- a/docs/docs/configuration/provisioning.md +++ b/docs/docs/configuration/provisioning.md @@ -20,8 +20,7 @@ type: DataStore spec: name: otlp type: otlp - otlp: - type: otlp + isdefault: true --- type: Config spec: From cd0d0266e530c0fd50b9a96f3e8e76fcd65fce2f Mon Sep 17 00:00:00 2001 From: kdhamric Date: Thu, 6 Apr 2023 12:40:09 -0500 Subject: [PATCH 25/25] Update server.md --- docs/docs/configuration/server.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/docs/configuration/server.md b/docs/docs/configuration/server.md index c267d43b61..79b93d53b1 100644 --- a/docs/docs/configuration/server.md +++ b/docs/docs/configuration/server.md @@ -24,6 +24,8 @@ The list of environment variables and example values is: - `TRACETEST_POSTGRES_DBNAME: "postgres"` - `TRACETEST_POSTGRES_USER: "postgres"` - `TRACETEST_POSTGRES_PASSWORD: "postgres"` +- `TRACETEST_POSTGRES_PARAMS: ""` + You can also intitalize the server with a number of resources the first time it is launched by using [provisioning](./provisioning).