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

Info on how to retrieve secrets using google secret manager #1505

Merged

Conversation

dat-a-man
Copy link
Collaborator

Description

Added info about

@dat-a-man dat-a-man added the documentation Improvements or additions to documentation label Jun 21, 2024
Copy link

netlify bot commented Jun 21, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 68e3242
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/667596a65638870008fb6d2c
😎 Deploy Preview https://deploy-preview-1505--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

```sh
pip install google-cloud-secret-manager
```
[Google Docs](https://cloud.google.com/secret-manager/docs/reference/libraries)
Copy link
Contributor

Choose a reason for hiding this comment

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

describe what kind of doc it is.

Suggested change
[Google Docs](https://cloud.google.com/secret-manager/docs/reference/libraries)
[Google Cloud Documentation: Secret Manager client libraries. ](https://cloud.google.com/secret-manager/docs/reference/libraries)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

done

{"api_token": "ghp_Kskdgf98dugjf98ghd...."}
```

In the script `dlt_with_google_secrets_pipeline.py` you can find an example how to use Google Secrets in `dlt` pipelines.
Copy link
Contributor

Choose a reason for hiding this comment

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

instead of this lone put the code snippet from the bottom

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The bottom code shifted here.


In the script `dlt_with_google_secrets_pipeline.py` you can find an example how to use Google Secrets in `dlt` pipelines.

### Points to Note:
Copy link
Contributor

Choose a reason for hiding this comment

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

it should be at the end

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

moved


- **Permissions**: Ensure the service account or user credentials you are using have the necessary permissions to access the Secret Manager and the specific secrets.
- **Secret Format**: This example assumes that the secret is stored in a JSON string format. If your secret is in a different format, you will need to adjust the parsing method accordingly.
- **Google Cloud Authentication**: Make sure your environment is authenticated with Google Cloud. This can typically be done by setting credentials in `.dlt/secrets.toml` or setting the `GOOGLE_SECRETS__CREDENTIALS` environment variable to the path of your service account key file or the dict of credentials as a string.
Copy link
Contributor

Choose a reason for hiding this comment

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

add an example of credentials also

[google_secrets.credentials]
"project_id" = "<project_id>"
"private_key" = "-----BEGIN PRIVATE KEY-----\n....\n-----END PRIVATE KEY-----\n"
"client_email" = "....gserviceaccount.com"

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

added

- **Secret Format**: This example assumes that the secret is stored in a JSON string format. If your secret is in a different format, you will need to adjust the parsing method accordingly.
- **Google Cloud Authentication**: Make sure your environment is authenticated with Google Cloud. This can typically be done by setting credentials in `.dlt/secrets.toml` or setting the `GOOGLE_SECRETS__CREDENTIALS` environment variable to the path of your service account key file or the dict of credentials as a string.

With this setup, you can effectively retrieve secrets stored in Google Cloud Secret Manager and use them in your `dlt` pipelines as dictionaries.
Copy link
Contributor

Choose a reason for hiding this comment

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

you can delete this sentence at all

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

deleted


# Fetch the list of repositories from the specified organization using the provided API token.
# The API token is retrieved from the secret data dictionary.
data = get_repositories(api_token=secret_data["api_token"], organization="dlt-hub")
Copy link
Contributor

Choose a reason for hiding this comment

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

mentioning function which you don;t provide in a code snippet is not cool. let's make it clearer:

# Retrieve secret data as a dictionary for use in other functions.
secret_data = get_secret_dict("temp-secret")

url = f"https://api.github.com/orgs/dlt-hub/repos"
headers = {
    "Authorization": f"token {secret_data["api_token"]}",
     "Accept": "application/vnd.github+json",
}

response = requests.get(url, headers=headers)
    
pipeline = dlt.pipeline(
        pipeline_name="quick_start", destination="duckdb", dataset_name="mydata"
    )
load_info = pipeline.run(response.json())

print(load_info)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, added it to the code.

@AstrakhantsevaAA AstrakhantsevaAA self-assigned this Jun 21, 2024
@AstrakhantsevaAA AstrakhantsevaAA merged commit adde28d into devel Jun 21, 2024
41 checks passed
@AstrakhantsevaAA AstrakhantsevaAA deleted the fix/issue-1411-retrieve-secrets-from-google-secrets branch June 21, 2024 15:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
3 participants