This documentation is for a release that is no longer maintained
See documentation for the latest supported version 3 or the latest supported version 4.Este conteúdo não está disponível no idioma selecionado.
Chapter 22. Configuring for VMware vSphere
You can configure OpenShift Container Platform to access VMware vSphere VMDK Volumes. This includes using VMware vSphere VMDK Volumes as persistent storage for application data.
The vSphere Cloud Provider allows using vSphere managed storage within OpenShift Container Platform and supports:
- Volumes
- Persistent volumes
- Storage classes and provisioning volumes
22.1. Before you begin Copiar o linkLink copiado para a área de transferência!
22.1.1. VMware vSphere cloud provider prerequisites Copiar o linkLink copiado para a área de transferência!
Prerequisites
Enabling VMware vSphere requires installing the VMware Tools on each Node VM. See Installing VMware tools for more information.
Procedure
- Create a VM folder and move OpenShift Container Platform Node VMs to this folder.
Verify that the Node VM names complies with the regex
[a-z](()?[0-9a-z])?(\.[a-z0-9](([-0-9a-z])?[0-9a-z])?)*
.ImportantVM Names cannot:
- Begin with numbers.
- Have any capital letters.
-
Have any special characters except
-
. - Be shorter than three characters and longer than 63 characters.
Set the
disk.EnableUUID
parameter totrue
for each Node VM. This ensures that the VMware vSphere’s Virtual Machine Disk (VMDK) always presents a consistent UUID to the VM, allowing the disk to be mounted properly.For every vSphere virtual machine node that will be participating in the cluster, follow the steps below using the vSphere console:
Navigate to VM properties
VM Options Advanced Configuration Parameters disk.enableUUID=TRUE Set up the GOVC environment:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Find the Node VM paths:
govc ls /datacenter/vm/<vm-folder-name>
govc ls /datacenter/vm/<vm-folder-name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Set
disk.EnableUUID
totrue
for all VMs:govc vm.change -e="disk.enableUUID=1" -vm='VM Path'
govc vm.change -e="disk.enableUUID=1" -vm='VM Path'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
If OpenShift Container Platform node VMs are created from a template VM, then disk.EnableUUID=1
can be set on the template VM. VMs cloned from this template inherit this property.
Create and assign roles to the vSphere Cloud Provider user and vSphere entities. vSphere Cloud Provider requires the following privileges to interact with vCenter.
Expand Roles Privileges Entities Propagate to Children manage-k8s-node-vms
Resource.AssignVMToPool System.Anonymous System.Read System.View VirtualMachine.Config.AddExistingDisk VirtualMachine.Config.AddNewDisk VirtualMachine.Config.AddRemoveDevice VirtualMachine.Config.RemoveDisk VirtualMachine.Inventory.Create VirtualMachine.Inventory.Delete
Cluster, Hosts, VM Folder
Yes
manage-k8s-volumes
Datastore.AllocateSpace Datastore.FileManagement System.Anonymous System.Read System.View
Datastore
No
k8s-system-read-and-spbm-profile-view
StorageProfile.View System.Anonymous System.Read System.View
vCenter
No
ReadOnly
System.Anonymous System.Read System.View
Datacenter, Datastore Cluster, Datastore Storage Folder
No
See the vSphere Documentation Center for steps to create a custom role, user, and role assignment.
22.2. Configuring OpenShift Container Platform for vSphere Copiar o linkLink copiado para a área de transferência!
You can configure OpenShift Container Platform for vSphere in two ways:
22.2.1. Option 1: Configuring OpenShift Container Platform for vSphere using Ansible Copiar o linkLink copiado para a área de transferência!
You can configure OpenShift Container Platform for VMware vSphere (VCP) by modifying the Ansible inventory file. These changes can be made before installation, or to an existing cluster.
Procedure
Add the following to the Ansible inventory file:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Run the
deploy_cluster.yml
playbook.ansible-playbook -i <inventory_file> \ playbooks/deploy_cluster.yml
$ ansible-playbook -i <inventory_file> \ playbooks/deploy_cluster.yml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Installing with Ansible also creates and configures the following files to fit your vSphere environment:
- /etc/origin/cloudprovider/vsphere.conf
- /etc/origin/master/master-config.yaml
- /etc/origin/node/node-config.yaml
As a reference, a full inventory is shown as follows:
The openshift_cloudprovider_vsphere_
values are required for OpenShift Container Platform to be able to create vSphere
resources such as VMDKs on datastores for persistent volumes.
Deploying a vSphere VM environment is not officially supported by Red Hat, but it can be configured.
22.2.2. Option 2: Manually configuring OpenShift Container Platform for vSphere Copiar o linkLink copiado para a área de transferência!
22.2.2.1. Manually configuring master hosts for vSphere Copiar o linkLink copiado para a área de transferência!
Perform the following on all master hosts.
Procedure
Edit the master configuration file at /etc/origin/master/master-config.yaml by default on all masters and update the contents of the
apiServerArguments
andcontrollerArguments
sections:Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantWhen triggering a containerized installation, only the /etc/origin and /var/lib/origin directories are mounted to the master and node container. Therefore, master-config.yaml must be in /etc/origin/master rather than /etc/.
When you configure OpenShift Container Platform for vSphere using Ansible, the /etc/origin/cloudprovider/vsphere.conf file is created automatically. Because you are manually configuring OpenShift Container Platform for vSphere, you must create the file. Before you create the file, decide if you want multiple vCenter zones or not.
The cluster installation process configures single-zone or single vCenter by default. However, deploying OpenShift Container Platform in vSphere on different zones can be helpful to avoid single-point-of-failures, but creates the need for shared storage across zones. If an OpenShift Container Platform node host goes down in zone "A" and the pods should be moved to zone "B". See Multiple zone limitations in the Kubernetes documentation for more information.
To configure a single vCenter server, use the following format for the /etc/origin/cloudprovider/vsphere.conf file:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- Any properties set in the
[Global]
section are used for all specified vcenters unless overriden by the settings in the individual[VirtualCenter]
sections. - 2
- vCenter username for the vSphere cloud provider.
- 3
- vCenter password for the specified user.
- 4
- Optional. Port number for the vCenter server. Defaults to port
443
. - 5
- Set to
1
if the vCenter uses a self-signed certificate. - 6
- Name of the data center on which Node VMs are deployed.
- 7
- Override specific
[Global]
properties for this Virtual Center. Possible setting scan be[Port]
,[user]
,[insecure-flag]
,[datacenters]
. Any settings not specified are pulled from the[Global]
section. - 8
- Set any properties used for various vSphere Cloud Provider functionality. For example, dynamic provisioning, Storage Profile Based Volume provisioning, and others.
- 9
- IP Address or FQDN for the vCenter server.
- 10
- Path to the VM directory for node VMs.
- 11
- Set to the name of the datastore to use for provisioning volumes using the storage classes or dynamic provisioning. Prior to OpenShift Container Platform 3.9, if the datastore was located in a storage directory or is a member of a datastore cluster, the full path was required.
- 12
- Optional. Set to the path to the resource pool where dummy VMs for Storage Profile Based volume provisioning must be created.
- 13
- Type of SCSI controller the VMDK will be attached to the VM as.
- 14
- Set to the network port group for vSphere to access the node, which is called VM Network by default. This is the node host’s ExternalIP that is registered with Kubernetes.
To configure a multiple vCenter servers, use the following format for the /etc/origin/cloudprovider/vsphere.conf file:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- Any properties set in the
[Global]
section are used for all specified vcenters unless overriden by the settings in the individual[VirtualCenter]
sections. - 2
- vCenter username for the vSphere cloud provider.
- 3
- vCenter password for the specified user.
- 4
- Optional. Port number for the vCenter server. Defaults to port
443
. - 5
- Set to
1
if the vCenter uses a self-signed certificate. - 6
- Name of the data centers on which Node VMs are deployed.
- 7
- Override specific
[Global]
properties for this Virtual Center. Possible setting scan be[Port]
,[user]
,[insecure-flag]
,[datacenters]
. Any settings not specified are pulled from the[Global]
section. - 8
- Set any properties used for various vSphere Cloud Provider functionality. For example, dynamic provisioning, Storage Profile Based Volume provisioning, and others.
- 9
- IP Address or FQDN for the vCenter server where the Cloud Provider communicates.
- 10
- Path to the VM directory for node VMs.
- 11
- Set to the name of the datastore to use for provisioning volumes using the storage classes or dynamic provisioning. Prior to OpenShift Container Platform 3.9, if the datastore was located in a storage directory or is a member of a datastore cluster, the full path was required.
- 12
- Optional. Set to the path to the resource pool where dummy VMs for Storage Profile Based volume provisioning must be created.
- 13
- Type of SCSI controller the VMDK will be attached to the VM as.
- 14
- Set to the network port group for vSphere to access the node, which is called VM Network by default. This is the node host’s ExternalIP that is registered with Kubernetes.
ImportantThis ensures that the VMDK always presents a consistent UUID to the VM, allowing the disk to be mounted properly.
For every virtual machine node that will be participating in the cluster: VM properties
VM Options Advanced Configuration Parameters disk.enableUUID=TRUE Alternatively, the GOVC tool can be used:
Set up the GOVC environment:
export GOVC_URL='vCenter IP OR FQDN' export GOVC_USERNAME='vCenter User' export GOVC_PASSWORD='vCenter Password' export GOVC_INSECURE=1
export GOVC_URL='vCenter IP OR FQDN' export GOVC_USERNAME='vCenter User' export GOVC_PASSWORD='vCenter Password' export GOVC_INSECURE=1
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Find the Node VM paths:
govc ls /datacenter/vm/<vm-folder-name>
govc ls /datacenter/vm/<vm-folder-name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Set disk.EnableUUID to true for all VMs:
govc vm.change -e="disk.enableUUID=1" -vm='VM Path'
govc vm.change -e="disk.enableUUID=1" -vm='VM Path'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf OpenShift Container Platform node VMs are created from a template VM, then
disk.EnableUUID=1
can be set on the template VM. VMs cloned from this template inherit this property.
Restart the OpenShift Container Platform host services:
master-restart api master-restart controllers systemctl restart atomic-openshift-node
# master-restart api # master-restart controllers # systemctl restart atomic-openshift-node
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
22.2.2.2. Manually configuring node hosts for vSphere Copiar o linkLink copiado para a área de transferência!
Perform the following on all node hosts.
Procedure
To configure the OpenShift Container Platform nodes for vSphere:
Edit the appropriate node configuration map and update the contents of the
kubeletArguments
section:kubeletArguments: cloud-provider: - "vsphere" cloud-config: - "/etc/origin/cloudprovider/vsphere.conf"
kubeletArguments: cloud-provider: - "vsphere" cloud-config: - "/etc/origin/cloudprovider/vsphere.conf"
Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantThe
nodeName
must match the VM name in vSphere in order for the cloud provider integration to work properly. The name must also be RFC1123 compliant.Restart the OpenShift Container Platform services on all nodes.
systemctl restart atomic-openshift-node
# systemctl restart atomic-openshift-node
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
22.2.2.3. Applying Configuration Changes Copiar o linkLink copiado para a área de transferência!
Start or restart OpenShift Container Platform services on all master and node hosts to apply your configuration changes, see Restarting OpenShift Container Platform services:
master-restart api master-restart controllers systemctl restart atomic-openshift-node
# master-restart api
# master-restart controllers
# systemctl restart atomic-openshift-node
Switching from not using a cloud provider to using a cloud provider produces an error message. Adding the cloud provider tries to delete the node because the node switches from using the hostname as the externalID
(which would have been the case when no cloud provider was being used) to using the cloud provider’s instance-id
(which is what the cloud provider specifies). To resolve this issue:
- Log in to the CLI as a cluster administrator.
Check and back up existing node labels:
oc describe node <node_name> | grep -Poz '(?s)Labels.*\n.*(?=Taints)'
$ oc describe node <node_name> | grep -Poz '(?s)Labels.*\n.*(?=Taints)'
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the nodes:
oc delete node <node_name>
$ oc delete node <node_name>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow On each node host, restart the OpenShift Container Platform service.
systemctl restart atomic-openshift-node
# systemctl restart atomic-openshift-node
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - Add back any labels on each node that you previously had.
22.2.3. Configuring OpenShift Container Platform to use vSphere storage Copiar o linkLink copiado para a área de transferência!
OpenShift Container Platform supports VMware vSphere’s Virtual Machine Disk (VMDK) volumes. You can provision your OpenShift Container Platform cluster with persistent storage using VMware vSphere. Some familiarity with Kubernetes and VMware vSphere is assumed.
OpenShift Container Platform creates the disk in vSphere and attaches the disk to the proper instance.
The OpenShift Container Platform persistent volume (PV) framework allows administrators to provision a cluster with persistent storage and gives users a way to request those resources without having any knowledge of the underlying infrastructure. vSphere VMDK volumes can be provisioned dynamically.
PVs are not bound to a single project or namespace; they can be shared across the OpenShift Container Platform cluster. PV claims, however, are specific to a project or namespace and can be requested by users.
High availability of storage in the infrastructure is left to the underlying storage provider.
Prerequisites
Before creating PVs using vSphere, ensure your OpenShift Container Platform cluster meets the following requirements:
- OpenShift Container Platform must first be configured for vSphere Cloud Provider
- Each node host in the infrastructure must match the vSphere VM name.
- Each node host must be in the same resource group.
22.2.3.1. Provisioning VMware vSphere volumes Copiar o linkLink copiado para a área de transferência!
Storage must exist in the underlying infrastructure before it can be mounted as a volume in OpenShift Container Platform. After ensuring OpenShift Container Platform is configured for vSphere, all that is required for OpenShift Container Platform and vSphere is a VM folder path, file system type, and the PersistentVolume
API.
22.2.3.1.1. Creating persistent volumes Copiar o linkLink copiado para a área de transferência!
Define a PV object definition, for example vsphere-pv.yaml:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- The name of the volume. This must be how it is identified by PV claims or from pods.
- 2
- The amount of storage allocated to this volume.
- 3
- The volume type being used. This example uses
vsphereVolume
, and the label is used to mount a vSphere VMDK volume into pods. The contents of a volume are preserved when it is unmounted. The volume type supports VMFS and VSAN datastore. - 4
- This VMDK volume must exist, and you must include brackets ([]) in the volume definition.
- 5
- The file system type to mount. For example,
ext4
,xfs
, or other file-systems.
ImportantChanging the value of the
fsType
parameter after the volume is formatted and provisioned can result in data loss and pod failure.Create the PV:
oc create -f vsphere-pv.yaml
$ oc create -f vsphere-pv.yaml persistentvolume "pv0001" created
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verify that the PV was created:
oc get pv
$ oc get pv NAME LABELS CAPACITY ACCESSMODES STATUS CLAIM REASON AGE pv0001 <none> 2Gi RWO Available 2s
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Now you can request storage using PV claims, which can now use your PV.
PV claims only exist in the user’s namespace and can only be referenced by a pod within that same namespace. Any attempt to access a PV from a different namespace causes the pod to fail.
22.2.3.1.2. Formatting VMware vSphere volumes Copiar o linkLink copiado para a área de transferência!
Before OpenShift Container Platform mounts the volume and passes it to a container, it checks that the volume contains a file system as specified by the fsType
parameter in the PV definition. If the device is not formatted with the file system, all data from the device is erased, and the device is automatically formatted with the given file system.
This allows unformatted vSphere volumes to be used as PVs, because OpenShift Container Platform formats them before the first use.
22.2.3.2. Provisioning VMware vSphere volumes via a Storage Class Copiar o linkLink copiado para a área de transferência!
OpenShift Container Platform creates the following
storageclass
when you use thevsphere-volume
provisioner and if you use theopenshift_cloudprovider_kind=vsphere
andopenshift_vsphere_*
variables in the Ansible inventory. Otherwise, you can create it manually:Copy to Clipboard Copied! Toggle word wrap Toggle overflow After you request a PV and using the storageclass shown in the previous step, OpenShift Container Platform creates VMDK disks in the vSphere infrastructure. To verify that the disks were created:
ls /vmfs/volumes/ose3-vmware/kubevols | grep kubernetes
$ ls /vmfs/volumes/ose3-vmware/kubevols | grep kubernetes kubernetes-dynamic-pvc-790615e8-a22a-11e8-bc85-0050568e2982.vmdk
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
vSphere-volume disks are ReadWriteOnce
access mode, which means the volume can be mounted as read-write by a single node. See the Access modes section of the Architecture guide for more information.
22.2.4. About Red Hat OpenShift Container Storage Copiar o linkLink copiado para a área de transferência!
Red Hat OpenShift Container Storage (RHOCS) is a provider of agnostic persistent storage for OpenShift Container Platform either in-house or in hybrid clouds. As a Red Hat storage solution, RHOCS is completely integrated with OpenShift Container Platform for deployment, management, and monitoring regardless if it is installed on OpenShift Container Platform (converged) or with OpenShift Container Platform (independent). OpenShift Container Storage is not limited to a single availability zone or node, which makes it likely to survive an outage. You can find complete instructions for using RHOCS in the RHOCS 3.10 Deployment Guide.
22.2.5. Configuring the OpenShift Container Platform registry for vSphere Copiar o linkLink copiado para a área de transferência!
The following steps define the manual process of storage creation, which is used to create storage for the registry if a storage class is unavailable or not used.
22.2.5.1. Configuring the OpenShift Container Platform registry for vSphere using Ansible Copiar o linkLink copiado para a área de transferência!
Procedure
To configure the Ansible inventory for the registry to use a vSphere volume:
The brackets in the configuration file above are required.
22.2.5.2. Manually configuring OpenShift Container Platform registry for vSphere Copiar o linkLink copiado para a área de transferência!
To use vSphere volume storage, edit the registry’s configuration file and mount to the registry pod.
Procedure
Create a new configuration file from the vSphere volume:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the file in OpenShift Container Platform:
oc create -f pvc-registry.yaml
$ oc create -f pvc-registry.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Update the volume configuration to use the new PVC:
oc volume dc docker-registry --add --name=registry-storage -t \ pvc --claim-name=vsphere-registry-storage --overwrite
$ oc volume dc docker-registry --add --name=registry-storage -t \ pvc --claim-name=vsphere-registry-storage --overwrite
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Redeploy the registry to read the updated configuration:
oc rollout latest docker-registry -n default
$ oc rollout latest docker-registry -n default
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verify the volume has been assigned:
oc volume dc docker-registry -n default
$ oc volume dc docker-registry -n default
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
22.3. Backup of persistent volumes Copiar o linkLink copiado para a área de transferência!
OpenShift Container Platform provisions new volumes as independent persistent disks to freely attach and detach the volume on any node in the cluster. As a consequence, it is not possible to back up volumes that use snapshots.
To create a backup of PVs:
- Stop the application using the PV.
- Clone the persistent disk.
- Restart the application.
- Create a backup of the cloned disk.
- Delete the cloned disk.