Skip to content

Commit 465fef2

Browse files
bergerhofferbergerhoffer
authored
Merge pull request #52972 from xenolinux/networking-common-terms
OSDOCS#4551: Add the common terms for networking book
2 parents 06c0396 + 21f0469 commit 465fef2

File tree

2 files changed

+119
-0
lines changed

2 files changed

+119
-0
lines changed

‎modules/nw-networking-glossary-terms.adoc

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * networking/understanding-networking.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="nw-networking-glossary-terms_{context}"]
7+
= Common networking terms
8+
9+
This glossary defines common terms that are used in the networking content.
10+
11+
authentication::
12+
To control access to an {product-title} cluster, a cluster administrator can configure user authentication and ensure only approved users access the cluster. To interact with an {product-title} cluster, you must authenticate to the {product-title} API. You can authenticate by providing an OAuth access token or an X.509 client certificate in your requests to the {product-title} API.
13+
14+
AWS Load Balancer Operator::
15+
The AWS Load Balancer (ALB) Operator deploys and manages an instance of the `aws-load-balancer-controller`.
16+
17+
Cluster Network Operator::
18+
The Cluster Network Operator (CNO) deploys and manages the cluster network components in an {product-title} cluster. This includes deployment of the Container Network Interface (CNI) default network provider plug-in selected for the cluster during installation.
19+
20+
config map::
21+
A config map provides a way to inject configuration data into pods. You can reference the data stored in a config map in a volume of type `ConfigMap`. Applications running in a pod can use this data.
22+
23+
custom resource (CR)::
24+
A CR is extension of the Kubernetes API. You can create custom resources.
25+
26+
DNS::
27+
Cluster DNS is a DNS server which serves DNS records for Kubernetes services. Containers started by Kubernetes automatically include this DNS server in their DNS searches.
28+
29+
DNS Operator::
30+
The DNS Operator deploys and manages CoreDNS to provide a name resolution service to pods. This enables DNS-based Kubernetes Service discovery in {product-title}.
31+
32+
deployment::
33+
A Kubernetes resource object that maintains the life cycle of an application.
34+
35+
domain::
36+
Domain is a DNS name serviced by the Ingress Controller.
37+
38+
egress::
39+
The process of data sharing externally through a network’s outbound traffic from a pod.
40+
41+
External DNS Operator::
42+
The External DNS Operator deploys and manages ExternalDNS to provide the name resolution for services and routes from the external DNS provider to {product-title}.
43+
44+
HTTP-based route::
45+
An HTTP-based route is an unsecured route that uses the basic HTTP routing protocol and exposes a service on an unsecured application port.
46+
47+
Ingress::
48+
The Kubernetes Ingress resource in {product-title} implements the Ingress Controller with a shared router service that runs as a pod inside the cluster.
49+
50+
Ingress Controller::
51+
The Ingress Operator manages Ingress Controllers. Using an Ingress Controller is the most common way to allow external access to an {product-title} cluster.
52+
53+
installer-provisioned infrastructure::
54+
The installation program deploys and configures the infrastructure that the cluster runs on.
55+
56+
kubelet::
57+
A primary node agent that runs on each node in the cluster to ensure that containers are running in a pod.
58+
59+
Kubernetes NMState Operator::
60+
The Kubernetes NMState Operator provides a Kubernetes API for performing state-driven network configuration across the {product-title} cluster’s nodes with NMState.
61+
62+
kube-proxy::
63+
Kube-proxy is a proxy service which runs on each node and helps in making services available to the external host. It helps in forwarding the request to correct containers and is capable of performing primitive load balancing.
64+
65+
load balancers::
66+
{product-title} uses load balancers for communicating from outside the cluster with services running in the cluster.
67+
68+
MetalLB Operator::
69+
As a cluster administrator, you can add the MetalLB Operator to your cluster so that when a service of type `LoadBalancer` is added to the cluster, MetalLB can add an external IP address for the service.
70+
71+
multicast::
72+
With IP multicast, data is broadcast to many IP addresses simultaneously.
73+
74+
namespaces::
75+
A namespace isolates specific system resources that are visible to all processes. Inside a namespace, only processes that are members of that namespace can see those resources.
76+
77+
networking::
78+
Network information of a {product-title} cluster.
79+
80+
node::
81+
A worker machine in the {product-title} cluster. A node is either a virtual machine (VM) or a physical machine.
82+
83+
{product-title} Ingress Operator::
84+
The Ingress Operator implements the `IngressController` API and is the component responsible for enabling external access to {product-title} services.
85+
86+
pod::
87+
One or more containers with shared resources, such as volume and IP addresses, running in your {product-title} cluster.
88+
A pod is the smallest compute unit defined, deployed, and managed.
89+
90+
PTP Operator::
91+
The PTP Operator creates and manages the `linuxptp` services.
92+
93+
route::
94+
The {product-title} route provides Ingress traffic to services in the cluster. Routes provide advanced features that might not be supported by standard Kubernetes Ingress Controllers, such as TLS re-encryption, TLS passthrough, and split traffic for blue-green deployments.
95+
96+
scaling::
97+
Increasing or decreasing the resource capacity.
98+
99+
service::
100+
Exposes a running application on a set of pods.
101+
102+
Single Root I/O Virtualization (SR-IOV) Network Operator::
103+
The Single Root I/O Virtualization (SR-IOV) Network Operator manages the SR-IOV network devices and network attachments in your cluster.
104+
105+
software-defined networking (SDN)::
106+
{product-title} uses a software-defined networking (SDN) approach to provide a unified cluster network that enables communication between pods across the {product-title} cluster.
107+
108+
Stream Control Transmission Protocol (SCTP)::
109+
SCTP is a reliable message based protocol that runs on top of an IP network.
110+
111+
taint::
112+
Taints and tolerations ensure that pods are scheduled onto appropriate nodes. You can apply one or more taints on a node.
113+
114+
toleration::
115+
You can apply tolerations to pods. Tolerations allow the scheduler to schedule pods with matching taints.
116+
117+
web console::
118+
A user interface (UI) to manage {product-title}.

‎networking/understanding-networking.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ If you allow a pod host network access, you grant the pod privileged access to t
2525
include::modules/nw-ne-openshift-dns.adoc[leveloffset=+1]
2626
include::modules/nw-ne-openshift-ingress.adoc[leveloffset=+1]
2727
include::modules/nw-ne-comparing-ingress-route.adoc[leveloffset=+2]
28+
include::modules/nw-networking-glossary-terms.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)