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

Minor updates to website documentation #3946

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

varodrig
Copy link
Contributor

  • Minor updates to Central Dashboard documentation

Copy link

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

lgtm

@varodrig
Copy link
Contributor Author

/assign @thesuperzapper

@varodrig
Copy link
Contributor Author

varodrig commented Jan 19, 2025

@thesuperzapper @ederign any news on this PR?

Copy link
Member

@thesuperzapper thesuperzapper left a 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.
Copy link
Member

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.

Suggested change
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/).

Copy link
Member

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.

content/en/docs/components/central-dash/profiles.md Outdated Show resolved Hide resolved
Comment on lines +12 to +15
Profile access management provides namespace level isolation based on:

* Kubernetes RBAC
* Istio AuthorizationPolicy
Copy link
Member

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:

Suggested change
Profile access management provides namespace level isolation based on:
* Kubernetes RBAC
* Istio AuthorizationPolicy

Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from thesuperzapper. For more information see the Kubernetes Code Review Process.

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

varodrig and others added 2 commits January 31, 2025 18:11
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]>
Copy link
Member

@terrytangyuan terrytangyuan left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants