Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] In-app agent request #10836

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from
+24 −26
Open

[DOCS] In-app agent request #10836

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4d4f61e
initial edits
klavavej Jan 9, 2025
b45db7c
proofread
klavavej Jan 9, 2025
cd6df34
Merge branch 'develop' into kml/DOC-1019/requestAgent
klavavej Jan 9, 2025
522e927
Update docs/docusaurus/docs/cloud/deploy/deploy_gx_agent.md
klavavej Jan 13, 2025
e0d55ed
Merge branch 'develop' into kml/DOC-1019/requestAgent
klavavej Jan 13, 2025
af16692
Merge branch 'develop' into kml/DOC-1019/requestAgent
klavavej Jan 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 24 additions & 26 deletions docs/docusaurus/docs/cloud/deploy/deploy_gx_agent.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Deploy the GX Agent'
id: deploy_gx_agent
description: Deploy the GX Agent to use GX Cloud features and functionality.
description: Deploy the GX Agent to test locally or enhance security.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note for reviewers: Though not in the plan, I updated the page description because it looked outdated to me. Apologies for scope creep

klavavej marked this conversation as resolved.
Show resolved Hide resolved
toc_min_heading_level: 2
toc_max_heading_level: 2
---
Expand All @@ -12,12 +12,6 @@ import Tabs from '@theme/Tabs';

The GX Agent is used to run an [agent-enabled deployment](/cloud/deploy/deployment_patterns.md#agent-enabled-deployment) of GX Cloud. If you are running a fully-hosted or read-only deployment, you do not need to deploy the GX Agent.

:::info Enable the GX Agent

The GX Agent, and agent-enabled deployments, are not available by default in GX Cloud. To enable the GX Agent for your GX Cloud organization, reach out to GX Support at [email protected].

:::

The GX Agent serves as an intermediary between GX Cloud and your organization's data stores. GX Cloud does not connect directly to your data in an agent-enabled deployment, and all data access occurs within the GX Agent. GX Cloud sends jobs to the GX Agent, the GX Agent executes these jobs against your data, and then sends the job results to GX Cloud.

A local deployment of the GX Agent will allow you to test GX Cloud setup or processes from a single machine before moving to a shared production deployment. Alternatively, you can run the GX Agent in your deployment environment and leverage GX Cloud while connecting to Data Sources using your organization's environment and infrastructure, for enhanced control and security.
Expand All @@ -26,36 +20,42 @@ A local deployment of the GX Agent will allow you to test GX Cloud setup or proc
## Prerequisites

- You have a [GX Cloud account](https://greatexpectations.io/cloud).
- You have reached out to GX Support at [email protected] to request a GX Agent deployment.
- You have a [Docker instance](https://docs.docker.com/get-docker/) or [kubectl](https://kubernetes.io/docs/tasks/tools/).

## Get your access token and organization ID

You need your access token and organization ID to deploy the GX Agent. Access tokens shouldn't be committed to version control software.
## Enable the GX Agent

If you've used GX Cloud previously, you have your access token and organization ID, and you need to restart the GX Agent, see [Deploy the GX Agent](#deploy-the-gx-agent).
Copy link
Contributor Author

@klavavej klavavej Jan 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note for reviewers: though not in the plan, I decided to remove this since this callout makes less sense with the "New GX Cloud account" tab removed. Also it should be intuitive for folks who already have their access token and org id to skip over this section based on the section header alone.

The GX Agent is not enabled by default in GX Cloud. To enable the GX Agent for your GX Cloud organization, request the Agent when adding a Data Source. The workflow depends on whether or not your organization has any Data Sources yet.

<Tabs
groupId="copy-token"
defaultValue='new'
groupId="request-agent"
defaultValue='none'
values={[
{label: 'New GX Cloud account', value:'new'},
{label: 'Existing GX Cloud account', value:'existing'},
{label: 'No Data Sources yet', value:'none'},
{label: 'Existing Data Sources', value:'some'},
]}>
<TabItem value="new">
<TabItem value="none">

1. Sign in to GX Cloud.
1. Go to **Data Assets**.
2. Select a Data Source type.
3. Click **Request Agent**.

2. Complete the survey and then click **Continue to GX Cloud**.

3. Copy and then paste the **Access token** and **Organization ID** values into a temporary file. You'll need them to deploy the GX Agent.
</TabItem>
<TabItem value="some">

4. Click **Deploy the GX Agent** and [deploy the GX Agent](#deploy-the-gx-agent).
1. Go to **Data Assets**.
2. Select **New Data Asset**.
3. Select **New Data Source**.
4. Select a Data Source type.
5. Click **Request Agent**.

</TabItem>
<TabItem value="existing">
</Tabs>

We will send you a confirmation email when we fulfill your request. You can continue following the steps below to deploy the GX Agent while we work on enabling it for your organization.

Use the information provided here to view your organization ID or create a new access token. This can be helpful if you've forgotten your organization ID or access token, and you need to restart the GX Agent.
Copy link
Contributor Author

@klavavej klavavej Jan 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note for reviewers: though not in the plan, I decided to remove this text because it doesn't make as much sense with the tabs in this section removed.

## Get your access token and organization ID

You need your access token and organization ID to deploy the GX Agent. Access tokens shouldn't be committed to version control software.

1. In GX Cloud, click **Settings** > **Tokens**.

Expand All @@ -75,8 +75,6 @@ Use the information provided here to view your organization ID or create a new a

8. [Deploy the GX Agent](#deploy-the-gx-agent).

</TabItem>
</Tabs>

## Deploy the GX Agent

Expand Down
Loading