[doc] Add steps how to access VisibilityOnDemand via curl #1824

xmolitann · 2024-03-12T12:21:37Z

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Docs are missing a guide on how to access VisibilityOnDemand via curl, omitting kubectl get --raw ..... This is needed if you want to use it programmatically.

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

linux-foundation-easycla · 2024-03-12T12:21:41Z

❌ login: @mmolisch / The commit (8289fb9). This user is authorized, but they must confirm their affiliation with their company. Start the authorization process by clicking here, click "Corporate", select the appropriate company from the list, then confirm your affiliation on the page that appears. For further assistance with EasyCLA, please submit a support request ticket.

k8s-ci-robot · 2024-03-12T12:21:46Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: xmolitann
Once this PR has been reviewed and has the lgtm label, please assign moficodes for approval. 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:

site/OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

k8s-ci-robot · 2024-03-12T12:21:46Z

Welcome @xmolitann!

It looks like this is your first PR to kubernetes-sigs/kueue 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kueue has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2024-03-12T12:21:47Z

Hi @xmolitann. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

netlify · 2024-03-12T12:21:56Z

✅ Deploy Preview for kubernetes-sigs-kueue ready!

Name	Link
🔨 Latest commit	`8289fb9`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-sigs-kueue/deploys/65f048d48b271b00080570f6
😎 Deploy Preview	https://deploy-preview-1824--kubernetes-sigs-kueue.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

k8s-ci-robot · 2024-03-26T05:36:03Z

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

mimowo · 2024-05-07T15:59:02Z

/cc @PBundyra

PBundyra

Thanks for the PR! Looks good, just a few nits.

PBundyra · 2024-05-08T11:30:53Z

site/static/examples/admin/cluster-role-and-binding.yaml

+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: kueue-api-get


Could you please rename this to better reflect its purpose within the Visibility API?

PBundyra · 2024-05-08T11:31:14Z

site/static/examples/admin/cluster-role-and-binding.yaml

+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: kueue-api-get


PBundyra · 2024-05-08T11:35:40Z

site/static/examples/admin/cluster-role-and-binding.yaml

Could you please rename this file to better reflect its purpose within the Visibility API?

PBundyra · 2024-05-09T11:41:48Z

site/content/en/docs/tasks/monitor_pending_workloads/pending_workloads_on_demand.md

+TOKEN=$(kubectl get secret default-token -o jsonpath='{.data.token}' | base64 --decode)
+APISERVER=$(kubectl config view -o jsonpath="{.clusters[?(@.name==\"$CLUSTER_NAME\")].cluster.server}")
+
+curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/clusterqueues/cluster-queue/pendingworkloads --header "Authorization: Bearer $TOKEN | jq"


Suggested change

curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/clusterqueues/cluster-queue/pendingworkloads --header "Authorization: Bearer $TOKEN | jq"

curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/clusterqueues/cluster-queue/pendingworkloads --header "Authorization: Bearer $TOKEN" --insecure | jq

PBundyra · 2024-05-09T11:42:15Z

site/content/en/docs/tasks/monitor_pending_workloads/pending_workloads_on_demand.md

+TOKEN=$(kubectl get secret default-token -o jsonpath='{.data.token}' | base64 --decode)
+APISERVER=$(kubectl config view -o jsonpath="{.clusters[?(@.name==\"$CLUSTER_NAME\")].cluster.server}")
+
+curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/namespaces/default/localqueues/user-queue/pendingworkloads --header "Authorization: Bearer $TOKEN | jq"


Suggested change

curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/namespaces/default/localqueues/user-queue/pendingworkloads --header "Authorization: Bearer $TOKEN | jq"

curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/namespaces/default/localqueues/user-queue/pendingworkloads --header "Authorization: Bearer $TOKEN" --insecure | jq

PBundyra · 2024-05-09T11:42:37Z

site/static/examples/admin/cluster-role-and-binding.yaml

+  name: kueue-api-get
+subjects:
+- kind: ServiceAccount
+  name: default


I think we're missing namespace here

PBundyra · 2024-05-09T11:51:28Z

Due to the need of using --insecure flag to avoid using proxy, a user is exposed to MITM attacks which I believe is undesired. Can we find any other alternative or mitigation of this risk?

Docs: https://kubernetes.io/docs/tasks/administer-cluster/access-cluster-api/#without-kubectl-proxy

[doc] Add steps how to access VisibilityOnDemand via curl

8289fb9

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. labels Mar 12, 2024

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 12, 2024

k8s-ci-robot requested review from denkensk and mimowo March 12, 2024 12:21

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Mar 12, 2024

k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 12, 2024

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 26, 2024

k8s-ci-robot requested a review from PBundyra May 7, 2024 15:59

PBundyra reviewed May 8, 2024

View reviewed changes

PBundyra suggested changes May 9, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] Add steps how to access VisibilityOnDemand via curl #1824

[doc] Add steps how to access VisibilityOnDemand via curl #1824

xmolitann commented Mar 12, 2024

linux-foundation-easycla bot commented Mar 12, 2024 •

edited

k8s-ci-robot commented Mar 12, 2024

k8s-ci-robot commented Mar 12, 2024

k8s-ci-robot commented Mar 12, 2024

netlify bot commented Mar 12, 2024 •

edited

k8s-ci-robot commented Mar 26, 2024

mimowo commented May 7, 2024

PBundyra left a comment

PBundyra May 8, 2024

PBundyra May 8, 2024

PBundyra May 8, 2024

PBundyra May 9, 2024

PBundyra May 9, 2024

PBundyra May 9, 2024

PBundyra commented May 9, 2024

	curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/clusterqueues/cluster-queue/pendingworkloads --header "Authorization: Bearer $TOKEN \| jq"
	curl -X GET $APISERVER/apis/visibility.kueue.x-k8s.io/v1alpha1/clusterqueues/cluster-queue/pendingworkloads --header "Authorization: Bearer $TOKEN" --insecure \| jq

[doc] Add steps how to access VisibilityOnDemand via curl #1824

Are you sure you want to change the base?

[doc] Add steps how to access VisibilityOnDemand via curl #1824

Conversation

xmolitann commented Mar 12, 2024

What type of PR is this?

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

linux-foundation-easycla bot commented Mar 12, 2024 • edited

k8s-ci-robot commented Mar 12, 2024

k8s-ci-robot commented Mar 12, 2024

k8s-ci-robot commented Mar 12, 2024

netlify bot commented Mar 12, 2024 • edited

✅ Deploy Preview for kubernetes-sigs-kueue ready!

k8s-ci-robot commented Mar 26, 2024

mimowo commented May 7, 2024

PBundyra left a comment

Choose a reason for hiding this comment

PBundyra May 8, 2024

Choose a reason for hiding this comment

PBundyra May 8, 2024

Choose a reason for hiding this comment

PBundyra May 8, 2024

Choose a reason for hiding this comment

PBundyra May 9, 2024

Choose a reason for hiding this comment

PBundyra May 9, 2024

Choose a reason for hiding this comment

PBundyra May 9, 2024

Choose a reason for hiding this comment

PBundyra commented May 9, 2024

linux-foundation-easycla bot commented Mar 12, 2024 •

edited

netlify bot commented Mar 12, 2024 •

edited