docs(env): fix env page and both agent pages (#3778)

* docs(envs): fix envs and start work on agent fixes * docs(env): fix cloud agent docs and images * Update docs/docs/concepts/cloud-agent.mdx Co-authored-by: Julianne Fermi <[email protected]> --------- Co-authored-by: Julianne Fermi <[email protected]>
kubeshop · Apr 9, 2024 · 823e609 · 823e609
1 parent aecf0ab
commit 823e609
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 24 deletions.
diff --git a/docs/docs/concepts/agent.mdx b/docs/docs/concepts/agent.mdx
@@ -1,6 +1,6 @@
 ---
 id: agent
-title: Tracetest Agent
+title: Tracetest Agent (Private Access)
 description: The Tracetest Agent enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. Learn about Tracetest Agent concepts and how it works when running in your environment as an executable, Docker container, or in your Cloud Native infrastructure.
 keywords:
   - tracetest
@@ -11,7 +11,25 @@ keywords:
 image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
 ---
 
-The Tracetest Agent enables Tracetest to access your application under test and to ingest trace data from your OpenTelemetry Collector or tracing backend. It's a lightweight, dependency-free, agent that runs in your environment as an executable, Docker container, or in your Cloud Native infrastructure.
+This page explains how Tracetest accesses your private application (VPC, firewall, etc.) and its traces to run tests.
+
+If your application is in a private environment, you will use the Tracetest Agent in your environment to run tests and ingest trace data from your OpenTelemetry Collector or tracing backend.
+
+Tracetest Agent is a lightweight, dependency-free, agent that runs in your environment as an executable, Docker container, or in your Cloud Native infrastructure.
+
+If you have a [publicly accessible application, then view this page](/concepts/cloud-agent).
+
+## Get Started
+
+Go to your Environment Agent Settings page.
+
+![Agent Settings](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712586955/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_597cf82c754c2a01_settings_ykn53w.png)
+
+Select **"Application is in a private environment"**. Use the `--api-key` to run the Tracetest Agent in your environment.
+
+![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712587335/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_597cf82c754c2a01_settings_1_iumdfz.png)
+
+Configure the tracing backend you're using via the tracing backend tab or use the supplied OTLP endpoints to alter your OpenTelemetry Collector configuration to send trace information via either gRPC or HTTP directly to Tracetest.
 
 ## How It Works
 

diff --git a/docs/docs/concepts/cloud-agent.mdx b/docs/docs/concepts/cloud-agent.mdx
@@ -1,6 +1,6 @@
 ---
 id: cloud-agent
-title: Tracetest Cloud Agent (Beta)
+title: Tracetest Cloud Agent (Public Access)
 description: Tracetest Cloud Agent allows you to run Tracetest tests against public facing endpoints without deploying the Tracetest Agent.
 keywords:
   - tracetest
@@ -14,35 +14,32 @@ keywords:
 image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_Thumbnail_14_rsvkmo.jpg
 ---
 
-Tracetest Cloud Agent allows you to run Tracetest tests against public facing endpoints without deploying the Tracetest Agent. This allowing you to trigger tests against public endpoints and collect traces information from either public trace data stores or, alternatively, directly receive incoming OTLP data.
+This page explains how Tracetest accesses your public application and its traces to run tests.
 
-## Opt-In
+If your application is public, you will use the Tracetest Cloud Agent to run tests and ingest trace data from your OpenTelemetry Collector or tracing backend.
 
-### Prerequisites
+The Tracetest Cloud Agent allows you to run Tracetest tests against public facing endpoints without deploying the Tracetest Agent locally. This allows you to trigger tests against public endpoints and collect trace data from either public tracing backends or, alternatively, directly receive incoming OTLP data.
 
-- Not supported for **localMode**.
-- Having Admin level access to the Environment.
+Tracetest Cloud Agent is the same as [Tracetest Agent](/concepts/agent) but is managed and running as part of your Tracetest account.
 
-### Steps
+If you have a [publicly accessible application, then view this page](/concepts/cloud-agent).
 
-Go to your Environment Agent Settings page:
+## Get Started
 
-![Agent Settings](../img/agent-settings-0.14.png)
+Go to your Environment Agent Settings page.
 
-Turn the **Run Agent on the Cloud** switch on:
+![Agent Settings](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712602150/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_597cf82c754c2a01_settings_2_bs2zc9.png)
 
-![Agent Settings Switch](../img/agent-settings-switch-0.14.png)
+Select **"Application is publicly accessible"**. This will start an instance of Tracetest Agent in your Tracetest Account.
 
-Wait for the Agent information is ready:
+![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712602455/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_597cf82c754c2a01_settings_3_xyexhw.png)
 
-![Cloud Agent](../img/agent-settings-cloud-0.14.png)
-
-Configure the public trace data store that the trace data is being written into via the configure data store tab or use the supplied OTLP endpoints to alter your OTel Collector configuration to send trace information via either gRPC or HTTP directly to Tracetest.io.
+Configure the publicly accessible tracing backend you're using via the tracing backend tab or use the supplied OTLP endpoints to alter your OpenTelemetry Collector configuration to send trace information via either gRPC or HTTP directly to Tracetest.
 
 ## How It Works
 
 - Tracetest Cloud Agent executes tests from [Tracetest](https://app.tracetest.io), so it must be able to reach the public endpoint. It gathers the response from the trigger and updates the test run.
-- Tracetest Cloud Agent listens on OTLP ports 4317 (gRPC) and 4318 (HTTP) for OpenTelemetry trace spans to capture distributed trace data and relay it to [Tracetest](https://app.tracetest.io).
+- Tracetest Cloud Agent listens on port `443` (both gRPC and HTTP) for OpenTelemetry trace spans to capture distributed trace data and relay it to [Tracetest](https://app.tracetest.io).
 - Alternatively, the Tracetest Cloud Agent can gather the associated trace data from a publicly reachable trace data store. Eg. a Grafana Cloud Tempo instance which has been configured for this environment via the Configure Data Store tab.
 - With both the response and trace, you build tests and create assertions with data from either or both of them.
 

diff --git a/docs/docs/concepts/environments.mdx b/docs/docs/concepts/environments.mdx
@@ -14,12 +14,14 @@ image: https://res.cloudinary.com/djwdcmwdz/image/upload/v1698686403/docs/Blog_T
 
 Environments are workspaces where you keep tests, test suites, variable sets, and all other Tracetest resources.
 
-![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1697028288/docs/app.tracetest.io_organizations_ttorg_7e8e767d64dbdb25_environments_ttenv_a39dc7d303f25454_settings_iebfhs.png)
+![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712585521/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_231b49e808c29e6a_2_wgg8zl.png)
 
-Connect an Agent and/or Trace Data Store to an environment to start creating tests.
+Create additional environments by clicking the `+ Create a New Environment` button.
 
-You get a `localMode` environment by default. This environment is dedicated to your local development environment for you to play around with while developing your apps.
+Connect Tracetest Agent and/or a tracing backend to an environment to start creating tests.
 
-Create additional environments by clicking the `+ Create a New Environment` button.
+![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712585314/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_231b49e808c29e6a_uhn9t6.png)
 
 Additional environments can be shared between team members, or used as dedicated environments for QA, staging, test, production, or any other shared environment of your choosing.
+
+![](https://res.cloudinary.com/djwdcmwdz/image/upload/v1712585450/docs/app.tracetest.io_organizations_ttorg_2179a9cd8ba8dfa5_environments_ttenv_231b49e808c29e6a_1_d0qwxl.png)
diff --git a/docs/docs/img/agent-settings-0.14.png b/docs/docs/img/agent-settings-0.14.png
diff --git a/docs/docs/img/agent-settings-cloud-0.14.png b/docs/docs/img/agent-settings-cloud-0.14.png
diff --git a/docs/docs/img/agent-settings-switch-0.14.png b/docs/docs/img/agent-settings-switch-0.14.png
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -701,12 +701,12 @@ const sidebars = {
         {
           type: "doc",
           id: "concepts/agent",
-          label: "Tracetest Agent",
+          label: "Tracetest Agent (Private Access)",
         },
         {
           type: "doc",
           id: "concepts/cloud-agent",
-          label: "Tracetest Cloud Agent (Beta)",
+          label: "Tracetest Cloud Agent (Public Access)",
         },
         {
           type: "doc",