Skip to content

Commit 8291ca4

Browse files
author
Talia Shwartzberg
committed
TELCODOCS-1184: Configuring vSphere Connection Details
1 parent 35a579d commit 8291ca4

File tree

5 files changed

+137
-0
lines changed

5 files changed

+137
-0
lines changed

‎_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -476,6 +476,8 @@ Topics:
476476
File: installing-restricted-networks-vsphere
477477
- Name: Installing a three-node cluster on vSphere
478478
File: installing-vsphere-three-node
479+
- Name: Configuring the vSphere connection settings after an installation
480+
File: installing-vsphere-post-installation-configuration
479481
- Name: Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure
480482
File: uninstalling-cluster-vsphere-installer-provisioned
481483
- Name: Using the vSphere Problem Detector Operator

‎installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:_content-type: ASSEMBLY
2+
[id="installing-vsphere-post-installation-configuration"]
3+
= Configuring the vSphere connection settings after an installation
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-vsphere-post-installation-configuration
6+
7+
8+
After installing an {product-title} cluster on vSphere with the platform integration feature enabled, you might need to update the vSphere connection settings manually, depending on the installation method.
9+
10+
For installations using the Assisted Installer, you must update the connection settings. This is because the Assisted Installer adds default connection settings to the *vSphere connection configuration* wizard as placeholders during the installation.
11+
12+
For installer-provisioned or user-provisioned infrastructure installations, you should have entered valid connection settings during the installation. You can use the *vSphere connection configuration* wizard at any time to validate or modify the connection settings, but this is not mandatory for completing the installation.
13+
14+
toc::[]
15+
16+
include::modules/configuring-vsphere-connection-settings.adoc[leveloffset=+1]
17+
18+
include::modules/configuring-vsphere-verifying-configuration.adoc[leveloffset=+1]
19+
20+
For instructions on creating storage objects, see xref:../../storage/dynamic-provisioning.adoc#dynamic-provisioning[Dynamic provisioning].

‎installing/installing_vsphere/preparing-to-install-on-vsphere.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,10 @@ include::modules/vmware-csi-driver-reqs.adoc[leveloffset=+1]
6666

6767
* To remove a third-party vSphere CSI driver, see xref:../../storage/container_storage_interface/persistent-storage-csi-vsphere.adoc#persistent-storage-csi-vsphere-install-issues_persistent-storage-csi-vsphere[Removing a third-party vSphere CSI Driver].
6868

69+
== Configuring the vSphere connection settings
70+
71+
* **xref:../../installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc#installing-vsphere-post-installation-configuration[Updating the vSphere connection settings following an installation]**: For installations on vSphere using the Assisted Installer, you must manually update the vSphere connection settings to complete the installation. For installer-provisioned or user-provisioned infrastructure installations on vSphere, you can optionally validate or modify the vSphere connection settings at any time.
72+
6973
== Uninstalling an installer-provisioned infrastructure installation of {product-title} on vSphere
7074

7175
* **xref:../../installing/installing_vsphere/uninstalling-cluster-vsphere-installer-provisioned.adoc#uninstalling-cluster-vsphere-installer-provisioned[Uninstalling a cluster on vSphere that uses installer-provisioned infrastructure]**: You can remove a cluster that you deployed on VMware vSphere infrastructure that used installer-provisioned infrastructure.

‎modules/configuring-vsphere-connection-settings.adoc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="configuring-vSphere-connection-settings_{context}"]
7+
= Configuring the vSphere connection settings
8+
9+
[role="_abstract"]
10+
Modify the following vSphere configuration settings as required:
11+
12+
* vCenter address
13+
* vCenter username
14+
* vCenter password
15+
* vCenter address
16+
* vSphere data center
17+
* vSphere datastore
18+
* Virtual machine folder
19+
20+
.Prerequisites
21+
* The {ai-full} has finished installing the cluster successfully.
22+
* The cluster is connected to `https://console.redhat.com`.
23+
24+
.Procedure
25+
. In the Administrator perspective, navigate to *Home -> Overview*.
26+
. Under *Status*, click *vSphere connection* to open the *vSphere connection configuration* wizard.
27+
. In the *vCenter* field, enter the network address of the vSphere vCenter server. This can be either a domain name or an IP address. It appears in the vSphere web client URL; for example `https://[your_vCenter_address]/ui`.
28+
. In the *Username* field, enter your vSphere vCenter username.
29+
. In the *Password* field, enter your vSphere vCenter password.
30+
+
31+
[WARNING]
32+
====
33+
The system stores the username and password in the `vsphere-creds` secret in the `kube-system` namespace of the cluster. An incorrect vCenter username or password makes the cluster nodes unschedulable.
34+
====
35+
+
36+
. In the *Datacenter* field, enter the name of the vSphere data center that contains the virtual machines used to host the cluster; for example, `SDDC-Datacenter`.
37+
. In the *Default data store* field, enter the path and name of the vSphere data store that stores the persistent data volumes; for example, `/SDDC-Datacenter/datastore/datastorename`.
38+
+
39+
[WARNING]
40+
====
41+
Updating the vSphere data center or default data store after the configuration has been saved detaches any active vSphere `PersistentVolumes`.
42+
====
43+
+
44+
. In the *Virtual Machine Folder* field, enter the data center folder that contains the virtual machine of the cluster; for example, `/SDDC-Datacenter/vm/ci-ln-hjg4vg2-c61657-t2gzr`. For the {product-title} installation to succeed, all virtual machines comprising the cluster must be located in a single data center folder.
45+
. Click *Save Configuration*. This updates the `cloud-provider-config` ConfigMap resource in the `openshift-config` namespace, and starts the configuration process.
46+
. Reopen the *vSphere connection configuration* wizard and expand the *Monitored operators* panel. Check that the status of the operators is either *Progressing* or *Healthy*.

‎modules/configuring-vsphere-verifying-configuration.adoc

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * installing/installing_vsphere/installing-vsphere-post-installation-configuration.adoc
4+
5+
:_content-type: PROCEDURE
6+
[id="configuring-vSphere-monitoring-configuration-completion{context}"]
7+
= Verifying the configuration
8+
9+
The connection configuration process updates operator statuses and control plane nodes. It takes approximately an hour to complete. During the configuration process, the nodes will reboot. Previously bound `PersistentVolumeClaims` objects might become disconnected.
10+
11+
.Prerequisites
12+
* You have saved the configuration settings in the *vSphere connection configuration* wizard.
13+
14+
.Procedure
15+
16+
. Check that the configuration process completed successfully:
17+
+
18+
--
19+
.. In the OpenShift Container Platform Administrator perspective, navigate to *Home -> Overview*.
20+
.. Under *Status* click *Operators*. Wait for all operator statuses to change from *Progressing* to *All succeeded*. A *Failed* status indicates that the configuration failed.
21+
.. Under *Status*, click *Control Plane*. Wait for the response rate of all Control Pane components to return to 100%. A *Failed* control plane component indicates that the configuration failed.
22+
--
23+
A failure indicates that at least one of the connection settings is incorrect. Change the settings in the *vSphere connection configuration* wizard and save the configuration again.
24+
25+
. Check that you are able to bind `PersistentVolumeClaims` objects by performing the following steps:
26+
27+
.. Create a `StorageClass` object using the following YAML:
28+
+
29+
[source,yaml]
30+
----
31+
kind: StorageClass
32+
apiVersion: storage.k8s.io/v1
33+
metadata:
34+
name: vsphere-sc
35+
provisioner: kubernetes.io/vsphere-volume
36+
parameters:
37+
datastore: YOURVCENTERDATASTORE
38+
diskformat: thin
39+
reclaimPolicy: Delete
40+
volumeBindingMode: Immediate
41+
----
42+
.. Create a `PersistentVolumeClaims` object using the following YAML:
43+
+
44+
[source,yaml]
45+
----
46+
kind: PersistentVolumeClaim
47+
apiVersion: v1
48+
metadata:
49+
name: test-pvc
50+
namespace: openshift-config
51+
annotations:
52+
volume.beta.kubernetes.io/storage-provisioner: kubernetes.io/vsphere-volume
53+
finalizers:
54+
- kubernetes.io/pvc-protection
55+
spec:
56+
accessModes:
57+
- ReadWriteOnce
58+
resources:
59+
requests:
60+
storage: 10Gi
61+
storageClassName: vsphere-sc
62+
volumeMode: Filesystem
63+
----
64+
+
65+
If you are unable to create a `PersistentVolumeClaims` object, you can troubleshoot by navigating to *Storage* -> *PersistentVolumeClaims* in the *Administrator* perspective of the {product-title} web console.

0 commit comments

Comments
 (0)