From 5363724315d9b040c4e936785e7d798ff587cb8a Mon Sep 17 00:00:00 2001 From: Bob Furu Date: Fri, 24 Jul 2020 13:17:10 -0400 Subject: [PATCH] CP of #24043 --- ...nstalling-restricted-networks-vsphere.adoc | 4 + ...-installer-provisioned-customizations.adoc | 71 ++++++++++++++++ ...er-provisioned-network-customizations.adoc | 81 +++++++++++++++++++ ...talling-vsphere-installer-provisioned.adoc | 65 +++++++++++++++ ...alling-vsphere-network-customizations.adoc | 4 + .../installing-vsphere.adoc | 4 + ...gistry-storage-block-recreate-rollout.adoc | 27 +++++++ .../installation-registry-storage-config.adoc | 8 +- .../configuring-registry-storage-vsphere.adoc | 4 + 9 files changed, 264 insertions(+), 4 deletions(-) create mode 100644 installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc create mode 100644 installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc create mode 100644 installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc create mode 100644 modules/installation-registry-storage-block-recreate-rollout.adoc diff --git a/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc b/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc index 855c44946ac6..9883368b964a 100644 --- a/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc +++ b/installing/installing_vsphere/installing-restricted-networks-vsphere.adoc @@ -80,6 +80,10 @@ include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] include::modules/installation-registry-storage-non-production.adoc[leveloffset=+3] +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + include::modules/installation-complete-user-infra.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc new file mode 100644 index 000000000000..44de2bc02a02 --- /dev/null +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc @@ -0,0 +1,71 @@ +[id="installing-vsphere-installer-provisioned-customizations"] += Installing a cluster on vSphere with customizations +include::modules/common-attributes.adoc[] +:context: installing-vsphere-installer-provisioned-customizations + +toc::[] + +In {product-title} version {product-version}, you can install a cluster on your +VMware vSphere instance by using installer-provisioned infrastructure. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. + +.Prerequisites + +* Provision +xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] +for your cluster. To deploy a private image registry, your storage must provide +ReadWriteMany access modes. +* Review details about the +xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +processes. +* If you use a firewall, you must +xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to allow the sites] that your cluster requires access to. ++ +[NOTE] +==== +Be sure to also review this site list if you are configuring a proxy. +==== + +include::modules/cluster-entitlements.adoc[leveloffset=+1] + +include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] + +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] + +include::modules/ssh-agent-using.adoc[leveloffset=+1] + +include::modules/installation-obtaining-installer.adoc[leveloffset=+1] + +include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1] + +include::modules/installation-initializing.adoc[leveloffset=+1] + +include::modules/installation-configuration-parameters.adoc[leveloffset=+2] + +include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2] + +include::modules/installation-launching-installer.adoc[leveloffset=+1] + +include::modules/cli-installing-cli.adoc[leveloffset=+1] + +include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] + +[id="installing-vsphere-installer-provisioned-customizations-registry"] +== Creating registry storage +After you install the cluster, you must create storage for the registry Operator. + +include::modules/registry-removed.adoc[leveloffset=+2] + +include::modules/installation-registry-storage-config.adoc[leveloffset=+2] + +include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] + +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + +.Next steps + +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. +* If necessary, you can +xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. +* xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc new file mode 100644 index 000000000000..d0f64f6ba559 --- /dev/null +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc @@ -0,0 +1,81 @@ +[id="installing-vsphere-installer-provisioned-network-customizations"] += Installing a cluster on vSphere with network customizations +include::modules/common-attributes.adoc[] +:context: installing-vsphere-installer-provisioned-network-customizations + +toc::[] + +In {product-title} version {product-version}, you can install a cluster on your +VMware vSphere instance by using installer-provisioned infrastructure with customized network configuration options. By customizing your network configuration, your cluster can coexist with existing IP address allocations in your environment and integrate with existing MTU and VXLAN configurations. To customize the installation, you modify parameters in the `install-config.yaml` file before you install the cluster. + +You must set most of the network configuration parameters during installation, and you can modify only `kubeProxy` configuration parameters in a running cluster. + +.Prerequisites + +* Provision +xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] +for your cluster. To deploy a private image registry, your storage must provide +ReadWriteMany access modes. +* Review details about the +xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +processes. +* If you use a firewall, you must +xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to allow the sites] that your cluster requires access to. ++ +[NOTE] +==== +Be sure to also review this site list if you are configuring a proxy. +==== + +include::modules/cluster-entitlements.adoc[leveloffset=+1] + +include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] + +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] + +include::modules/ssh-agent-using.adoc[leveloffset=+1] + +include::modules/installation-obtaining-installer.adoc[leveloffset=+1] + +include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1] + +include::modules/installation-initializing.adoc[leveloffset=+1] + +include::modules/installation-configuration-parameters.adoc[leveloffset=+2] + +// additional install-config network parameters +include::modules/nw-install-config-parameters.adoc[leveloffset=+2] + +include::modules/installation-installer-provisioned-vsphere-config-yaml.adoc[leveloffset=+2] + +// begin network customization +include::modules/nw-modifying-operator-install-config.adoc[leveloffset=+1] +include::modules/nw-operator-cr.adoc[leveloffset=+1] +// end network customization + +include::modules/installation-launching-installer.adoc[leveloffset=+1] + +include::modules/cli-installing-cli.adoc[leveloffset=+1] + +include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] + +[id="installing-vsphere-installer-provisioned-network-customizations-registry"] +== Creating registry storage +After you install the cluster, you must create storage for the registry Operator. + +include::modules/registry-removed.adoc[leveloffset=+2] + +include::modules/installation-registry-storage-config.adoc[leveloffset=+2] + +include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] + +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + +.Next steps + +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. +* If necessary, you can +xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. +* xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc b/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc new file mode 100644 index 000000000000..c3a56856dc9c --- /dev/null +++ b/installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc @@ -0,0 +1,65 @@ +[id="installing-vsphere-installer-provisioned"] += Installing a cluster on vSphere +include::modules/common-attributes.adoc[] +:context: installing-vsphere-installer-provisioned + +toc::[] + +In {product-title} version {product-version}, you can install a cluster on your +VMware vSphere instance by using installer-provisioned infrastructure. + +.Prerequisites + +* Provision +xref:../../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[persistent storage] +for your cluster. To deploy a private image registry, your storage must provide +ReadWriteMany access modes. +* Review details about the +xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] +processes. +* If you use a firewall, you must +xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to allow the sites] that your cluster requires access to. ++ +[NOTE] +==== +Be sure to also review this site list if you are configuring a proxy. +==== + +include::modules/cluster-entitlements.adoc[leveloffset=+1] + +include::modules/installation-vsphere-infrastructure.adoc[leveloffset=+1] + +include::modules/installation-vsphere-installer-infra-requirements.adoc[leveloffset=+1] + +include::modules/ssh-agent-using.adoc[leveloffset=+1] + +include::modules/installation-obtaining-installer.adoc[leveloffset=+1] + +include::modules/installation-adding-vcenter-root-certificates.adoc[leveloffset=+1] + +include::modules/installation-launching-installer.adoc[leveloffset=+1] + +include::modules/cli-installing-cli.adoc[leveloffset=+1] + +include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1] + +[id="installing-vsphere-installer-provisioned-registry"] +== Creating registry storage +After you install the cluster, you must create storage for the registry Operator. + +include::modules/registry-removed.adoc[leveloffset=+2] + +include::modules/installation-registry-storage-config.adoc[leveloffset=+2] + +include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] + +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + +.Next steps + +* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster]. +* If necessary, you can +xref:../../support/remote_health_monitoring/opting-out-of-remote-health-reporting.adoc#opting-out-remote-health-reporting_opting-out-remote-health-reporting[opt out of remote health reporting]. +* xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Set up your registry and configure registry storage]. diff --git a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc index 69a9e7f43b76..a6a0304d20cc 100644 --- a/installing/installing_vsphere/installing-vsphere-network-customizations.adoc +++ b/installing/installing_vsphere/installing-vsphere-network-customizations.adoc @@ -71,6 +71,10 @@ include::modules/registry-removed.adoc[leveloffset=+2] include::modules/installation-registry-storage-config.adoc[leveloffset=+2] +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + include::modules/installation-complete-user-infra.adoc[leveloffset=+1] diff --git a/installing/installing_vsphere/installing-vsphere.adoc b/installing/installing_vsphere/installing-vsphere.adoc index 59dbf1039bbd..3c4efb4182e1 100644 --- a/installing/installing_vsphere/installing-vsphere.adoc +++ b/installing/installing_vsphere/installing-vsphere.adoc @@ -73,6 +73,10 @@ include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+3] include::modules/installation-registry-storage-non-production.adoc[leveloffset=+3] +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+3] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + include::modules/installation-complete-user-infra.adoc[leveloffset=+1] diff --git a/modules/installation-registry-storage-block-recreate-rollout.adoc b/modules/installation-registry-storage-block-recreate-rollout.adoc new file mode 100644 index 000000000000..0b61cc73658a --- /dev/null +++ b/modules/installation-registry-storage-block-recreate-rollout.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * installing/installing_vsphere/installing-vsphere.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc +// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc +// * installing/installing_vsphere/installing-vsphere-network-customizations.adoc +// * installing/installing_vsphere/installing-vsphere.adoc +// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc +// * registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc + +[id="installation-registry-storage-block-recreate-rollout_{context}"] += Configuring block registry storage for VMware vSphere + +To allow the image registry to use block storage types such as vSphere Virtual Machine Disk (VMDK) during upgrades as a cluster administrator, you can use the `Recreate` rollout strategy. + +.Procedure + +. To set the image registry storage as a block storage type, patch the registry so that it uses the `Recreate` rollout strategy and runs with only `1` replica: ++ +---- +$ oc patch config.imageregistry.operator.openshift.io/cluster --type=merge -p '{"spec":{"rolloutStrategy":"Recreate","replicas":1}}' +---- ++ +. Provision the PV for the block storage device, and create a PVC for that volume. The requested block volume uses the ReadWriteOnce (RWO) access mode. ++ +. Edit the registry configuration so that it references the correct PVC. diff --git a/modules/installation-registry-storage-config.adoc b/modules/installation-registry-storage-config.adoc index af6128ebfcc2..2d7d7fdd95ba 100644 --- a/modules/installation-registry-storage-config.adoc +++ b/modules/installation-registry-storage-config.adoc @@ -27,12 +27,12 @@ endif::aws[] ifndef::aws[] The `image-registry` Operator is not initially available for platforms that do not provide default storage. After installation, you must configure your -registry to use storage so the Registry Operator is made available. +registry to use storage so that the Registry Operator is made available. endif::aws[] -Instructions for both configuring a PersistentVolume, which is required -for production clusters, and for configuring an empty directory as the storage -location, which is available for only non-production clusters, are shown. +Instructions are shown for configuring a PersistentVolume, which is required for production clusters. Where applicable, instructions are shown for configuring an empty directory as the storage location, which is available for only non-production clusters. + +Additional instructions are provided for allowing the image registry to use block storage types by using the `Recreate` rollout strategy during upgrades. ifeval::["{context}" == "installing-aws-user-infra"] :!aws: diff --git a/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc b/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc index 340bf96d5765..0ad97db60f01 100644 --- a/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc +++ b/registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc @@ -14,6 +14,10 @@ include::modules/registry-configuring-storage-vsphere.adoc[leveloffset=+1] include::modules/installation-registry-storage-non-production.adoc[leveloffset=+1] +include::modules/installation-registry-storage-block-recreate-rollout.adoc[leveloffset=+1] + +For instructions about configuring registry storage so that it references the correct PVC, see xref:../../registry/configuring_registry_storage/configuring-registry-storage-vsphere.adoc#configuring-registry-storage-vsphere[Configuring the registry for vSphere]. + [id="configuring-registry-storage-vsphere-addtl-resources"] == Additional resources