Skip to content

Commit

Permalink
Improvements to language and phrasing
Browse files Browse the repository at this point in the history
  • Loading branch information
HappyTetrahedron committed Dec 1, 2023
1 parent 5d72300 commit 446bf94
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 9 additions & 10 deletions docs/modules/ROOT/pages/references/vsphere/architecture.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
The APPUiO Managed OpenShift 4 architecture on VMWare vSphere is based on the xref:references/architecture/index.adoc[generic APPUiO Managed OpenShift 4 architecture].
We expect that readers of this document are familiar with the xref:references/architecture/index.adoc[generic APPUiO Managed OpenShift 4 architecture] and the overall Kubernetes and OpenShift 4 architecture.

The APPUiO Managed OpenShift 4 VMWare vSphere architecture extends the generic architecture by defining how the APPUiO Managed OpenShift 4 cluster is embedded into the VMWare vSphere environment.
This architecture document extends upon the generic architecture by defining how the APPUiO Managed OpenShift 4 cluster is embedded into the VMWare vSphere environment.
The diagram below shows a detailed view of how an APPUiO Managed OpenShift 4 cluster is embedded into an existing VMWare vSphere environment.

.APPUiO Managed OpenShift4 on vSphere architecture
Expand All @@ -15,9 +15,8 @@ The following sections of this document provide detailed descriptions for the el

== vSphere requirements

Red Hat OpenShift 4 requires VMWare virtual hardware version `15` or later.
Additionally, Red Hat OpenShift 4 requires vSphere ESXi and vCenter to be at version `7.0 Update 2` or later.
See the https://docs.openshift.com/container-platform/latest/installing/installing_vsphere/installing-vsphere-installer-provisioned.html#installation-vsphere-infrastructure_installing-vsphere-installer-provisioned[upstream documentation] for further details on required VMWare vSphere requirements.
Red Hat OpenShift 4 imposes version requirements on the VMWare virtual hardware version, vSphere ESXi and vCenter.
See the https://docs.openshift.com/container-platform/latest/installing/installing_vsphere/installing-vsphere-installer-provisioned.html#installation-vsphere-infrastructure_installing-vsphere-installer-provisioned[upstream documentation] for the specific version requirements as well as further details on required VMWare vSphere requirements.

APPUiO Managed OpenShift 4 needs credentials to access the vSphere API for three main reasons:

Expand Down Expand Up @@ -45,7 +44,7 @@ The bastion host:
* must run a recent Ubuntu version

The bastion host is used to run the installer from, and for troubleshooting access to both the cluster and the vCenter.
The bastion host must be provided by the vSphere infrastructure operator, but VSHN can take over management and maintenance.
The bastion host must be provided by the vSphere infrastructure operator, but VSHN can handle management and maintenance.

=== Machine network

Expand All @@ -55,7 +54,7 @@ DHCP is mandatory for this network, but a number of IPs must be reserved to be u

Traffic inside this network shouldn't be restricted.

VMs in this network must be able to reach various services in the internet.
VMs in this network must be able to reach various services on the internet.
See below for a detailed list of external systems that must be reachable.

=== Virtual IPs
Expand All @@ -69,19 +68,19 @@ APPUiO Managed OpenShift 4 uses `.11` in the machine network as the Ingress VIP.

APPUiO Managed OpenShift 4 runs two `keepalived` instances to manage the API and ingress VIPs through VRRP.

If applications should be oexposes for non-HTTP(S) traffic (via `LoadBalancer` services), additional IPs in the machine network must be reserved to be used as VIPs.
If applications should be exposed for non-HTTP(S) traffic (via `LoadBalancer` services), additional IPs in the machine network must be reserved to be used as VIPs.
These additional VIPs will be managed by `keepalived` instances on the cluster.

=== Pod and service networks

APPUiO Managed Openshift 4 uses [Cilium] to provide in-cluster networking.
APPUiO Managed Openshift 4 uses https://cilium.io/[Cilium] to provide in-cluster networking.
Cilium allocates two cluster-internal networks:

1. The pod network: every pod on the cluster will get an IP address from this network.
This network enables basic in-cluster connectivity.
APPUiO Managed OpenShift 4 uses `10.128.0.0/14` as the pod network.
Each node in the cluster is assigned a `/23` from this range.
Pods on a node are always assigned an IP from the range allocated for the node.
Pods on a node are always assigned an IP from the range allocated to that node.
2. Service network: used for service discovery.
Traffic to IPs in this network is forwarded to the appropriate pods by Cilium.
APPUiO Managed OpenShift 4 uses `172.30.0.0/16` as the service network.
Expand Down Expand Up @@ -236,7 +235,7 @@ Entries for "VMWare vSphere CSI Driver Operator" are required.
|Cluster machine network (sometimes "cluster network" or "machine network")
a|An internal subnet, usually a `/24`, in which the OpenShift 4 cluster will be placed.

The terms "cluster machine network", "cluster network" and "machine network" are used interchangeably.
The terms "cluster machine network," "cluster network" and "machine network" are used interchangeably.
Only one network is required.

VMs in this network must be assigned an IP address via DHCP.
Expand Down

0 comments on commit 446bf94

Please sign in to comment.