Skip to content

Commit cef8f19

Browse files
committed
WIP: Creating a different instance for GX Cloud
1 parent 744aeb7 commit cef8f19

35 files changed

+324
-301
lines changed

docs/docusaurus/docs/cloud/connect/connect_airflow.md renamed to docs/docusaurus/cloud/connect/connect_airflow.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Apache Airflow is an orchestration tool that allows you to schedule and monitor
1515

1616
- You have installed Apache Airflow and initialized the database (__airflow db init__).
1717

18-
- You have [connected GX Cloud to a Data Asset on a Data Source](/cloud/data_assets/manage_data_assets.md#create-a-data-asset).
18+
- You have [connected GX Cloud to a Data Asset on a Data Source](/data_assets/manage_data_assets.md#create-a-data-asset).
1919

20-
- You have [created an Expectation Suite](/cloud/expectation_suites/manage_expectation_suites.md) and [added Expectations](/cloud/expectations/manage_expectations.md#create-an-expectation).
20+
- You have [created an Expectation Suite](/expectation_suites/manage_expectation_suites.md) and [added Expectations](/expectations/manage_expectations.md#create-an-expectation).
2121

2222

2323
## Run Airflow Standalone to create a fresh local Airflow environment

docs/docusaurus/docs/cloud/connect/connect_databrickssql.md renamed to docs/docusaurus/cloud/connect/connect_databrickssql.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
99

1010
## Prerequisites
1111

12-
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/cloud/users/manage_users.md#roles-and-responsibilities).
12+
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/users/manage_users.md#roles-and-responsibilities).
1313

1414
- You have a Databricks SQL catalog, schema, and table.
1515

@@ -39,4 +39,4 @@ import Tabs from '@theme/Tabs';
3939

4040
6. Click **Add Asset**.
4141

42-
7. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
42+
7. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).

docs/docusaurus/docs/cloud/connect/connect_postgresql.md renamed to docs/docusaurus/cloud/connect/connect_postgresql.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
99

1010
## Prerequisites
1111

12-
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/cloud/users/manage_users.md#roles-and-responsibilities).
12+
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/users/manage_users.md#roles-and-responsibilities).
1313

1414
- You have a PostgreSQL database, schema, and table.
1515

@@ -59,5 +59,5 @@ import Tabs from '@theme/Tabs';
5959

6060
11. Click **Finish**.
6161

62-
12. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
62+
12. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).
6363

docs/docusaurus/docs/cloud/connect/connect_python.md renamed to docs/docusaurus/cloud/connect/connect_python.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Environment variables securely store your GX Cloud access credentials.
6161
```
6262
6363
:::note
64-
After you save your **GX_CLOUD_ACCESS_TOKEN** and **GX_CLOUD_ORGANIZTION_ID**, you can use Python scripts to access GX Cloud and complete other tasks. See the [GX Core guides](/core/introduction/introduction.mdx).
64+
After you save your **GX_CLOUD_ACCESS_TOKEN** and **GX_CLOUD_ORGANIZTION_ID**, you can use Python scripts to access GX Cloud and complete other tasks. See the [GX Core guides](/docs/core/introduction).
6565
:::
6666
6767
2. Optional. If you created a temporary file to record your user access token and Organization ID, delete it.

docs/docusaurus/docs/cloud/connect/connect_snowflake.md renamed to docs/docusaurus/cloud/connect/connect_snowflake.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import Tabs from '@theme/Tabs';
99

1010
## Prerequisites
1111

12-
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/cloud/users/manage_users.md#roles-and-responsibilities).
12+
- You have a [GX Cloud account](https://greatexpectations.io/cloud) with [Admin or Editor permissions](/users/manage_users.md#roles-and-responsibilities).
1313

1414
- You have a Snowflake database, schema, and table.
1515

@@ -83,4 +83,4 @@ You can use an existing Snowflake warehouse, but GX recommends creating a separa
8383

8484
12. Click **Finish**.
8585

86-
13. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
86+
13. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).

docs/docusaurus/docs/cloud/data_assets/manage_data_assets.md renamed to docs/docusaurus/cloud/data_assets/manage_data_assets.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Define the data you want GX Cloud to access within Snowflake.
4747

4848
3. Select one of the following options:
4949

50-
- If you're connecting to an org-hosted Snowflake Data Asset for the first time, copy the code and see [Connect GX Cloud to Snowflake](../connect/connect_snowflake.md).
50+
- If you're connecting to an org-hosted Snowflake Data Asset for the first time, copy the code and see [Connect GX Cloud to Snowflake](/connect/connect_snowflake.md).
5151

5252
- If you're testing GX Cloud features and functionality in a self-hosted environment, click **I have created a GX Cloud user with valid permissions** and then click **Continue**.
5353

@@ -89,7 +89,7 @@ Define the data you want GX Cloud to access within Snowflake.
8989

9090
9. Click **Add Asset**.
9191

92-
10. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
92+
10. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).
9393

9494
</TabItem>
9595
<TabItem value="PostgreSQL">
@@ -114,7 +114,7 @@ Define the data you want GX Cloud to access within PostgreSQL.
114114

115115
3. Select one of the following options:
116116

117-
- If you're connecting to an org-hosted PostgreSQL Data Asset for the first time, copy the code and see [Connect GX Cloud to PostgreSQL](../connect/connect_postgresql.md).
117+
- If you're connecting to an org-hosted PostgreSQL Data Asset for the first time, copy the code and see [Connect GX Cloud to PostgreSQL](/connect/connect_postgresql.md).
118118

119119
- If you're testing GX Cloud features and functionality in a self-hosted environment, click **I have created a GX Cloud user with valid permissions** and then click **Continue**.
120120

@@ -137,7 +137,7 @@ Define the data you want GX Cloud to access within PostgreSQL.
137137

138138
8. Click **Add Asset**.
139139

140-
9. Create an Expectation. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
140+
9. Create an Expectation. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).
141141

142142
</TabItem>
143143
</Tabs>
@@ -198,7 +198,7 @@ When you create an Expectation after fetching metrics for a Data Asset, the colu
198198

199199
- To add an Expectation to an existing Expectation Suite, click the **Existing Suite** tab and then select an existing Expectation Suite.
200200

201-
6. Select an Expectation type. See [Available Expectation types](/cloud/expectations/manage_expectations.md#available-expectation-types).
201+
6. Select an Expectation type. See [Available Expectation types](/expectations/manage_expectations.md#available-expectation-types).
202202

203203
7. Complete the fields in the **Create Expectation** pane.
204204

docs/docusaurus/docs/cloud/deploy/deploy_gx_agent.md renamed to docs/docusaurus/cloud/deploy/deploy_gx_agent.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import TabItem from '@theme/TabItem';
1010
import Tabs from '@theme/Tabs';
1111

1212

13-
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.
13+
The GX Agent is used to run an [agent-enabled deployment](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.
1414

1515
:::info Enable the GX Agent
1616

docs/docusaurus/docs/cloud/deploy/deployment_patterns.md renamed to docs/docusaurus/cloud/deploy/deployment_patterns.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ GX Cloud deployment patterns are defined by how GX Cloud connects to your data.
1919

2020
In a fully-hosted deployment, GX Cloud connects directly to your organization's data using a cloud-to-cloud connection. Connection to your data is read-only and uses encrypted communication. Fully-hosted deployments are the quickest way to get started with GX Cloud.
2121

22-
![GX Cloud fully-hosted deployment](./deployment_images/fully_hosted_deployment.png)
22+
![GX Cloud fully-hosted deployment](deployment_images/fully_hosted_deployment.png)
2323

2424
If you are using a fully-hosted deployment, ensure that the following GX Cloud IPs are in your organization's allow list for ingress traffic.
2525
- `44.209.54.123`
@@ -30,9 +30,9 @@ If you are using a fully-hosted deployment, ensure that the following GX Cloud I
3030

3131
In an agent-enabled deployment, the GX Agent runs in your environment and serves as an intermediary between GX Cloud and your data. GX Cloud sends jobs to the GX Agent, the GX Agent connects to and interacts with your data, and the GX Agent reports job results back to GX Cloud.
3232

33-
![GX Cloud agent-enabled deployment](./deployment_images/agent_enabled_deployment.png)
33+
![GX Cloud agent-enabled deployment](deployment_images/agent_enabled_deployment.png)
3434

35-
The GX Agent is a Docker container that can be run in your organization's deployment environment or locally. See [Deploy the GX Agent](/cloud/deploy/deploy_gx_agent.md) for setup details.
35+
The GX Agent is a Docker container that can be run in your organization's deployment environment or locally. See [Deploy the GX Agent](deploy_gx_agent.md) for setup details.
3636

3737

3838
## Read-only deployment
@@ -41,4 +41,4 @@ In a read-only deployment, you use the GX Core Python library to push GX metadat
4141

4242
In this deployment scenario, there is a one-way flow of information from your environment to GX Cloud.
4343

44-
![GX Cloud read-only deployment](./deployment_images/read_only_deployment.png)
44+
![GX Cloud read-only deployment](deployment_images/read_only_deployment.png)

docs/docusaurus/docs/cloud/expectation_suites/manage_expectation_suites.md renamed to docs/docusaurus/cloud/expectation_suites/manage_expectation_suites.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Expectation Suites contain multiple Expectations for a single Data Asset. Like E
1010

1111
## Prerequisites
1212

13-
- You have a [Data Asset](/cloud/data_assets/manage_data_assets.md#create-a-data-asset).
13+
- You have a [Data Asset](/data_assets/manage_data_assets.md#create-a-data-asset).
1414

1515
## Create an Expectation Suite
1616

@@ -26,9 +26,9 @@ If you have specific business requirements, or you want to examine specific data
2626

2727
5. Click **Create**.
2828

29-
7. Add Expectations to the Expectation Suite. See [Create an Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
29+
7. Add Expectations to the Expectation Suite. See [Create an Expectation](/expectations/manage_expectations.md#create-an-expectation).
3030

31-
8. Optional. Run a Validation on the Expectation Suite. See [Run a Validation](/cloud/validations/manage_validations.md#run-a-validation).
31+
8. Optional. Run a Validation on the Expectation Suite. See [Run a Validation](/validations/manage_validations.md#run-a-validation).
3232

3333
## Edit an Expectation Suite
3434

@@ -54,6 +54,6 @@ If you have specific business requirements, or you want to examine specific data
5454

5555
## Related documentation
5656

57-
- [Manage Expectations](../expectations/manage_expectations.md)
57+
- [Manage Expectations](/expectations/manage_expectations.md)
5858

59-
- [Manage Validations](../validations/manage_validations.md)
59+
- [Manage Validations](/validations/manage_validations.md)

docs/docusaurus/docs/cloud/expectations/manage_expectations.md renamed to docs/docusaurus/cloud/expectations/manage_expectations.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ An Expectation is a verifiable assertion about your data. They make implicit ass
1010

1111
## Prerequisites
1212

13-
- You have a [Data Asset](/cloud/data_assets/manage_data_assets.md#create-a-data-asset).
13+
- You have a [Data Asset](/data_assets/manage_data_assets.md#create-a-data-asset).
1414

1515
## Available Expectations
1616

@@ -103,7 +103,7 @@ The optional `{batch}` named query references the Batch of data under test. When
103103

104104
8. Click **Save** or click **Save & Add More** and then repeat steps 5 and 7 to add additional Expectations.
105105

106-
9. Optional. Run a Validation. See [Run a Validation](/cloud/validations/manage_validations.md#run-a-validation).
106+
9. Optional. Run a Validation. See [Run a Validation](/validations/manage_validations.md#run-a-validation).
107107

108108
## Edit an Expectation
109109

@@ -147,4 +147,4 @@ View the Expectation history to determine when an Expectation was changed and wh
147147

148148
## Related documentation
149149

150-
- [Manage Expectation Suites](../expectation_suites/manage_expectation_suites.md)
150+
- [Manage Expectation Suites](/expectation_suites/manage_expectation_suites.md)

docs/docusaurus/docs/cloud/overview/gx_cloud_overview.md renamed to docs/docusaurus/cloud/overview/gx_cloud_overview.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ GX Cloud data validation workflows are created using GX Cloud components, entiti
2828

2929
A GX Cloud data validation workflow can be implemented using the following steps:
3030

31-
![Standard GX Cloud workflow](./overview_images/gx_cloud_workflow.png)
31+
![Standard GX Cloud workflow](overview_images/gx_cloud_workflow.png)
3232

3333
1. Connect to your data.
3434
2. Create a Data Asset.
@@ -40,15 +40,15 @@ A GX Cloud data validation workflow can be implemented using the following steps
4040
### Additional workflow features
4141
There are a variety of GX Cloud features that support additional enhancements to your GX Cloud data validation workflow.
4242

43-
![GX Cloud workflow enhanced with product features](./overview_images/gx_cloud_workflow_enhanced.png)
43+
![GX Cloud workflow enhanced with product features](overview_images/gx_cloud_workflow_enhanced.png)
4444

45-
* **GX Cloud user management.** GX Cloud functions as a shared portal to manage and monitor your organization's data quality. Users can be invited to your GX Cloud organization and assigned a role that governs their ability to view and edit components and workflows in GX Cloud. See [Manage users and access tokens](/cloud/users/manage_users.md) for more details.
45+
* **GX Cloud user management.** GX Cloud functions as a shared portal to manage and monitor your organization's data quality. Users can be invited to your GX Cloud organization and assigned a role that governs their ability to view and edit components and workflows in GX Cloud. See [Manage users and access tokens](/users/manage_users.md) for more details.
4646

4747
* **Data Asset profiling.** GX Cloud introspects your data schema by default on Data Asset creation, and also offers one-click fetching of additional descriptive metrics including column type and statistical summaries. Data profiling results are used to suggest parameters for Expectations that you create.
4848

49-
* **Schedule Validations.** GX Cloud enables you to schedule validations, so that you can test and assess your data on a regular cadence and monitor data quality over time. See [Manage schedules](/cloud/schedules/manage_schedules.md) for more detail.
49+
* **Schedule Validations.** GX Cloud enables you to schedule validations, so that you can test and assess your data on a regular cadence and monitor data quality over time. See [Manage schedules](/schedules/manage_schedules.md) for more detail.
5050

51-
* **Alerting.** GX Cloud provides the ability to send alerts when validations fail, enabling your organization to remain proactively aware of the health of your Data Assets. See [Manage alerts](/cloud/alerts/manage_alerts.md) for more detail.
51+
* **Alerting.** GX Cloud provides the ability to send alerts when validations fail, enabling your organization to remain proactively aware of the health of your Data Assets. See [Manage alerts](/alerts/manage_alerts.md) for more detail.
5252

5353

5454

@@ -57,12 +57,12 @@ There are a variety of GX Cloud features that support additional enhancements to
5757

5858
GX Cloud architecture comprises a frontend web UI, storage for entity configuration and metadata, a backend application, and a Python client.
5959

60-
![GX Cloud architecture](./overview_images/gx_cloud_architecture.png)
60+
![GX Cloud architecture](overview_images/gx_cloud_architecture.png)
6161

6262
* **GX Cloud frontend web UI**. Enables you to manage and validate your organization's data quality without running code and provides shared visibility into your organization's Validation Results history. The GX Cloud web UI is browser- and platform-independent.
6363

6464
* **GX Cloud data storage**. Stores the configurations for your organization's Data Sources, Data Assets, Expectations, and Validations alongside your organization's Validation Result histories and Data Asset descriptive metrics.
6565

66-
* **GX Cloud backend application**. Contains the necessary logic and compute to connect to data and run queries. The specifics of how the GX Cloud backend connects to your data is described in [Deployment patterns](/cloud/deploy/deployment_patterns.md).
66+
* **GX Cloud backend application**. Contains the necessary logic and compute to connect to data and run queries. The specifics of how the GX Cloud backend connects to your data is described in [Deployment patterns](/deploy/deployment_patterns.md).
6767

68-
* **GX Core Python client**. Enables you to interact programmatically with the GX Cloud backend application. The [GX Core Python client](/core/introduction/introduction.mdx) can complement and extend your web UI-created workflows.
68+
* **GX Core Python client**. Enables you to interact programmatically with the GX Cloud backend application. The [GX Core Python client](/docs/core/introduction) can complement and extend your web UI-created workflows.

docs/docusaurus/docs/cloud/_try_gx_cloud.md renamed to docs/docusaurus/cloud/try_gx_cloud.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import Tabs from '@theme/Tabs';
1212

1313
If you're new to GX Cloud, start here to learn how you can quickly connect to your Data Assets and validate data.
1414

15-
If you've tested GX Cloud features and functionality and discovered it's a great solution for your organization, see [Connect GX Cloud](./connect/connect_lp.md).
15+
If you've tested GX Cloud features and functionality and discovered it's a great solution for your organization, see [Connect GX Cloud](connect/connect_lp.md).
1616

1717
## Prerequisites
1818

@@ -24,7 +24,7 @@ If you've tested GX Cloud features and functionality and discovered it's a great
2424

2525
## Self-hosted deployment
2626

27-
To try GX Cloud, you use a [self-hosted deployment](/cloud/deploy/deployment_patterns.md) to run the GX Agent with Docker, connect the GX Agent to your target Data Sources, and use the GX Cloud web UI to define your Data Assets, create Expectations, and run Validations. A self-hosted deployment is recommended when you want to test GX Cloud features and functionality and it differs from the recommended [org-hosted deployment](/cloud/deploy/deployment_patterns.md), in which the GX Agent runs in your organization's deployment environment.
27+
To try GX Cloud, you use a [self-hosted deployment](deploy/deployment_patterns.md) to run the GX Agent with Docker, connect the GX Agent to your target Data Sources, and use the GX Cloud web UI to define your Data Assets, create Expectations, and run Validations. A self-hosted deployment is recommended when you want to test GX Cloud features and functionality and it differs from the recommended [org-hosted deployment](deploy/deployment_patterns.md), in which the GX Agent runs in your organization's deployment environment.
2828

2929
## Get your user access token and copy your organization ID
3030

@@ -48,7 +48,7 @@ You'll need your user access token and organization ID to set your environment v
4848

4949
## Set the environment variables and deploy the GX Agent
5050

51-
Environment variables securely store your GX Cloud access credentials. The GX Agent runs open source GX code in GX Cloud, and it allows you to securely access your data without connecting to it or interacting with it directly. To learn more about the GX Agent and deployment patterns, see [GX Cloud deployment patterns](/cloud/deploy/deployment_patterns.md).
51+
Environment variables securely store your GX Cloud access credentials. The GX Agent runs open source GX code in GX Cloud, and it allows you to securely access your data without connecting to it or interacting with it directly. To learn more about the GX Agent and deployment patterns, see [GX Cloud deployment patterns](deploy/deployment_patterns.md).
5252

5353
1. Start the Docker Engine.
5454

@@ -195,7 +195,7 @@ An Expectation is a verifiable assertion about your data. They make implicit ass
195195

196196
3. Click **New Expectation**.
197197

198-
4. Select an Expectation type, enter the column name, and then complete the optional fields. To view descriptions of the available Expectation types, see [Available Expectations](./expectations/manage_expectations.md#available-expectations).
198+
4. Select an Expectation type, enter the column name, and then complete the optional fields. To view descriptions of the available Expectation types, see [Available Expectations](expectations/manage_expectations.md#available-expectations).
199199

200200
5. Click **Save**. The Expectation is added to the default Expectation Suite.
201201

docs/docusaurus/docs/cloud/validations/manage_validations.md renamed to docs/docusaurus/cloud/validations/manage_validations.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ When you run a validation on an Expectation, a Checkpoint is added. The Checkpoi
1010

1111
## Prerequisites
1212

13-
- You have created an [Expectation](/cloud/expectations/manage_expectations.md#create-an-expectation).
13+
- You have created an [Expectation](/expectations/manage_expectations.md#create-an-expectation).
1414

1515
## Run a Validation
1616

0 commit comments

Comments
 (0)