Add description about custom profile #48154

mochizuki875 · 2024-10-01T07:39:03Z

This PR add description about custom profile.

mochizuki875 · 2024-10-01T07:39:10Z

netlify · 2024-10-01T07:47:47Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`09df98e`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67063653428b460008f1a0a0
😎 Deploy Preview	https://deploy-preview-48154--kubernetes-io-main-staging.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.

ardaguclu

Thank you for taking care of this. Overall looks good to me, just dropped a minor comment.

content/en/docs/tasks/debug/debug-application/debug-running-pod.md

sftim

Thanks for the PR - this is a good detail to document.

Please consider these tweaks, which will help you align to our style guide.

sftim · 2024-10-01T16:42:42Z

content/en/docs/tasks/debug/debug-application/debug-running-pod.md

@@ -718,3 +718,60 @@ Clean up the Pod when you're finished with it:
 ```shell
 kubectl delete pod myapp
 ```
+
+### Custom Profile {#custom-profile}


Suggested change

### Custom Profile {#custom-profile}

## Custom profiles for ephemeral containers {#custom-profile}

Same as Debugging Profiles above, custom profile can be applied not only to an ephemeral containers, but also to a copied Pods or a debugging pods to debug nodes.
Although the following case uses an ephemeral container as an example, I think the title should remain more general, as it is now.
(While other examples can be provided, it would be redundant)

Furthermore, I think custom profile is an extension of debugging profile.
So it would be better for the Custom Profile section under Debugging Profiles to be at level ### instead of ##, or to add a new comprehensive section that consolidates the Debug Profile and Custom Profile.

content/en/docs/tasks/debug/debug-application/debug-running-pod.md

sftim · 2024-10-01T16:47:59Z

/sig cli

mochizuki875 · 2024-10-07T07:36:56Z

@sftim
Thank your for your some comment and advice.
I've addressed and left comments.

content/en/docs/tasks/debug/debug-application/debug-running-pod.md

mochizuki875 · 2024-10-08T08:14:51Z

@tengqm
Thank you for your comments, and I've addressed them.

content/en/docs/tasks/debug/debug-application/debug-running-pod.md

k8s-ci-robot · 2024-10-08T11:47:20Z

[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 assign chanieljdan 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:

content/en/docs/OWNERS

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

tengqm · 2024-10-08T13:44:12Z

content/en/docs/tasks/debug/debug-application/debug-running-pod.md

+It does not support the modification of the Pod spec.
+Modifications for `command`, `image`, `lifecycle`, `name` and `volumeDevices` fields 
+via a custom profile are not allowed.


This paragraph doesn't make sense.
If modifications to a Pod spec is not supported, why are we talking about the specific fields then?

tengqm · 2024-10-08T13:47:42Z

@mochizuki875 Please check other task pages for reference on how we structure a task pages, for example, content/en/docs/tasks/configure-pod-container/assign-cpu-resource.md.

here are some more specific guidance on this.

mochizuki875 · 2024-10-08T14:46:00Z

@tengqm
Thank you for your advice and providing the reference.
I understand that I'm writing part of the steps section(although it's not originally explicitly stated as a comment in the markdown), but after referring to this, I was unable to understand the decisive difference from a structural perspective, sorry...

The only point that comes to mind is the following, but could you let me know specifically what the issue is?

Should the section title be in the imperative rather than a noun?(e.g. Apply custom profile)
Should headings be ## rather than ###?
{{< feature-state for_k8s_version="v1.31" state="beta" >}} should not be included?

tengqm · 2024-10-08T22:57:29Z

The only point that comes to mind is the following, but could you let me know specifically what the issue is?

My suggestion was to improve the structure of the page so that it is more like a "task" page.

* Should the section title be in the imperative rather than a noun?(e.g. Apply custom profile)

Yes.

* Should headings be `##` rather than `###`?

## stands for <H2> in HTML, ### stands for <H3> in HTML. The top-level headings for a page should be ##.

* `{{< feature-state for_k8s_version="v1.31" state="beta" >}}` should not be included?

The feature-state stanza is a Docsy shortcode. It is included to indicate that the content
is about a feature under development. Use it when necessary.

mochizuki875 · 2024-10-09T06:05:12Z

@tengqm

My suggestion was to improve the structure of the page so that it is more like a "task" page.

Are you suggesting that, rather than limiting the scope of this PR to the custom profile, we should revamp the entire page to follow the task style in this PR?

If so, how about addressing it as a separate issue?
The purpose of this PR is to inform users about the Custom Profile, which has not yet been documented, and I believe this provides some value to the users.
e.g.) related kubernetes/kubectl#1650

tengqm · 2024-10-09T07:08:56Z

@tengqm

My suggestion was to improve the structure of the page so that it is more like a "task" page.

Are you suggesting that, rather than limiting the scope of this PR to the custom profile, we should revamp the entire page to follow the task style in this PR?

If so, how about addressing it as a separate issue?

I'm okay with that, considering that this PR is not about a new task page.
But please do as much as you can to follow the desired structure of a task page.

mochizuki875 · 2024-10-09T07:55:50Z

@tengqm
OK, so I've restructured the section regarding profiles with some fixes.

tengqm · 2024-10-09T08:06:04Z

/lgtm

k8s-ci-robot · 2024-10-09T08:06:12Z

LGTM label has been added.

Git tree hash: 7846deee2092b94c295978160cc1da48fe0d99d0

Add custom profile

c7348db

k8s-ci-robot requested review from kbhawkey and soltysh October 1, 2024 07:39

k8s-ci-robot added language/en Issues or PRs related to English language cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 1, 2024

k8s-ci-robot requested a review from ardaguclu October 1, 2024 07:39

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Oct 1, 2024

ardaguclu reviewed Oct 1, 2024

View reviewed changes

content/en/docs/tasks/debug/debug-application/debug-running-pod.md Outdated Show resolved Hide resolved

sftim reviewed Oct 1, 2024

View reviewed changes

k8s-ci-robot added the sig/cli Categorizes an issue or PR as relevant to SIG CLI. label Oct 1, 2024

fix1

22c400b

mochizuki875 force-pushed the add_custom_profile branch from 6655ec9 to 22c400b Compare October 7, 2024 07:27

tengqm reviewed Oct 8, 2024

View reviewed changes

fix2

636ae0f

tengqm reviewed Oct 8, 2024

View reviewed changes

content/en/docs/tasks/debug/debug-application/debug-running-pod.md Outdated Show resolved Hide resolved

fix3

16112b8

tengqm reviewed Oct 8, 2024

View reviewed changes

fix4

09df98e

k8s-ci-robot assigned tengqm Oct 9, 2024

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 9, 2024

tengqm added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Oct 9, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add description about custom profile #48154

Add description about custom profile #48154

mochizuki875 commented Oct 1, 2024

mochizuki875 commented Oct 1, 2024

netlify bot commented Oct 1, 2024 •

edited

Loading

ardaguclu left a comment

sftim left a comment

sftim Oct 1, 2024

mochizuki875 Oct 7, 2024

sftim commented Oct 1, 2024

mochizuki875 commented Oct 7, 2024

mochizuki875 commented Oct 8, 2024

k8s-ci-robot commented Oct 8, 2024

tengqm Oct 8, 2024

tengqm commented Oct 8, 2024

mochizuki875 commented Oct 8, 2024

tengqm commented Oct 8, 2024

mochizuki875 commented Oct 9, 2024

tengqm commented Oct 9, 2024

mochizuki875 commented Oct 9, 2024

tengqm commented Oct 9, 2024

k8s-ci-robot commented Oct 9, 2024

	### Custom Profile {#custom-profile}
	## Custom profiles for ephemeral containers {#custom-profile}

Add description about custom profile #48154

Are you sure you want to change the base?

Add description about custom profile #48154

Conversation

mochizuki875 commented Oct 1, 2024

mochizuki875 commented Oct 1, 2024

netlify bot commented Oct 1, 2024 • edited Loading

✅ Pull request preview available for checking

ardaguclu left a comment

Choose a reason for hiding this comment

sftim left a comment

Choose a reason for hiding this comment

sftim Oct 1, 2024

Choose a reason for hiding this comment

mochizuki875 Oct 7, 2024

Choose a reason for hiding this comment

sftim commented Oct 1, 2024

mochizuki875 commented Oct 7, 2024

mochizuki875 commented Oct 8, 2024

k8s-ci-robot commented Oct 8, 2024

tengqm Oct 8, 2024

Choose a reason for hiding this comment

tengqm commented Oct 8, 2024

mochizuki875 commented Oct 8, 2024

tengqm commented Oct 8, 2024

mochizuki875 commented Oct 9, 2024

tengqm commented Oct 9, 2024

mochizuki875 commented Oct 9, 2024

tengqm commented Oct 9, 2024

k8s-ci-robot commented Oct 9, 2024

netlify bot commented Oct 1, 2024 •

edited

Loading