Skip to content

Commit 920e0ef

Browse files
committed
Refresh terminology style
1 parent a693e2a commit 920e0ef

File tree

73 files changed

+285
-312
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

73 files changed

+285
-312
lines changed

modules/nw-about-multicast.adoc

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,8 @@ Multicast traffic between {product-title} pods is disabled by default. If you ar
2828
ifdef::openshift-sdn[]
2929
When using the OpenShift SDN network plug-in in `networkpolicy` isolation mode:
3030

31-
* Multicast packets sent by a pod will be delivered to all other pods in the
32-
project, regardless of NetworkPolicy objects. Pods might be able to communicate
33-
over multicast even when they cannot communicate over unicast.
34-
* Multicast packets sent by a pod in one project will never be delivered to pods
35-
in any other project, even if there are NetworkPolicy objects that allow
36-
communication between the projects.
31+
* Multicast packets sent by a pod will be delivered to all other pods in the project, regardless of `NetworkPolicy` objects. Pods might be able to communicate over multicast even when they cannot communicate over unicast.
32+
* Multicast packets sent by a pod in one project will never be delivered to pods in any other project, even if there are `NetworkPolicy` objects that allow communication between the projects.
3733

3834
When using the OpenShift SDN network plug-in in `multitenant` isolation mode:
3935

modules/nw-configuring-high-performance-multicast-with-sriov.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ For applications such as streaming media, like Internet Protocol television (IPT
1010

1111
When using additional SR-IOV interfaces for multicast:
1212

13-
* Multicast packages must be sent or received by a Pod through the additional SR-IOV interface.
13+
* Multicast packages must be sent or received by a pod through the additional SR-IOV interface.
1414
* The physical network which connects the SR-IOV interfaces decides the
1515
multicast routing and topology, which is not controlled by {product-title}.
1616

@@ -26,7 +26,7 @@ The follow procedure creates an example SR-IOV interface for multicast.
2626

2727
.Procedure
2828

29-
. Create a SriovNetworkNodePolicy custom resource (CR):
29+
. Create a `SriovNetworkNodePolicy` object:
3030
+
3131
[source,yaml]
3232
----
@@ -46,7 +46,7 @@ spec:
4646
rootDevices: ['0000:86:00.0']
4747
----
4848

49-
. Create a SriovNetwork CR:
49+
. Create a `SriovNetwork` object:
5050
+
5151
[source,yaml]
5252
----
@@ -73,7 +73,7 @@ spec:
7373
----
7474
<1> If you choose to configure DHCP as IPAM, ensure that you provision the following default routes through your DHCP server: `224.0.0.0/5` and `232.0.0.0/5`. This is to override the static multicast route set by the default network provider.
7575

76-
. Create a Pod with multicast application:
76+
. Create a pod with multicast application:
7777
+
7878
[source,yaml]
7979
----

modules/nw-dns-operator.adoc

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@
55
= DNS Operator
66

77
The DNS Operator implements the `dns` API from the `operator.openshift.io` API
8-
group. The operator deploys CoreDNS using a daemon set, creates a Service for
8+
group. The Operator deploys CoreDNS using a daemon set, creates a service for
99
the daemon set, and configures the kubelet to instruct pods to use the CoreDNS
10-
Service IP for name resolution.
10+
service IP address for name resolution.
1111

1212
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
1313
.Procedure
14-
The DNS Operator is deployed during installation as a Kubernetes `Deployment`.
1514

16-
. Use the `oc get` command to view the Deployment status:
15+
The DNS Operator is deployed during installation with a `Deployment` object.
16+
17+
. Use the `oc get` command to view the deployment status:
1718
+
1819
[source,terminal]
1920
----
@@ -26,9 +27,6 @@ $ oc get -n openshift-dns-operator deployment/dns-operator
2627
NAME READY UP-TO-DATE AVAILABLE AGE
2728
dns-operator 1/1 1 1 23h
2829
----
29-
ClusterOperator is the Custom Resource object which holds the current state
30-
of an operator. This object is used by operators to convey their state to
31-
the rest of the cluster.
3230

3331
. Use the `oc get` command to view the state of the DNS Operator:
3432
+
@@ -44,7 +42,5 @@ NAME VERSION AVAILABLE PROGRESSING DEGRADED SINCE
4442
dns 4.1.0-0.11 True False False 92m
4543
----
4644
+
47-
`AVAILABLE`, `PROGRESSING` and `DEGRADED` provide information about the status of
48-
the operator. `AVAILABLE` is `True` when at least 1 pod from the CoreDNS DaemonSet
49-
is reporting an `Available` status condition.
45+
`AVAILABLE`, `PROGRESSING` and `DEGRADED` provide information about the status of the operator. `AVAILABLE` is `True` when at least 1 pod from the CoreDNS daemon set reports an `Available` status condition.
5046
endif::[]

modules/nw-dns-view.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Status:
3232
...
3333
----
3434
<1> The Cluster Domain field is the base DNS domain used to construct fully
35-
qualified Pod and Service domain names.
35+
qualified pod and service domain names.
3636
<2> The Cluster IP is the address pods query for name resolution. The IP is
37-
defined as the 10th address in the Service CIDR range.
37+
defined as the 10th address in the service CIDR range.
3838

3939
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
40-
. To find the Service CIDR of your cluster,
40+
. To find the service CIDR of your cluster,
4141
use the `oc get` command:
4242
+
4343
[source,terminal]

modules/nw-egress-ips-about.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,13 +134,13 @@ Egress IP addresses must not be configured in any Linux network configuration fi
134134
Allowing additional IP addresses on the primary network interface might require extra configuration when using some cloud or VM solutions.
135135
====
136136

137-
You can assign egress IP addresses to namespaces by setting the `egressIPs` parameter of the `NetNamespace` resource. After an egress IP is associated with a project, OpenShift SDN allows you to assign egress IPs to hosts in two ways:
137+
You can assign egress IP addresses to namespaces by setting the `egressIPs` parameter of the `NetNamespace` object. After an egress IP is associated with a project, OpenShift SDN allows you to assign egress IPs to hosts in two ways:
138138

139139
* In the _automatically assigned_ approach, an egress IP address range is assigned to a node.
140140
* In the _manually assigned_ approach, a list of one or more egress IP address is assigned to a node.
141141

142142
Namespaces that request an egress IP address are matched with nodes that can host those egress IP addresses, and then the egress IP addresses are assigned to those nodes.
143-
If the `egressIPs` parameter is set on a `NetNamespace` resource, but no node hosts that egress IP address, then egress traffic from the namespace will be dropped.
143+
If the `egressIPs` parameter is set on a `NetNamespace` object, but no node hosts that egress IP address, then egress traffic from the namespace will be dropped.
144144

145145
High availability of nodes is automatic.
146146
If a node that hosts an egress IP address is unreachable and there are nodes that are able to host that egress IP address, then the egress IP address will move to a new node.

modules/nw-egress-ips-automatic.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ for a specific namespace across one or more nodes.
1515

1616
.Procedure
1717

18-
. Update the `NetNamespace` resource with the egress IP address using the
18+
. Update the `NetNamespace` object with the egress IP address using the
1919
following JSON:
2020
+
2121
[source,terminal]

modules/nw-egress-ips-static.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In {product-title} you can associate one or more egress IP addresses with a name
1414

1515
.Procedure
1616

17-
. Update the `NetNamespace` resource by specifying the following JSON
17+
. Update the `NetNamespace` object by specifying the following JSON
1818
object with the desired IP addresses:
1919
+
2020
[source,terminal]

modules/nw-enabling-multicast.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ To verify that multicast is enabled for a project, complete the following proced
4343
$ oc project <project>
4444
----
4545

46-
. Create a Pod to act as a multicast receiver:
46+
. Create a pod to act as a multicast receiver:
4747
+
4848
[source,terminal]
4949
----
@@ -68,7 +68,7 @@ spec:
6868
EOF
6969
----
7070

71-
. Create a Pod to act as a multicast sender:
71+
. Create a pod to act as a multicast sender:
7272
+
7373
[source,terminal]
7474
----
@@ -108,7 +108,7 @@ $ oc exec mlistener -i -t -- \
108108

109109
. Start the multicast transmitter.
110110

111-
.. Get the Pod network IP address range:
111+
.. Get the pod network IP address range:
112112
+
113113
[source,terminal]
114114
----

modules/nw-externalip-about.adoc

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@
55
[id="nw-externalip-about_{context}"]
66
= About ExternalIP
77

8-
For non-cloud environments, {product-title} supports the assignment of external IP addresses to a Service `spec.externalIPs` field through the *ExternalIP* facility.
9-
This exposes an additional virtual IP address, assigned to the Service, that can be outside the service network defined for the cluster.
10-
A Service configured with an external IP functions similarly to a Service with `type=NodePort`, allowing you to direct traffic to a local node for load balancing.
8+
For non-cloud environments, {product-title} supports the assignment of external IP addresses to a `Service` object `spec.externalIPs` field through the *ExternalIP* facility.
9+
This exposes an additional virtual IP address, assigned to the service, that can be outside the service network defined for the cluster.
10+
A service configured with an external IP functions similarly to a service with `type=NodePort`, allowing you to direct traffic to a local node for load balancing.
1111

1212
You must configure your networking infrastructure to ensure that the external IP address blocks that you define are routed to the cluster.
1313

1414
{product-title} extends the ExternalIP functionality in Kubernetes by adding the following capabilities:
1515

1616
- Restrictions on the use of external IP addresses through a configurable policy
17-
- Allocation of an external IP address automatically to a Service upon request
17+
- Allocation of an external IP address automatically to a service upon request
1818

19-
By default, only a user with `cluster-admin` privileges can create a Service with `spec.externalIPs[]` set to IP addresses defined within an external IP address block.
19+
By default, only a user with `cluster-admin` privileges can create a `Service` object with `spec.externalIPs[]` set to IP addresses defined within an external IP address block.
2020

2121
[WARNING]
2222
====
23-
Disabled by default, use of ExternalIP functionality can be a security risk, because in-cluster traffic to an external IP address is directed to that Service.
23+
Disabled by default, use of ExternalIP functionality can be a security risk, because in-cluster traffic to an external IP address is directed to that service.
2424
This could allow cluster users to intercept sensitive traffic destined for external resources.
2525
====
2626

@@ -33,19 +33,19 @@ For cloud deployments, use the load balancer services for automatic deployment o
3333
You can assign an external IP address in the following ways:
3434

3535
Automatic assignment of an external IP::
36-
{product-title} automatically assigns an IP address from the `autoAssignCIDRs` CIDR block to the `spec.externalIPs[]` array when you create a Service with `spec.type=LoadBalancer` set.
37-
In this case, {product-title} implements a non-cloud version of the load balancer Service type and assigns IP addresses to the services.
36+
{product-title} automatically assigns an IP address from the `autoAssignCIDRs` CIDR block to the `spec.externalIPs[]` array when you create a `Service` object with `spec.type=LoadBalancer` set.
37+
In this case, {product-title} implements a non-cloud version of the load balancer service type and assigns IP addresses to the services.
3838
Automatic assignment is disabled by default and must be configured by a cluster administrator as described in the following section.
3939

4040
Manual assignment of an external IP::
41-
{product-title} uses the IP addresses assigned to the `spec.externalIPs[]` array when you create a Service. You cannot specify an IP address that is already in use by another Service.
41+
{product-title} uses the IP addresses assigned to the `spec.externalIPs[]` array when you create a `Service` object. You cannot specify an IP address that is already in use by another service.
4242

4343
[id="configuration-externalip_{context}"]
4444
== Configuration for ExternalIP
4545

4646
Use of an external IP address in {product-title} is governed by the following fields in the `Network.config.openshift.io` CR named `cluster`:
4747

48-
* `spec.externalIP.autoAssignCIDRs` defines an IP address block used by the load balancer when choosing an external IP address for the service. {product-title} supports only a single IP address block for automatic assignment. This can be simpler than having to manage the port space of a limited number of shared IP addresses when manually assigning ExternalIPs to services. If automatic assignment is enabled, a Service with `spec.type=LoadBalancer` is allocated an external IP address.
48+
* `spec.externalIP.autoAssignCIDRs` defines an IP address block used by the load balancer when choosing an external IP address for the service. {product-title} supports only a single IP address block for automatic assignment. This can be simpler than having to manage the port space of a limited number of shared IP addresses when manually assigning ExternalIPs to services. If automatic assignment is enabled, a `Service` object with `spec.type=LoadBalancer` is allocated an external IP address.
4949
* `spec.externalIP.policy` defines the permissible IP address blocks when manually specifying an IP address. {product-title} does not apply policy rules to IP address blocks defined by `spec.externalIP.autoAssignCIDRs`.
5050

5151
If routed correctly, external traffic from the configured external IP address block can reach service endpoints through any TCP or UDP port that the service exposes.
@@ -65,9 +65,9 @@ of the ports exposed by other services.
6565
To use IP address blocks defined by `autoAssignCIDRs` in {product-title}, you must configure the necessary IP address assignment and routing for your host network.
6666
====
6767

68-
The following YAML describes a Service with an external IP configured:
68+
The following YAML describes a service with an external IP address configured:
6969

70-
.Example Service object with `spec.externalIPs[]` set
70+
.Example `Service` object with `spec.externalIPs[]` set
7171
[source,yaml]
7272
----
7373
apiVersion: v1
@@ -115,22 +115,22 @@ The policy object has the following shape:
115115

116116
When configuring policy restrictions, the following rules apply:
117117

118-
- If `policy={}` is set, then creating a Service with `spec.ExternalIPs[]` set will fail. This is the default for {product-title}.
119-
- If `policy=null` is set, then creating a Service with `spec.ExternalIPs[]` set to any IP address is allowed.
118+
- If `policy={}` is set, then creating a `Service` object with `spec.ExternalIPs[]` set will fail. This is the default for {product-title}.
119+
- If `policy=null` is set, then creating a `Service` object with `spec.ExternalIPs[]` set to any IP address is allowed.
120120
- If `policy` is set and either `policy.allowedCIDRs[]` or `policy.rejectedCIDRs[]` is set, the following rules apply:
121121

122122
* If `allowedCIDRs[]` and `rejectedCIDRs[]` are both set, then `rejectedCIDRs[]` has precedence over `allowedCIDRs[]`.
123-
* If `allowedCIDRs[]` is set, creating a Service with `spec.ExternalIPs[]` will succeed only if the specified IP addresses are allowed.
124-
* If `rejectedCIDRs[]` is set, creating a Service with `spec.ExternalIPs[]` will succeed only if the specified IP addresses are not rejected.
123+
* If `allowedCIDRs[]` is set, creating a `Service` object with `spec.ExternalIPs[]` will succeed only if the specified IP addresses are allowed.
124+
* If `rejectedCIDRs[]` is set, creating a `Service` object with `spec.ExternalIPs[]` will succeed only if the specified IP addresses are not rejected.
125125

126126
[id="example-policy-objects_{context}"]
127127
== Example policy objects
128128

129129
The examples that follow demonstrate several different policy configurations.
130130

131-
- In the following example, the policy prevents {product-title} from creating any Service with an external IP address specified:
131+
- In the following example, the policy prevents {product-title} from creating any service with an external IP address specified:
132132
+
133-
.Example policy to reject any value specified for Service `spec.externalIPs[]`
133+
.Example policy to reject any value specified for `Service` object `spec.externalIPs[]`
134134
[source,yaml]
135135
----
136136
apiVersion: config.openshift.io/v1
@@ -165,7 +165,7 @@ spec:
165165
- In the following example, `policy` is set to `null`.
166166
If set to `null`, when inspecting the configuration object by entering `oc get networks.config.openshift.io -o yaml`, the `policy` field will not appear in the output.
167167
+
168-
.Example policy to allow any value specified for Service `spec.externalIPs[]`
168+
.Example policy to allow any value specified for `Service` object `spec.externalIPs[]`
169169
[source,yaml]
170170
----
171171
apiVersion: config.openshift.io/v1

modules/nw-externalip-configuring.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77

88
As a cluster administrator, you can configure the following ExternalIP settings:
99

10-
- An ExternalIP address block used by {product-title} to automatically populate the `spec.clusterIP` field for a Service.
11-
- A policy object to restrict what IP addresses may be manually assigned to the `spec.clusterIP` array of a Service.
10+
- An ExternalIP address block used by {product-title} to automatically populate the `spec.clusterIP` field for a `Service` object.
11+
- A policy object to restrict what IP addresses may be manually assigned to the `spec.clusterIP` array of a `Service` object.
1212

1313
.Prerequisites
1414

0 commit comments

Comments
 (0)