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

RBAC resource sharing #2320

Merged
merged 11 commits into from
Jan 22, 2024
Merged

RBAC resource sharing #2320

merged 11 commits into from
Jan 22, 2024

Conversation

schustmi
Copy link
Contributor

@schustmi schustmi commented Jan 18, 2024

Describe changes

This PR adds a new endpoint to enable sharing single resources using RBAC.

Pre-requisites

Please ensure you have done the following:

  • I have read the CONTRIBUTING.md document.
  • If my change requires a change to docs, I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • I have based my new branch on develop and the open PR is targeting develop. If your branch wasn't based on develop read Contribution guide on rebasing branch to develop.
  • If my changes require changes to the dashboard, these changes are communicated/requested.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Other (add details above)

Copy link
Contributor

coderabbitai bot commented Jan 18, 2024

Important

Auto Review Skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository.

To trigger a single review, invoke the @coderabbitai review command.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

@github-actions github-actions bot added internal To filter out internal PRs and issues enhancement New feature or request labels Jan 18, 2024
Copy link
Contributor

E2E template updates in examples/e2e have been pushed.

@schustmi schustmi marked this pull request as ready for review January 19, 2024 08:52
Copy link
Contributor

Quickstart template updates in examples/quickstart have been pushed.

Copy link
Contributor

E2E template updates in examples/e2e have been pushed.

Copy link
Contributor

NLP template updates in examples/e2e_nlp have been pushed.

Copy link
Contributor

@AlexejPenner AlexejPenner left a comment

Choose a reason for hiding this comment

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

Got two larger questions. Besides those you got my 🦭 of approval.

src/zenml/zen_server/rbac/zenml_cloud_rbac.py Show resolved Hide resolved
},
)
@handle_exceptions
def update_user_resource_membership(
Copy link
Contributor

@AlexejPenner AlexejPenner Jan 19, 2024

Choose a reason for hiding this comment

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

Correct me if I'm wrong. This handles adding a Permission to a User for a Resource. How would I remove a permission?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You would remove a permission by sending an empty list of actions. I think I might have to document that in the docstring though, or do you think having two separate endpoints makes more sense. It's definitely a little confusing with the RBACInterface.share_resource(...) method name though, maybe that should have two separate methods or it should also be called RBACInterface.update_resource_membership(...)?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 for the renaming

Copy link
Contributor

E2E template updates in examples/e2e have been pushed.

Copy link
Contributor

@AlexejPenner AlexejPenner left a comment

Choose a reason for hiding this comment

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

🦭

@schustmi schustmi merged commit 8d18dec into develop Jan 22, 2024
31 of 32 checks passed
@schustmi schustmi deleted the feature/rbac-resource-sharing branch January 22, 2024 10:43
kabinja pushed a commit to kabinja/zenml that referenced this pull request Jan 29, 2024
* Add endpoint for resource sharing

* Auto-update of E2E template

* Auto-update of Starter template

* Auto-update of E2E template

* Auto-update of NLP template

* Rename sharing methods

* Auto-update of E2E template

* Fix docstrings

---------

Co-authored-by: GitHub Actions <[email protected]>
adtygan pushed a commit to adtygan/zenml that referenced this pull request Mar 21, 2024
* Add endpoint for resource sharing

* Auto-update of E2E template

* Auto-update of Starter template

* Auto-update of E2E template

* Auto-update of NLP template

* Rename sharing methods

* Auto-update of E2E template

* Fix docstrings

---------

Co-authored-by: GitHub Actions <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request internal To filter out internal PRs and issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants