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

[Docs] Ray plugin documentation missing details #5738

Open
2 tasks done
Tracked by #5783
davidmirror-ops opened this issue Sep 11, 2024 · 5 comments · May be fixed by #5839
Open
2 tasks done
Tracked by #5783

[Docs] Ray plugin documentation missing details #5738

davidmirror-ops opened this issue Sep 11, 2024 · 5 comments · May be fixed by #5839
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest

Comments

@davidmirror-ops
Copy link
Contributor

davidmirror-ops commented Sep 11, 2024

Description

To ensure the example is reproducible, the following elements are missing:

  1. Make imports visible in the docs page, not only in the flytesnacks repo
  2. How to set up the ClusterRole with the permissions to create rayjobs. Otherwise the example throws an error. This could be part of the plugin setup guide

cannot create resource "rayjobs" in API group "ray.io" in the namespace "flytesnacks-development

In particular, the ClusterRole is missing the following permissions:

rbac:
  extraRules:
    - apiGroups:
      - "ray.io"
      resources:
      - rayjobs
      verbs:
      - create
      - get
      - list
      - patch
      - update
      - delete

Are you sure this issue hasn't been raised already?

  • Yes

Have you read the Code of Conduct?

  • Yes
@davidmirror-ops davidmirror-ops added documentation Improvements or additions to documentation untriaged This issues has not yet been looked at by the Maintainers labels Sep 11, 2024
@davidmirror-ops
Copy link
Contributor Author

Also: how to generate valid link to the Ray dashboard in the UI.

@eapolinario eapolinario removed the untriaged This issues has not yet been looked at by the Maintainers label Sep 19, 2024
@aazam-gh
Copy link

aazam-gh commented Oct 2, 2024

Hi, I would love to work on this :)

@davidmirror-ops
Copy link
Contributor Author

@aazam-gh sure! Please let us know if you have any question. Thanks

@aazam-gh
Copy link

aazam-gh commented Oct 7, 2024

@davidmirror-ops a few questions :)

The repository to make the changes is the flysnacks repo correct?

Both the configure plugins and the Ray plugin page will need to be updated right?

@davidmirror-ops
Copy link
Contributor Author

@aazam-gh I think it's only the plugin configuration page adding the rbac block to the configuration for both flyte-core and flyte-binary. You can look at the base charts to validate indentation

@aazam-gh aazam-gh linked a pull request Oct 10, 2024 that will close this issue
3 tasks
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 good first issue Good for newcomers hacktoberfest
Projects
Status: Assigned
Development

Successfully merging a pull request may close this issue.

3 participants