-
Notifications
You must be signed in to change notification settings - Fork 791
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
Minor updates to website documentation #3946
base: master
Are you sure you want to change the base?
Conversation
varodrig
commented
Dec 14, 2024
- Minor updates to Central Dashboard documentation
Signed-off-by: varodrig <[email protected]>
Signed-off-by: varodrig <[email protected]>
Skipping CI for Draft Pull Request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
/assign @thesuperzapper |
@thesuperzapper @ederign any news on this PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few comments.
@@ -6,13 +6,21 @@ weight = 20 | |||
|
|||
## What is a Kubeflow Profile? | |||
|
|||
A Profile is a Kubernetes CRD introduced by Kubeflow that wraps a Kubernetes Namespace. | |||
A Kubeflow Profile is a [Kubernetes CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) introduced by Kubeflow that wraps a Kubernetes [Namespace](https://kubernetes.io/docs/tasks/administer-cluster/namespaces-walkthrough/). It is designed to solve access management within multi-user kubernetes cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not really correct to say it "solves access management" given the profile does not have any access management aspect, it literally just tells the controller to make a profile.
Access management is sadly done with the strange named RBAC resources, as described in this section.
A Kubeflow Profile is a [Kubernetes CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) introduced by Kubeflow that wraps a Kubernetes [Namespace](https://kubernetes.io/docs/tasks/administer-cluster/namespaces-walkthrough/). It is designed to solve access management within multi-user kubernetes cluster. | |
A Kubeflow Profile is a [Kubernetes CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) introduced by Kubeflow that wraps a Kubernetes [Namespace](https://kubernetes.io/docs/tasks/administer-cluster/namespaces-walkthrough/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also, this should flow into the next paragraph like the current website does, e.g. there should not be a new line here.
Profile access management provides namespace level isolation based on: | ||
|
||
* Kubernetes RBAC | ||
* Istio AuthorizationPolicy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't this this helps a new user, as this section is trying to introduce the general concept of a Profile without overwhelming the reader:
Profile access management provides namespace level isolation based on: | |
* Kubernetes RBAC | |
* Istio AuthorizationPolicy |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Co-authored-by: Mathew Wicks <[email protected]> Signed-off-by: Valentina Rodriguez Sosa <[email protected]>
Co-authored-by: Mathew Wicks <[email protected]> Signed-off-by: Valentina Rodriguez Sosa <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am not sure about these changes. I feel like most of these linked concepts (namespace, configmap, CRD, etc.) should be prerequisites before reading or learning about Kubeflow