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.

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] Revise OSS Installation and Setup Guidance for Google Cloud Storage #9600

Merged
merged 3 commits into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ title: Install and set up Azure Blob Storage support
---
import PrereqPythonInstalled from '../../_core_components/prerequisites/_python_installation.md';

Azure Blob Storage allows users to store unstructured data on Microsoft's cloud data storage platform. With the installation of some additional Python libraries and the provision of a connection string, you will be able to use Great Expectations (GX) alongside data kept in Azure Blob Storge.
Azure Blob Storage stores unstructured data on the Microsoft cloud data storage platform. To validate Azure Blob Storage data with Great Expectations (GX) you install additional Python libraries and define a connection string.

## Prerequisites

- <PrereqPythonInstalled/>
- (Recommended) [A Python virtual environment](/core/installation_and_setup/set_up_a_python_environment.mdx#optional-create-a-virtual-environment).
- An [Azure Storage account](https://docs.microsoft.com/en-us/azure/storage). A [connection string](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal) is required to complete the setup.
- An [Azure Storage account](https://docs.microsoft.com/en-us/azure/storage).
- [Azure storage account access keys](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal).

## Installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,56 @@
title: Install and set up Google Cloud Storage support
---

import InProgress from '../../_core_components/_in_progress.md';

<InProgress />
import PrereqPythonInstalled from '../../_core_components/prerequisites/_python_installation.md';

To validate Google Cloud Platform (GCP) data with GX Core, you create your GX Python environment, install GX Core locally, and then configure the necessary dependencies.

## Prerequisites

- <PrereqPythonInstalled/>
- pip can be used to install Python modules.
- A [GCP service account](https://cloud.google.com/iam/docs/service-account-overview) with permissions to access GCP resources and storage Objects.
- The `GOOGLE_APPLICATION_CREDENTIALS` environment variable is set. See [Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc).
- Google Cloud API authentication is set up. See [Set up authentication](https://cloud.google.com/storage/docs/reference/libraries#authentication).

## Installation

## Next steps
1. Run the following code to confirm your Python version:

```bash title="Terminal input"
python --version
```
If your existing Python version is not 3.8 to 3.11, see [Active Python Releases](https://www.python.org/downloads/).

2. Run the following code to create a virtual environment and a directory named `my_venv`:

```bash title="Terminal input"
python -m venv my_venv
```
Optional. Replace `my_venv` with another directory name.

If you prefer, you can use virtualenv, pyenv, and similar tools to install GX in virtual environments.

3. Run the following code to activate the virtual environment:

```bash title="Terminal input"
source my_venv/bin/activate
```

4. Run the following code to install optional dependencies:

```bash title="Terminal input"
python -m pip install 'great_expectations[gcp]'
```

5. Run the following code to confirm GX was installed successfully:

```bash title="Terminal input"
great_expectations --version
```
The output should be `great_expectations, version <version_number>`.


## Next steps

- [Manage Data Contexts](/core/installation_and_setup/manage_data_contexts.md)
2 changes: 1 addition & 1 deletion docs/docusaurus/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ module.exports = {
{
type: 'doc',
id: 'core/installation_and_setup/additional_dependencies/google_cloud_storage',
label: '🚧 Google Cloud Storage'
label: 'Google Cloud Storage'
},
{
type: 'doc',
Expand Down
Loading