docs: Add recommended GCP roles and privileges #220
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abb9979
reviewed
Jul 19, 2024
docs/gcp_setup.md
Outdated
|
|
||
| ### Service Account | ||
|
|
||
| A service account should be provisioned from the GCP project. This service account can be used by any service that will execute GOE commands, for example it could be attached to a GCE virtual machine. |
There was a problem hiding this comment.
Assumes that readers know what GCP, GCE etc stand for (a fair assumption really). But is it worth defining them?
README.md
Outdated
| @@ -78,11 +78,11 @@ alter user goe_adm identified by ...; | |||
| alter user goe_app identified by ...; | |||
| ``` | |||
|
|
|||
| # Building a custom package | |||
| # Building a Custom Package | |||
|
|
|||
| If you want to test with the latest commits that have not yet been included in a Github release you can build a custom package from the repository. | |||
README.md
Outdated
| @@ -37,7 +37,7 @@ GOE_WHEEL="goe_framework-<goe-version>-py3-none-any.whl" | |||
| python3 -m pip install lib/${GOE_WHEEL} | |||
| ``` | |||
|
|
|||
| ## Configuration file | |||
| ## Configuration File | |||
| Create `offload.env` in the Offload Home, this file contains the necessary configuration specific to your environment: | |||
There was a problem hiding this comment.
the Offload Home. This file contains...
docs/gcp_setup.md
Outdated
|
|
||
| ### Cloud Storage Bucket | ||
|
|
||
| A cloud storage bucket is required to stage data before ingesting it into BigQuery. Ensure the bucket is in a location compatible with the target BigQuery dataset. |
There was a problem hiding this comment.
We use GCP and GCE above, do we need to use GCS given that this is BigQuery, and therefore GCS, specific? Else, "cloud storage" should be "Cloud Storage".
docs/gcp_setup.md
Outdated
|
|
||
| ### Dataproc (Spark) | ||
|
|
||
| For non-trivially sized tables GOE uses Spark to copy data from the source database to cloud storage. In a GCP setting this is likely to be provided by one of two services: |
There was a problem hiding this comment.
For tables of a non-trivial size, GOE uses...
docs/gcp_setup.md
Outdated
| --add-permissions=bigquery.tables.create,bigquery.tables.update | ||
| ``` | ||
|
|
||
| If GOE is permitted to drop tables then add these extra privileges: |
docs/gcp_setup.md
Outdated
| ``` | ||
|
|
||
| #### goe_bq_stg_role | ||
| Note that the role grant is bound to the staging BigQuery dataset (which has the same name as the target dataset but with an "_load" suffix), no project wide access is granted. The `bq` utility is used to grant the role because `gcloud` does not support these granular grants. |
There was a problem hiding this comment.
- typo: an "_load"
- ...suffix). No project-wide access...
docs/gcp_setup.md
Outdated
| ``` | ||
| gcloud iam roles create goe_bq_app_role --project ${PROJECT} \ | ||
| --title="GOE Data Update Access" \ | ||
| --description="Grants GOE permissions to read and modify data in an application schema" \ |
There was a problem hiding this comment.
Do we want to say "dataset" instead of "schema"?
docs/gcp_setup.md
Outdated
| ``` | ||
| gcloud iam roles create goe_bq_stg_role --project ${PROJECT} \ | ||
| --title="GOE Data Staging Access" \ | ||
| --description="Grants GOE permissions to manage objects in a staging schema" \ |
There was a problem hiding this comment.
Do we want to say "dataset" instead of "schema"?
docs/gcp_setup.md
Outdated
| ``` | ||
|
|
||
| ## Compute Engine Virtual Machine | ||
| Values supplied below are examples only, changes will likely be required for each use case: |
There was a problem hiding this comment.
...examples only. Changes are likely to be...
|
Ready for re-review. Thanks |
abb9979
approved these changes
Jul 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.