Skip to content

Commit

Permalink
add troubleshooting to README
Browse files Browse the repository at this point in the history
  • Loading branch information
rachhouse committed Jan 8, 2025
1 parent 5c81430 commit 2f3cd5f
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ If you are an experienced GX user, these tutorials will provide code examples of
1. [Cookbooks](#cookbooks)
1. [Tutorial environment](#tutorial-environment)
1. [Tutorial data](#tutorial-data)
1. [Troubleshooting](#troubleshooting)
1. [Additional resources](#additional-resources)

## Prerequisites
Expand Down Expand Up @@ -108,6 +109,30 @@ dataset](https://www.kaggle.com/datasets/bhavikjikadara/global-electronics-retai
This dataset is used under the Creative Commons Attribution 4.0 International License. Appropriate credit is given to Bhavik Jikadara. The dataset has been modified to suit the requirements of this project. For more information about this license, please visit the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/).
## Troubleshooting
This section provides guidance on how to resolve potential errors and unexpected behavior when running the tutorial.
### Docker compose errors
If you receive unexpected errors when running `docker compose up`, or do not get healthy containers, you can try recreating the tutorial Docker containers using the `--force-recreate` argument.
```
docker compose up --build --force-recreate --detach --wait
```
### GX Cloud environment variables warning
The tutorial Docker compose is defined to capture `GX_CLOUD_ORGANIZATION_ID` and `GX_CLOUD_ACCESS_TOKEN` environment variables to support Cookbook 3. If these variables are not provided when running `docker compose up`, you will see the following warnings:
```
WARN[0000] The "GX_CLOUD_ORGANIZATION_ID" variable is not set. Defaulting to a blank string.
WARN[0000] The "GX_CLOUD_ACCESS_TOKEN" variable is not set. Defaulting to a blank string.
WARN[0000] The "GX_CLOUD_ORGANIZATION_ID" variable is not set. Defaulting to a blank string.
WARN[0000] The "GX_CLOUD_ACCESS_TOKEN" variable is not set. Defaulting to a blank string.
```
You can safely ignore the these warnings if:
* You are not trying to run Cookbook 3.
* You are running `docker compose down --volumes` to stop the running Docker compose.
## Additional resources
* To report a bug for any of the tutorials or code within this repo, [open an issue](https://github.com/greatexpectationslabs/tutorial-gx-in-the-data-pipeline/issues/new).
Expand Down
Empty file.

0 comments on commit 2f3cd5f

Please sign in to comment.