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

Confusing wording in "Declare Network Policy" task page #49847

Open
botanyhelp opened this issue Feb 20, 2025 · 8 comments
Open

Confusing wording in "Declare Network Policy" task page #49847

botanyhelp opened this issue Feb 20, 2025 · 8 comments
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@botanyhelp
Copy link

botanyhelp commented Feb 20, 2025

Suggestion about confusing wording, in particular, this line on page at k8s.io/docs/tasks/administer-cluster/declare-network-policy/ :

Assign the policy to the service

I have two problems with that:

  • we are actually creating-the-network-policy-object, not assigning-policy-to-the-service
  • mentioning "service" is misleading because Network Policies apply to pods and have nothing to do with Services, there is no way to firewall a service even though it sounds right

NOTICE: I am not a kubernetes expert! Just really enjoying the excellent documentation, thanks!!!

Page: https://k8s.io/docs/tasks/administer-cluster/declare-network-policy/

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Feb 20, 2025
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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-sigs/prow repository.

@sftim
Copy link
Contributor

sftim commented Feb 20, 2025

/retitle Confusing working in "Declare Network Policy" task page
/language en

@k8s-ci-robot k8s-ci-robot changed the title Issue with k8s.io/docs/tasks/administer-cluster/declare-network-policy/ Confusing working in "Declare Network Policy" task page Feb 20, 2025
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Feb 20, 2025
@sftim
Copy link
Contributor

sftim commented Feb 20, 2025

How about "Define a network policy that applies to the workload"?

@botanyhelp
Copy link
Author

That would be okay. The YAML text shown above the headline is the definition of the Network Policy, so I think changing the confusing headline is needed, especially to remove words "service" and "assign". This is the confusing headline to be replaced:

BAD:
Assign the policy to the service

Good replacements might be:

BETTER OPTIONS:
Apply the Network Policy
Create the NetworkPolicy object

Your suggestion:
"Define a network policy that applies to the workload"
..is an improvement but the policy will apply to pods that match the podSelector criteria, so I like "pod" better than "workload". Network Policies apply to pods, and only pods.

@dhairya-seth
Copy link

"Apply the Network Policy to Pods" would be a better option.

@dhairya-seth
Copy link

We are applying a Network Policy to Pods, not a Service. This heading will eliminate any confusion and accurately describes the action.

@sftim
Copy link
Contributor

sftim commented Feb 21, 2025

/retitle Confusing wording in "Declare Network Policy" task page

@k8s-ci-robot k8s-ci-robot changed the title Confusing working in "Declare Network Policy" task page Confusing wording in "Declare Network Policy" task page Feb 21, 2025
@botanyhelp
Copy link
Author

I agree with @dhairya-seth who say:

"Apply the Network Policy to Pods" would be a better option.

Thanks everyone..I do not collaborate on GitHub docs often, your patience is appreciated!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
language/en Issues or PRs related to English language needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

4 participants