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

Formatted networkPolicy to match feature documentation template #4467

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

dtzhou2
Copy link
Contributor

@dtzhou2 dtzhou2 commented Jun 24, 2024

What this PR does and why is it needed

Reformatted networkPolicy to match feature documentation template. Added more examples detailing different types of networkPolicies. Reworded certain sections to make more documentation more clear and easy to read.

Which issue(s) this PR fixes

Fixes #

Special notes for reviewers

How to verify it

Details to documentation updates

Reformatted networkPolicy to match feature documentation template. Added more examples detailing different types of networkPolicies. Reworded certain sections to make more documentation more clear and easy to read.

Description for the changelog

Does this PR introduce a user-facing change?


@dtzhou2 dtzhou2 requested a review from a team as a code owner June 24, 2024 14:33
@dtzhou2 dtzhou2 requested a review from jcaamano June 24, 2024 14:33
@github-actions github-actions bot added the kind/documentation All issues related to documentation label Jun 24, 2024
@coveralls
Copy link

Coverage Status

coverage: 52.723% (+0.02%) from 52.707%
when pulling b2a964a on dtzhou2:NetworkPolicy
into ebf2c68 on ovn-org:master.

@coveralls
Copy link

Coverage Status

coverage: 52.755% (+0.05%) from 52.707%
when pulling 31778cd on dtzhou2:NetworkPolicy
into ebf2c68 on ovn-org:master.

@npinaeva npinaeva requested review from npinaeva and removed request for jcaamano June 25, 2024 08:48
Copy link
Member

@npinaeva npinaeva left a comment

Choose a reason for hiding this comment

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

thank you for the contribution!

@github-actions github-actions bot added feature/egress-ip Issues related to EgressIP feature area/unit-testing Issues related to adding/updating unit tests area/e2e-testing feature/admin-network-policy labels Jul 8, 2024
@dtzhou2 dtzhou2 force-pushed the NetworkPolicy branch 2 times, most recently from 78e13ae to 6ecd30b Compare July 8, 2024 14:42
@dtzhou2
Copy link
Contributor Author

dtzhou2 commented Jul 8, 2024

Resolved reviewer suggestions,changed wording to make documentation more clear

Copy link
Member

@npinaeva npinaeva left a comment

Choose a reason for hiding this comment

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

some more nits

[Kubernetes NetworkPolicy documentation](https://kubernetes.io/docs/concepts/services-networking/network-policies)

[Kubernetes NetworkPolicy API reference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#networkpolicy-v1-networking-k8s-io)

By default, the network traffic from and to K8s pods is not restricted in any way. Using NetworkPolicy is a way to enforce network isolation of selected pods. When a pod is selected by a NetworkPolicy allowed traffic is specified by the `Ingress` and `Egress` sections.
Network Policy is a resource, which helps enforce the network isolation of pods. By default, the network traffic from and to K8s pods are not restricted in any way: NetworkPolicy resources allow us to enable and/or disable specific dataflows at a pod level.
Copy link
Member

Choose a reason for hiding this comment

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

I think the current version is more accurate, can we just leave it as is?

docs/features/network-security-controls/network-policy.md Outdated Show resolved Hide resolved

## **Unicast default-deny**
Feature is always enabled and triggered upon creation of NetworkPolicy objects.
Copy link
Member

Choose a reason for hiding this comment

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

There is a config flag for this, look for EnableAdminNetworkPolicy

Copy link
Contributor Author

Choose a reason for hiding this comment

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

From my understand AdminNetworkPolicy and NetworkPolicy were seperate objects but I may have read the documentation incorrectly

docs/features/network-security-controls/network-policy.md Outdated Show resolved Hide resolved
docs/features/network-security-controls/network-policy.md Outdated Show resolved Hide resolved
docs/features/network-security-controls/network-policy.md Outdated Show resolved Hide resolved
docs/features/network-security-controls/network-policy.md Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/e2e-testing area/unit-testing Issues related to adding/updating unit tests feature/admin-network-policy feature/egress-ip Issues related to EgressIP feature kind/documentation All issues related to documentation
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

None yet

3 participants