Skip to content

DOCS-3096: Fix inaccuracies on the StagedKubernetesNetworkPolicy reference #3117

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.

Sign up for GitHub

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

Merged
ctauchen merged 6 commits into from
Oct 19, 2026
Merged

DOCS-3096: Fix inaccuracies on the StagedKubernetesNetworkPolicy reference #3117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
afdd1cd
Fix inaccuracies on the StagedKubernetesNetworkPolicy reference for next
ctauchen Oct 16, 2026
a80723e
Fix inaccuracies on the StagedKubernetesNetworkPolicy reference for 3.33
ctauchen Oct 16, 2026
f310755
Fix inaccuracies on the StagedKubernetesNetworkPolicy reference for 3.32
ctauchen Oct 16, 2026
4734e0d
Fix inaccuracies on the StagedKubernetesNetworkPolicy reference for 3.31
ctauchen Oct 16, 2026
c49f8e9
Fix policyTypes and stagedAction for native v3 CRDs in the next Stage…
ctauchen Oct 19, 2026
e11d0f2
Fix policyTypes and stagedAction for native v3 CRDs in the 3.33 Stage…
ctauchen Oct 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions calico/reference/resources/stagedkubernetesnetworkpolicy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version
of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies).
This is used to preview network behavior before actually enforcing the network policy. Once persisted, this
will create a Kubernetes network policy backed by a $[prodname]
[network policy](networkpolicy.mdx).
is converted to a $[prodname]
[network policy](networkpolicy.mdx) that is not enforced.

For `kubectl` [commands](https://kubernetes.io/docs/reference/kubectl/overview/), the following case-insensitive aliases
may be used to specify the resource type on the CLI:
Expand Down Expand Up @@ -63,3 +63,13 @@

See the [Kubernetes NetworkPolicy documentation](https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#networkpolicyspec-v1-networking-k8s-io)
for more information.

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------- | --------- |
| stagedAction | The staged action. With `Delete`, leave every other spec field empty, and the policy is not sent to Felix. | `Set`, `Delete`, `Learn`, `Ignore` | string | `Set` |

Check failure on line 71 in calico/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'stagedAction'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'stagedAction'?","location":{"path":"calico/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":71,"column":3},"end":{"line":71,"column":15}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| podSelector | Selects the pods in the namespace to which this policy applies. An empty selector matches all pods in the namespace. | | Kubernetes `LabelSelector` | |

Check failure on line 72 in calico/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'podSelector'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'podSelector'?","location":{"path":"calico/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":72,"column":3},"end":{"line":72,"column":14}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| ingress | List of ingress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyIngressRule` | |
| egress | List of egress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyEgressRule` | |
| policyTypes | Applies the policy to ingress traffic (`Ingress`), egress traffic (`Egress`), or both. If omitted and the policy has no egress rules, the policy applies to ingress traffic only. If the policy has egress rules, set this field: when it is omitted, clusters that use native v3 CRDs store `Ingress, Egress`, but clusters that use the $[prodname] API server apply the policy to ingress traffic only. | `Ingress`, `Egress` | List of strings | |

Check failure on line 75 in calico/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'policyTypes'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'policyTypes'?","location":{"path":"calico/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":75,"column":3},"end":{"line":75,"column":14}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
14 changes: 12 additions & 2 deletions ...rsioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version
of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies).
This is used to preview network behavior before actually enforcing the network policy. Once persisted, this
will create a Kubernetes network policy backed by a $[prodname]
[network policy](networkpolicy.mdx).
is converted to a $[prodname]
[network policy](networkpolicy.mdx) that is not enforced.

For `kubectl` [commands](https://kubernetes.io/docs/reference/kubectl/overview/), the following case-insensitive aliases
may be used to specify the resource type on the CLI:
Expand Down Expand Up @@ -63,3 +63,13 @@

See the [Kubernetes NetworkPolicy documentation](https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#networkpolicyspec-v1-networking-k8s-io)
for more information.

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------- | --------- |
| stagedAction | The staged action. With `Delete`, all other spec fields must be empty, and the policy is not sent to Felix. | `Set`, `Delete`, `Learn`, `Ignore` | string | `Set` |

Check failure on line 71 in calico_versioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'stagedAction'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'stagedAction'?","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":71,"column":3},"end":{"line":71,"column":15}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| podSelector | Selects the pods in the namespace to which this policy applies. An empty selector matches all pods in the namespace. | | Kubernetes `LabelSelector` | |

Check failure on line 72 in calico_versioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'podSelector'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'podSelector'?","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":72,"column":3},"end":{"line":72,"column":14}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| ingress | List of ingress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyIngressRule` | |
| egress | List of egress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyEgressRule` | |
| policyTypes | Applies the policy to ingress traffic (`Ingress`), egress traffic (`Egress`), or both. If omitted, the staged policy applies to ingress traffic only. | `Ingress`, `Egress` | List of strings | `Ingress` |

Check failure on line 75 in calico_versioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'policyTypes'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'policyTypes'?","location":{"path":"calico_versioned_docs/version-3.31/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":75,"column":3},"end":{"line":75,"column":14}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
14 changes: 12 additions & 2 deletions ...rsioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version
of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies).
This is used to preview network behavior before actually enforcing the network policy. Once persisted, this
will create a Kubernetes network policy backed by a $[prodname]
[network policy](networkpolicy.mdx).
is converted to a $[prodname]
[network policy](networkpolicy.mdx) that is not enforced.

For `kubectl` [commands](https://kubernetes.io/docs/reference/kubectl/overview/), the following case-insensitive aliases
may be used to specify the resource type on the CLI:
Expand Down Expand Up @@ -63,3 +63,13 @@

See the [Kubernetes NetworkPolicy documentation](https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#networkpolicyspec-v1-networking-k8s-io)
for more information.

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------- | --------- |
| stagedAction | The staged action. With `Delete`, all other spec fields must be empty, and the policy is not sent to Felix. | `Set`, `Delete`, `Learn`, `Ignore` | string | `Set` |

Check failure on line 71 in calico_versioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'stagedAction'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'stagedAction'?","location":{"path":"calico_versioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":71,"column":3},"end":{"line":71,"column":15}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| podSelector | Selects the pods in the namespace to which this policy applies. An empty selector matches all pods in the namespace. | | Kubernetes `LabelSelector` | |

Check failure on line 72 in calico_versioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'podSelector'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'podSelector'?","location":{"path":"calico_versioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":72,"column":3},"end":{"line":72,"column":14}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
| ingress | List of ingress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyIngressRule` | |
| egress | List of egress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyEgressRule` | |
| policyTypes | Applies the policy to ingress traffic (`Ingress`), egress traffic (`Egress`), or both. If omitted, the staged policy applies to ingress traffic only. | `Ingress`, `Egress` | List of strings | `Ingress` |

Check failure on line 75 in calico_versioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'policyTypes'?

Raw Output:
{"message":"[Vale.Spelling] Did you really mean 'policyTypes'?","location":{"path":"calico_versioned_docs/version-3.32/reference/resources/stagedkubernetesnetworkpolicy.mdx","range":{"start":{"line":75,"column":3},"end":{"line":75,"column":14}}},"severity":"ERROR","code":{"value":"Vale.Spelling"}}
14 changes: 12 additions & 2 deletions ...rsioned_docs/version-3.33/reference/resources/stagedkubernetesnetworkpolicy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ description: Reference for the StagedKubernetesNetworkPolicy resource in Calico
A staged Kubernetes network policy resource (`StagedKubernetesNetworkPolicy`) represents a staged version
of [Kubernetes network policy](https://kubernetes.io/docs/concepts/services-networking/network-policies).
This is used to preview network behavior before actually enforcing the network policy. Once persisted, this
will create a Kubernetes network policy backed by a $[prodname]
[network policy](networkpolicy.mdx).
is converted to a $[prodname]
[network policy](networkpolicy.mdx) that is not enforced.

For `kubectl` [commands](https://kubernetes.io/docs/reference/kubectl/overview/), the following case-insensitive aliases
may be used to specify the resource type on the CLI:
Expand Down Expand Up @@ -63,3 +63,13 @@ spec:

See the [Kubernetes NetworkPolicy documentation](https://v1-21.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.21/#networkpolicyspec-v1-networking-k8s-io)
for more information.

### Spec

| Field | Description | Accepted Values | Schema | Default |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- | --------------------------------------------- | --------- |
| stagedAction | The staged action. With `Delete`, leave every other spec field empty, and the policy is not sent to Felix. | `Set`, `Delete`, `Learn`, `Ignore` | string | `Set` |
| podSelector | Selects the pods in the namespace to which this policy applies. An empty selector matches all pods in the namespace. | | Kubernetes `LabelSelector` | |
| ingress | List of ingress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyIngressRule` | |
| egress | List of egress rules applied to the selected pods. | | List of Kubernetes `NetworkPolicyEgressRule` | |
| policyTypes | Applies the policy to ingress traffic (`Ingress`), egress traffic (`Egress`), or both. If omitted and the policy has no egress rules, the policy applies to ingress traffic only. If the policy has egress rules, set this field: when it is omitted, clusters that use native v3 CRDs store `Ingress, Egress`, but clusters that use the $[prodname] API server apply the policy to ingress traffic only. | `Ingress`, `Egress` | List of strings | |
Loading