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.

Sign up for GitHub

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

Jump to bottom

Documentation changes to specify permissions needed for running BigQuery jobs #896

Closed
9 tasks
phanikumv opened this issue Sep 23, 2022 · 0 comments · Fixed by #1103
Closed
9 tasks

Documentation changes to specify permissions needed for running BigQuery jobs #896

phanikumv opened this issue Sep 23, 2022 · 0 comments · Fixed by #1103
Assignees
@pankajastro
Labels
documentation Improvements or additions to documentation priority/low Low priority product/python-sdk Label describing products
Milestone
1.2.0

Comments

@phanikumv
Copy link
Collaborator

Please describe the feature you'd like to see
Make it more explicit in the documentation here that user needs to have bigquery.jobs.create permission in the project to be able to run the big query specific astro sdk jobs. Refer to the hyperlink https://astronomer.slack.com/archives/C03868KGF2Q/p1663879612968789 for the conversation

Describe the solution you'd like
A clear and concise description of what you want to happen, if possible with code examples.

Are there any alternatives to this feature?
Is there another way we could solve this problem or enable this use-case?

Additional context
Add any other context about the feature request here.

Acceptance Criteria

  • All checks and tests in the CI should pass
  • Unit tests (90% code coverage or more, once available)
  • Integration tests (if the feature relates to a new database or external service)
  • Example DAG
  • Docstrings in reStructuredText for each of methods, classes, functions and module-level attributes (including Example DAG on how it should be used)
  • Exception handling in case of errors
  • Logging (are we exposing useful information to the user? e.g. source and destination)
  • Improve the documentation (README, Sphinx, and any other relevant)
  • How to use Guide for the feature (example)
@phanikumv phanikumv added the feature New feature or request label Sep 23, 2022
@phanikumv phanikumv added this to the 1.2.0 milestone Sep 23, 2022
@phanikumv phanikumv changed the title Documentation changes to specify needed BigQuery permissions Documentation changes to specify permissions needed for running BigQuery jobs Sep 23, 2022
@kaxil kaxil added documentation Improvements or additions to documentation product/python-sdk Label describing products and removed feature New feature or request labels Sep 23, 2022
@phanikumv phanikumv added the priority/low Low priority label Oct 10, 2022
@pankajastro pankajastro mentioned this issue Oct 19, 2022
Merged
2 tasks
pankajastro added a commit that referenced this issue Oct 19, 2022
@pankajastro
Add role and permission docs link (#1103)
1aa0900 
# Description
closes: #896 

## What is the current behavior?
docs for permission and role were missing

## What is the new behavior?
Add docs links in our docs for permission and role 

## Does this introduce a breaking change?
No

### Checklist
- [x] Created tests which fail without the change (if possible)
- [x] Extended the README / documentation, if necessary
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pankajastro pankajastro

Labels
documentation Improvements or additions to documentation priority/low Low priority product/python-sdk Label describing products
Projects
None yet
Milestone
1.2.0
Development

Successfully merging a pull request may close this issue.

Add role and permission docs link astronomer/astro-sdk
4 participants
@kaxil @utkarsharma2 @phanikumv @pankajastro