Skip to content

Commit ac8aa3e

Browse files
committed
OSDOCS-4745: Installing Nutanix cluster in a restricted env
1 parent d5e0ff5 commit ac8aa3e

19 files changed

+428
-11
lines changed

_topic_maps/_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,8 @@ Topics:
284284
File: preparing-to-install-on-nutanix
285285
- Name: Installing a cluster on Nutanix
286286
File: installing-nutanix-installer-provisioned
287+
- Name: Installing a cluster on Nutanix in a restricted network
288+
File: installing-restricted-networks-nutanix-installer-provisioned
287289
- Name: Uninstalling a cluster on Nutanix
288290
File: uninstalling-cluster-nutanix
289291
- Name: Installing on bare metal

installing/installing-preparing.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ If you use a user-provisioned installation method, you can configure a proxy for
7575

7676
If you want to prevent your cluster on a public cloud from exposing endpoints externally, you can deploy a private cluster with installer-provisioned infrastructure on xref:../installing/installing_aws/installing-aws-private.adoc#installing-aws-private[AWS], xref:../installing/installing_azure/installing-azure-private.adoc#installing-azure-private[Azure], or xref:../installing/installing_gcp/installing-gcp-private.adoc#installing-gcp-private[GCP].
7777

78-
If you need to install your cluster that has limited access to the internet, such as a disconnected or restricted network cluster, you can xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the installation packages] and install the cluster from them. Follow detailed instructions for user provisioned infrastructure installations into restricted networks for xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[GCP], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[IBM Z or LinuxONE], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[IBM Z or LinuxONE with {op-system-base} KVM], xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[IBM Power], xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[vSphere], xref:../installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc#installing-restricted-networks-vmc-user-infra[VMC on AWS], or xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted network using installer-provisioned infrastructure by following detailed instructions for xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[GCP], xref:../installing/installing_vmc/installing-restricted-networks-vmc.adoc#installing-restricted-networks-vmc[VMC on AWS], xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[{rh-openstack}], xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[{rh-virtualization}], and xref:../installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[vSphere].
78+
If you need to install your cluster that has limited access to the internet, such as a disconnected or restricted network cluster, you can xref:../installing/disconnected_install/installing-mirroring-installation-images.adoc#installing-mirroring-installation-images[mirror the installation packages] and install the cluster from them. Follow detailed instructions for user provisioned infrastructure installations into restricted networks for xref:../installing/installing_aws/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp.adoc#installing-restricted-networks-gcp[GCP], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc#installing-restricted-networks-ibm-z[IBM Z or LinuxONE], xref:../installing/installing_ibm_z/installing-restricted-networks-ibm-z-kvm.adoc#installing-restricted-networks-ibm-z-kvm[IBM Z or LinuxONE with {op-system-base} KVM], xref:../installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc#installing-restricted-networks-ibm-power[IBM Power], xref:../installing/installing_vsphere/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[vSphere], xref:../installing/installing_vmc/installing-restricted-networks-vmc-user-infra.adoc#installing-restricted-networks-vmc-user-infra[VMC on AWS], or xref:../installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal]. You can also install a cluster into a restricted network using installer-provisioned infrastructure by following detailed instructions for xref:../installing/installing_aws/installing-restricted-networks-aws-installer-provisioned.adoc#installing-restricted-networks-aws-installer-provisioned[AWS], xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[GCP], xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[Nutanix], xref:../installing/installing_vmc/installing-restricted-networks-vmc.adoc#installing-restricted-networks-vmc[VMC on AWS], xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[{rh-openstack}], xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[{rh-virtualization}], and xref:../installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc#installing-restricted-networks-installer-provisioned-vsphere[vSphere].
7979

8080
If you need to deploy your cluster to an xref:../installing/installing_aws/installing-aws-government-region.adoc#installing-aws-government-region[AWS GovCloud region], xref:../installing/installing_aws/installing-aws-china.adoc#installing-aws-china-region[AWS China region], or xref:../installing/installing_azure/installing-azure-government-region.adoc#installing-azure-government-region[Azure government region], you can configure those custom regions during an installer-provisioned infrastructure installation.
8181

@@ -196,7 +196,7 @@ ifndef::openshift-origin[]
196196
|
197197
|
198198
|xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓]
199-
|
199+
|xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[✓]
200200
|xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[✓]
201201
|xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[✓]
202202
|xref:../installing/installing_bare_metal_ipi/ipi-install-installation-workflow.adoc#ipi-install-installation-workflow[✓]
@@ -363,7 +363,7 @@ ifdef::openshift-origin[]
363363
|
364364
|
365365
|xref:../installing/installing_gcp/installing-restricted-networks-gcp-installer-provisioned.adoc#installing-restricted-networks-gcp-installer-provisioned[✓]
366-
|
366+
|xref:../installing/installing_nutanix/installing-restricted-networks-nutanix-installer-provisioned.adoc#installing-restricted-networks-nutanix-installer-provisioned[✓]
367367
|xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[✓]
368368
|xref:../installing/installing_rhv/installing-rhv-restricted-network.adoc#installing-rhv-restricted-network[✓]
369369
|
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
:_content-type: ASSEMBLY
2+
[id="installing-restricted-networks-nutanix-installer-provisioned"]
3+
= Installing a cluster on Nutanix in a restricted network
4+
include::_attributes/common-attributes.adoc[]
5+
:context: installing-restricted-networks-nutanix-installer-provisioned
6+
7+
toc::[]
8+
9+
In {product-title} {product-version}, you can install a cluster on Nutanix infrastructure in a restricted network by creating an internal mirror of the installation release content.
10+
11+
== Prerequisites
12+
13+
* You have reviewed details about the xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update] processes.
14+
* If you use a firewall, you have configured it to xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[grant access] to the sites that {product-title} requires. This includes the use of Telemetry.
15+
* If your Nutanix environment is using the default self-signed SSL/TLS certificate, replace it with a certificate that is signed by a CA. The installation program requires a valid CA-signed certificate to access to the Prism Central API. For more information about replacing the self-signed certificate, see the https://portal.nutanix.com/page/documents/details?targetId=Nutanix-Security-Guide-v6_1:mul-security-ssl-certificate-pc-t.html[Nutanix AOS Security Guide].
16+
+
17+
[IMPORTANT]
18+
====
19+
Use 2048-bit certificates. The installation fails if you use 4096-bit certificates with Prism Central 2022.x.
20+
====
21+
* You have a container image registry, such as Red Hat Quay. If you do not already have a registry, you can create a mirror registry using xref:../../installing/disconnected_install/installing-mirroring-creating-registry.adoc#installing-mirroring-creating-registry[_mirror registry for Red Hat OpenShift_].
22+
* You have used the xref:../../installing/disconnected_install/installing-mirroring-disconnected.adoc#installing-mirroring-disconnected[oc-mirror OpenShift CLI (oc) plugin] to mirror all of the required {product-title} content and other images, including the Nutanix CSI Operator, to your mirror registry.
23+
+
24+
[IMPORTANT]
25+
====
26+
Because the installation media is on the mirror host, you can use that computer to complete all installation steps.
27+
====
28+
29+
include::modules/installation-about-restricted-network.adoc[leveloffset=+1]
30+
31+
include::modules/ssh-agent-using.adoc[leveloffset=+1]
32+
33+
include::modules/installation-adding-nutanix-root-certificates.adoc[leveloffset=+1]
34+
35+
include::modules/installation-nutanix-download-rhcos.adoc[leveloffset=+1]
36+
37+
include::modules/installation-initializing.adoc[leveloffset=+1]
38+
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
39+
include::modules/installation-nutanix-config-yaml.adoc[leveloffset=+2]
40+
include::modules/installation-configure-proxy.adoc[leveloffset=+2]
41+
42+
include::modules/cli-installing-cli.adoc[leveloffset=+1]
43+
44+
include::modules/manually-configure-iam-nutanix.adoc[leveloffset=+1]
45+
46+
include::modules/installation-launching-installer.adoc[leveloffset=+1]
47+
48+
== Post installation
49+
Complete the following steps to complete the configuration of your cluster.
50+
51+
include::modules/olm-restricted-networks-configuring-operatorhub.adoc[leveloffset=+2]
52+
include::modules/oc-mirror-updating-restricted-cluster-manifests.adoc[leveloffset=+2]
53+
include::modules/registry-configuring-storage-nutanix.adoc[leveloffset=+2]
54+
55+
include::modules/cluster-telemetry.adoc[leveloffset=+1]
56+
57+
[role="_additional-resources"]
58+
== Additional resources
59+
60+
* xref:../../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring[About remote health monitoring]
61+
62+
== Next steps
63+
* 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]
64+
* xref:../../post_installation_configuration/cluster-tasks.adoc#available_cluster_customizations[Customize your cluster]

modules/cli-installing-cli.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@
4848
// * installing/installing_rhv/installing-rhv-default.adoc
4949
// * updating/updating-restricted-network-cluster/restricted-network-update.adoc
5050
// * microshift_cli_ref/microshift-oc-cli-install.adoc
51-
//
51+
// * updating/updating-restricted-network-cluster.adoc
52+
// * installing/installing-nutanix-installer-provisioned.adoc
53+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
5254
// AMQ docs link to this; do not change anchor
5355

5456
ifeval::["{context}" == "updating-restricted-network-cluster"]

modules/cluster-telemetry.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@
7070
// * installing/installing_vmc/installing-vmc.adoc
7171
// * installing/installing_ibm_power/installing-ibm-power.adoc
7272
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
73+
// * installing/installing-nutanix-installer-provisioned.adoc
74+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
7375

7476
:_content-type: CONCEPT
7577
[id="cluster-telemetry_{context}"]

modules/installation-about-restricted-network.adoc

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
// * installing/installing_ibm_z/installing-restricted-networks-ibm-z.adoc
1313
// * installing/installing_ibm_power/installing-restricted-networks-ibm-power.adoc
1414
// * installing/installing-rhv-restricted-network.adoc
15+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
1516

1617
ifeval::["{context}" == "installing-ibm-power"]
1718
:ibm-power:
@@ -37,6 +38,9 @@ endif::[]
3738
ifeval::["{context}" == "installing-restricted-networks-aws-installer-provisioned"]
3839
:ipi:
3940
endif::[]
41+
ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provisioned"]
42+
:ipi:
43+
endif::[]
4044

4145
:_content-type: CONCEPT
4246
[id="installation-about-restricted-networks_{context}"]
@@ -51,7 +55,7 @@ still require access to its cloud APIs. Some cloud functions, like
5155
Amazon Web Service's Route 53 DNS and IAM services, require internet access.
5256
//behind a proxy
5357
Depending on your network, you might require less internet
54-
access for an installation on bare metal hardware or on VMware vSphere.
58+
access for an installation on bare metal hardware, Nutanix, or on VMware vSphere.
5559
endif::ibm-power[]
5660

5761
To complete a restricted network installation, you must create a registry that
@@ -103,3 +107,6 @@ endif::[]
103107
ifeval::["{context}" == "installing-restricted-networks-aws-installer-provisioned"]
104108
:!ipi:
105109
endif::[]
110+
ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provisioned"]
111+
:!ipi:
112+
endif::[]

modules/installation-adding-nutanix-root-certificates.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Module included in the following assemblies:
22
//
33
// * installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc
4+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
45

56
:_content-type: PROCEDURE
67
[id="installation-adding-nutanix-root-certificates_{context}"]

modules/installation-configuration-parameters.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
// * installing/installing_azure_stack_hub/installing-azure-stack-hub-default.adoc
5454
// * installing/installing_azure_stack_hub/installing-azure-stack-hub-customizations.adoc
5555
// * installing/installing_nutanix/installing-nutanix-installer-provisioned.adoc
56+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
5657

5758
ifeval::["{context}" == "installing-alibaba-customizations"]
5859
:alibabacloud:
@@ -215,6 +216,9 @@ endif::[]
215216
ifeval::["{context}" == "installing-nutanix-installer-provisioned"]
216217
:nutanix:
217218
endif::[]
219+
ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provisioned"]
220+
:nutanix:
221+
endif::[]
218222

219223
:_content-type: CONCEPT
220224
[id="installation-configuration-parameters_{context}"]
@@ -2005,3 +2009,6 @@ endif::[]
20052009
ifeval::["{context}" == "installing-nutanix-installer-provisioned"]
20062010
:!nutanix:
20072011
endif::[]
2012+
ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provisioned"]
2013+
:!nutanix:
2014+
endif::[]

modules/installation-configure-proxy.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@
5757
// * installing/installing_platform_agnostic/installing-platform-agnostic.adoc
5858
// * networking/configuring-a-custom-pki.adoc
5959
// * installing/installing-rhv-restricted-network.adoc
60+
// * installing/installing-nutanix-installer-provisioned.adoc
61+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
6062

6163
ifeval::["{context}" == "installing-aws-china-region"]
6264
:aws:

modules/installation-initializing.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-network-customizations.adoc
3636
// * installing/installing_vsphere/installing-restricted-networks-installer-provisioned-vsphere.adoc
3737
// * installing/installing_nutanix/configuring-iam-nutanix.adoc
38+
// * installing/installing-restricted-networks-nutanix-installer-provisioned.adoc
3839

3940
// * installing/installing_gcp/installing-openstack-installer-restricted.adoc
4041
// Consider also adding the installation-configuration-parameters.adoc module.
@@ -166,6 +167,10 @@ endif::[]
166167
ifeval::["{context}" == "installing-nutanix-installer-provisioned"]
167168
:nutanix:
168169
endif::[]
170+
ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provisioned"]
171+
:nutanix:
172+
:restricted:
173+
endif::[]
169174

170175
:_content-type: PROCEDURE
171176
[id="installation-initializing_{context}"]
@@ -205,7 +210,13 @@ endif::nutanix[]
205210
* Obtain the {product-title} installation program and the pull secret for your cluster.
206211
ifdef::restricted[]
207212
For a restricted network installation, these files are on your mirror host.
213+
ifndef::nutanix[]
208214
* Have the `imageContentSources` values that were generated during mirror registry creation.
215+
endif::nutanix[]
216+
ifdef::nutanix+restricted[]
217+
* Have the `imageContentSourcePolicy.yaml` file that was created when you mirrored your registry.
218+
* Have the location of the {op-system-first} image you download.
219+
endif::nutanix+restricted[]
209220
* Obtain the contents of the certificate for your mirror registry.
210221
ifndef::aws,gcp[]
211222
* Retrieve a {op-system-first} image and upload it to an accessible location.
@@ -521,6 +532,16 @@ platform:
521532
clusterOSImage: http://mirror.example.com/images/rhcos-43.81.201912131630.0-vmware.x86_64.ova?sha256=ffebbd68e8a1f2a245ca19522c16c86f67f9ac8e4e0c1f0a812b068b16f7265d
522533
----
523534
endif::vsphere+restricted[]
535+
ifdef::nutanix+restricted[]
536+
. In the `install-config.yaml` file, set the value of `platform.nutanix.clusterOSImage` to the image location or name. For example:
537+
+
538+
[source,yaml]
539+
----
540+
platform:
541+
nutanix:
542+
clusterOSImage: http://mirror.example.com/images/rhcos-47.83.202103221318-0-nutanix.x86_64.qcow2
543+
----
544+
endif::nutanix+restricted[]
524545
ifdef::restricted[]
525546
. Edit the `install-config.yaml` file to give the additional information that
526547
is required for an installation in a restricted network.
@@ -585,10 +606,17 @@ imageContentSources:
585606
source: registry.example.com/ocp/release
586607
----
587608
+
609+
ifndef::nutanix[]
588610
For these values, use the `imageContentSources` that you recorded during mirror registry creation.
611+
endif::nutanix[]
612+
ifdef::nutanix[]
613+
For these values, use the `imageContentSourcePolicy.yaml` file that was created when you mirrored the registry.
614+
endif::nutanix[]
589615
616+
ifndef::nutanix[]
590617
. Make any other modifications to the `install-config.yaml` file that you require. You can find more information about
591618
the available parameters in the *Installation configuration parameters* section.
619+
endif::nutanix[]
592620
endif::restricted[]
593621
594622
ifdef::nutanix[]
@@ -734,3 +762,7 @@ endif::[]
734762
ifeval::["{context}" == "installing-nutanix-installer-provisioned"]
735763
:!nutanix:
736764
endif::[]
765+
ifeval::["{context}" == "installing-restricted-networks-nutanix-installer-provisioned"]
766+
:!nutanix:
767+
:!restricted:
768+
endif::[]

0 commit comments

Comments
 (0)