Skip to content

Commit bf50a53

Browse files
authored
Add networkPolicy to user-guide-v1.adoc (#536)
1 parent 90d3447 commit bf50a53

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/user-guide-v1.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,10 @@ Each `RuntimeComponent` CR must at least specify the `.spec.applicationImage` fi
8484
| `monitoring` | Specifies parameters for `Service Monitor`. For examples, see link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#monitor-resources++[Monitor resources] and link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#specify-multiple-service-ports++[Specify multiple service ports].
8585
| `monitoring.endpoints` | A YAML snippet representing an array of link:++https://github.com/coreos/prometheus-operator/blob/main/Documentation/api.md#endpoint++[Endpoint] component from ServiceMonitor.
8686
| `monitoring.labels` | Labels to set on link:++https://github.com/coreos/prometheus-operator/blob/main/Documentation/api.md#servicemonitor++[ServiceMonitor].
87+
| `networkPolicy` | Defines the network policy. For examples, see link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#allowing-or-limiting-incoming-traffic++[Allowing or limiting incoming traffic].
88+
| `networkPolicy.disable` | A Boolean to disable the creation of the network policy. The default value is `false`. By default, network policies for an application are created and limit incoming traffic.
89+
| `networkPolicy.fromLabels` | The labels of one or more pods from which incoming traffic is allowed.
90+
| `networkPolicy.namespaceLabels` | The labels of namespaces from which incoming traffic is allowed.
8791
| `probes` | Defines health checks on an application container to determine whether it is alive or ready to receive traffic. For examples, see link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#configure-probes++[Configure probes].
8892
| `probes.liveness` | A YAML object configuring the link:++https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-a-liveness-http-request++[Kubernetes liveness probe] that controls when Kubernetes needs to restart the pod.
8993
| `probes.readiness` | A YAML object configuring the link:++https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/#define-readiness-probes++[Kubernetes readiness probe] that controls when the pod is ready to receive traffic.
@@ -287,6 +291,7 @@ Browse the `RuntimeComponent` examples to learn how to use custom resource (CR)
287291
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#configure-probes++[Configure probes (`.spec.probes`)]
288292
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#deploy-serverless-applications-with-knative++[Deploy serverless applications with Knative (`.spec.createKnativeService`)]
289293
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#expose-applications-externally++[Expose applications externally (`.spec.expose`, `.spec.createKnativeService`, `.spec.route`)]
294+
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#allowing-or-limiting-incoming-traffic++[Allowing or limiting incoming traffic (`.spec.networkPolicy`)]
290295
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#bind-applications-with-operator-managed-backing-services++[Bind applications with operator-managed backing services (`.status.binding.name` and `.spec.service.bindable`)]
291296
* link:++https://github.com/OpenLiberty/open-liberty-operator/blob/main/doc/user-guide-v1.adoc#limit-a-pod-to-run-on-specified-nodes++[Limit a pod to run on specified nodes (`.spec.affinity`)]
292297

0 commit comments

Comments
 (0)