1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

fixing links and module locations

This commit is contained in:
Kathryn Alexander
2019-10-03 13:05:34 -04:00
committed by openshift-cherrypick-robot
parent 04a219ebd7
commit 169d51c608
72 changed files with 169 additions and 265 deletions

View File

@@ -20,7 +20,8 @@ include::modules/installation-aws-regions.adoc[leveloffset=+1]
.Next steps
* Install an {product-title} cluster. You can
xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[install a customized cluster]
or xref:../../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[quickly install a cluster]
with default options.
* Install an {product-title} cluster:
** xref:../../installing/installing_aws/installing-aws-default.adoc#installing-aws-default[Quickly install a cluster] with default options
** xref:../../installing/installing_aws/installing-aws-customizations.adoc#installing-aws-customizations[Install a cluster with cloud customizations]
** xref:../../installing/installing_aws/installing-aws-network-customizations.adoc#installing-aws-network-customizations[Install a cluster with network customizations]
** xref:../../installing/installing_aws_user_infra/installing-aws-user-infra.adoc#installing-aws-user-infra[Install a cluster on infrastructure that you provision]

View File

@@ -50,7 +50,7 @@ include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/installing-aws-customizations.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -38,7 +38,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -62,7 +62,7 @@ include::modules/nw-operator-cr.adoc[leveloffset=+1]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -97,7 +97,7 @@ include::modules/installation-creating-aws-worker.adoc[leveloffset=+2]
include::modules/installation-cloudformation-worker.adoc[leveloffset=+3]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -31,10 +31,8 @@ include::modules/installation-azure-regions.adoc[leveloffset=+1]
.Next steps
////
* Install an {product-title} cluster. You can
* Install an {product-title} cluster on Azure. You can
xref:../../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[install a customized cluster]
or
xref:../../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[quickly install a cluster]
with default options.
////

View File

@@ -15,8 +15,7 @@ some parameters in the `install-config.yaml` file before you install the cluster
* Review details about the
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
processes.
//* xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configure an Azure account]
//to host the cluster.
* xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configure an Azure account] to host the cluster.
* If you use a firewall, you must
xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
@@ -36,7 +35,7 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -13,8 +13,7 @@ Microsoft Azure that uses the default configuration options.
* Review details about the
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
processes.
// * xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configure an Azure account]
// to host the cluster.
* xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configure an Azure account] to host the cluster.
* If you use a firewall, you must
xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
@@ -26,7 +25,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -43,7 +43,7 @@ include::modules/ssh-agent-using.adoc[leveloffset=+1]
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/installation-initializing-manual.adoc[leveloffset=+1]

View File

@@ -19,11 +19,9 @@ include::modules/installation-gcp-enabling-api-services.adoc[leveloffset=+1]
include::modules/installation-gcp-regions.adoc[leveloffset=+1]
////
.Next steps
* Install an {product-title} cluster. You can
* Install an {product-title} cluster on GCP. You can
xref:../../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[install a customized cluster]
or xref:../../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[quickly install a cluster]
with default options.
////

View File

@@ -15,8 +15,8 @@ some parameters in the `install-config.yaml` file before you install the cluster
* Review details about the
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
processes.
//* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
//to host the cluster.
* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
to host the cluster.
* If you use a firewall, you must
xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
@@ -36,9 +36,7 @@ include::modules/installation-configure-proxy.adoc[leveloffset=+2]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
//include::modules/installing-aws-customizations.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -13,8 +13,8 @@ Google Cloud Platform (GCP) that uses the default configuration options.
* Review details about the
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
processes.
//* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
//to host the cluster.
* xref:../../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Configure a GCP account]
to host the cluster.
* If you use a firewall, you must
xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
@@ -26,7 +26,7 @@ include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]

View File

@@ -1,19 +0,0 @@
[id="installing-restricted-networks-preparations"]
= Preparing to install a disconnected cluster
include::modules/common-attributes.adoc[]
:context: installing-restricted-networks-preparations
toc::[]
Before you install a cluster on infrastructure that you provision in a
restricted network, you must prepare the environment.
//include::modules/cluster-entitlements.adoc[leveloffset=+1]
.Next steps
* Install a cluster on infrastructure that you provision, such as
xref:../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[VMware vSphere]
or
xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[bare metal].

View File

@@ -1,48 +0,0 @@
[id="installing-azure-customizations"]
= Installing a cluster on Azure with customizations
include::modules/common-attributes.adoc[]
:context: installing-azure-customizations
toc::[]
In {product-title} version {product-version}, you can install a customized
cluster on infrastructure that the installation program provisions on
Microsoft Azure. To customize the installation, you modify
some parameters in the `install-config.yaml` file before you install the cluster.
.Prerequisites
* Review details about the
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
processes.
//* xref:../../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Configure an Azure account]
//to host the cluster.
* If you use a firewall, you must
xref:../../installing/install_config/configuring-firewall.adoc#configuring-firewall[configure it to access Red Hat Insights].
include::modules/cluster-entitlements.adoc[leveloffset=+1]
include::modules/ssh-agent-using.adoc[leveloffset=+1]
include::modules/installation-obtaining-installer.adoc[leveloffset=+1]
include::modules/installation-initializing.adoc[leveloffset=+1]
include::modules/installation-configuration-parameters.adoc[leveloffset=+2]
include::modules/installation-azure-config-yaml.adoc[leveloffset=+2]
// TODO: If this assembly is going to be for restricted network Azure install, whenever it is included, need to confirm whether proxy is supported before including the following file:
// include::modules/installation-configure-proxy.adoc[leveloffset=+2]
include::modules/installation-launching-installer.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
.Next steps
* xref:../../installing/install_config/customizations.adoc#customizations[Customize your cluster].
* If necessary, you can
xref:../../telemetry/opting-out-of-telemetry.adoc#opting-out-of-telemetry[opt out of telemetry].

View File

@@ -22,14 +22,14 @@ according to your company's policies.
.Prerequisites
//* xref:../../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc[Create a mirror registry on your bastion host]
// and obtain the `imageContentSources` data for your version of {product-title}.
////
* xref:../../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your bastion host]
and obtain the `imageContentSources` data for your version of {product-title}.
+
[IMPORTANT]
====
Because the installation media is on the bastion host, use that computer
to complete all installation steps.
////
====
* Review details about the
xref:../../architecture/architecture-installation.adoc#architecture-installation[{product-title} installation and update]
processes.

View File

@@ -19,14 +19,13 @@ before you attempt to install an {product-title} cluster in such an environment.
.Prerequisites
//* xref:../../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc[Create a mirror registry on your bastion host]
// and obtain the `imageContentSources` data for your version of {product-title}.
////
* xref:../../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your bastion host] and obtain the `imageContentSources` data for your version of {product-title}.
+
[IMPORTANT]
====
Because the installation media is on the bastion host, use that computer
to complete all installation steps.
////
====
* 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

View File

@@ -24,7 +24,7 @@ include::modules/installation-about-mirror-registry.adoc[leveloffset=+1]
Before you create the mirror registry, you must prepare the bastion host.
include::modules/cli-install.adoc[leveloffset=+2]
include::modules/cli-installing-cli.adoc[leveloffset=+2]
include::modules/installation-creating-mirror-registry.adoc[leveloffset=+1]
@@ -34,12 +34,8 @@ include::modules/installation-local-registry-pull-secret.adoc[leveloffset=+1]
include::modules/installation-mirror-repository.adoc[leveloffset=+1]
////
Need to fix these links after the other PR merges.
.Next steps
* Install a cluster on infrastructure that you provision, such as
xref:../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[VMware vSphere]
or
xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[bare metal].
////
* Install a cluster on infrastructure that you provision in your restricted nework, such as on
xref:../../installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc#installing-restricted-networks-vsphere[VMware vSphere],
xref:../../installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc#installing-restricted-networks-bare-metal[bare metal], or xref:../../installing/installing_restricted_networks/installing-restricted-networks-aws.adoc#installing-restricted-networks-aws[Amazon Web Services].

View File

@@ -10,14 +10,13 @@ VMware vSphere infrastructure that you provision in a restricted network.
.Prerequisites
//* xref:../../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc[Create a mirror registry on your bastion host]
// and obtain the `imageContentSources` data for your version of {product-title}.
////
* xref:../../installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc#installing-restricted-networks-preparations[Create a mirror registry on your bastion host] and obtain the `imageContentSources` data for your version of {product-title}.
+
[IMPORTANT]
====
Because the installation media is on the bastion host, use that computer
to complete all installation steps.
////
====
* 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

View File

@@ -46,7 +46,7 @@ include::modules/installation-generate-ignition-configs.adoc[leveloffset=+1]
include::modules/installation-vsphere-machines.adoc[leveloffset=+1]
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/installation-installing-bare-metal.adoc[leveloffset=+1]

View File

@@ -1,39 +0,0 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="cli-install_{context}"]
= Installing the OpenShift Command-line Interface
You can download and install the OpenShift Command-line Interface (CLI),
commonly known as `oc`.
[IMPORTANT]
====
If you installed an earlier version of `oc`, you cannot use it to complete all
of the commands in {product-title} {product-version}. You must download and
install the new version of `oc`.
====
.Procedure
. From the link:https://cloud.redhat.com/openshift/install[OpenShift Infrastructure Providers] page,
click *Download Command-line Tools*.
. From the site that is displayed, download the compressed file for your
operating system.
+
[NOTE]
====
You can install `oc` on Linux, Windows, or macOS.
====
. Extract the compressed file and place it in a directory that is on your PATH.

View File

@@ -1,6 +1,17 @@
// Module included in the following assemblies:
//
// * cli_reference/getting-started.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
//
// AMQ docs link to this; do not change anchor
@@ -10,12 +21,24 @@
You can install the CLI in order to interact with {product-title} using a
command-line interface.
[IMPORTANT]
====
If you installed an earlier version of `oc`, you cannot use it to complete all
of the commands in {product-title} {product-version}. You must download and
install the new version of `oc`.
====
.Procedure
. From the link:https://cloud.redhat.com/openshift/install[OpenShift Infrastructure Providers] page,
click *Download Command-line Tools*.
. Click the folder for your operating system and architecture and click the
compressed file.
+
[NOTE]
====
You can install `oc` on Linux, Windows, or macOS.
====
. Save the file to your file system.
. Extract the compressed file.
. Place it in a directory that is on your `PATH`.

View File

@@ -1,16 +1,20 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_osp/installing-openstack-installer.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="cli-logging-in-kubeadmin_{context}"]

View File

@@ -1,17 +1,21 @@
// Module included in the following assemblies:
//
// * architecture/architecture.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="cluster-entitlements_{context}"]

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_restricted_networks/installing-restricted-networks-preparations.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
[id="installation-about-restricted-networks_{context}"]
= About installations in restricted networks

View File

@@ -2,6 +2,9 @@
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
// * machine_management/adding-rhel-compute.adoc
// * machine_management/more-rhel-compute.adoc

View File

@@ -1,7 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing-aws/installing-aws-account.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-account.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-aws-permissions_{context}"]
= Required AWS permissions

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-aws-user-infra-bootstrap_{context}"]
= Initializing the bootstrap node on AWS with user-provisioned infrastructure

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-aws-user-infra-installation_{context}"]
= Completing an AWS installation on user-provisioned infrastructure

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-aws-user-infra-requirements_{context}"]
= Required AWS infrastructure components

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-aws-user-infra-rhcos-ami_{context}"]
= {op-system} AMIs for the AWS infrastructure

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-cloudformation-bootstrap_{context}"]
= CloudFormation template for the bootstrap machine

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-cloudformation-control-plane_{context}"]
= CloudFormation template for control plane machines

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-cloudformation-dns_{context}"]
= CloudFormation template for the network and load balancers

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-cloudformation-security_{context}"]
= CloudFormation template for security objects

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-cloudformation-vpc_{context}"]
= CloudFormation template for the VPC

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-cloudformation-worker_{context}"]
= CloudFormation template for worker machines

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-complete-user-infra_{context}"]

View File

@@ -261,13 +261,14 @@ ifdef::azure[]
[cols=".^2,.^3a,.^3a",options="header"]
|====
|Parameter|Description|Values
|`machines.platform.azure.type`
|The Azure VM instance type.
|VMs that use Windows or Linux as the operating system. See the
link:https://docs.microsoft.com/en-us/azure-stack/operator/azure-stack-supported-os?view=azs-1908[Guest operating systems supported on Azure Stack]
in the Azure documentation.
`machines.platform.azure.osDisk.diskSizeGB`
|`machines.platform.azure.osDisk.diskSizeGB`
|The Azure disk size for the VM.
|Integer that represents the size of the disk in GB, for example `512`. The
minimum supported disk size is `120`.

View File

@@ -1,14 +1,14 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
ifeval::["{context}" == "installing-bare-metal"]
:bare-metal:

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-creating-aws-bootstrap_{context}"]
= Creating the bootstrap node in AWS

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-creating-aws-control-plane_{context}"]
= Creating the control plane machines in AWS

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-creating-aws-dns_{context}"]
= Creating networking and load balancing components in AWS

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-creating-aws-security_{context}"]
= Creating security group and roles in AWS
@@ -100,4 +101,4 @@ the other CloudFormation templates that you run to create your cluster:
`MasterSecurityGroupId`:: Master Security Group ID
`WorkerSecurityGroupId`:: Worker Security Group ID
`MasterInstanceProfile`:: Master IAM Instance Profile
`WorkerInstanceProfile`:: Worker IAM Instance Profile
`WorkerInstanceProfile`:: Worker IAM Instance Profile

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-creating-aws-vpc_{context}"]
= Creating a VPC in AWS
@@ -87,4 +88,4 @@ the other CloudFormation templates that you run to create your cluster:
[horizontal]
`VpcId`:: The ID of your VPC.
`PublicSubnetIds`:: The IDs of the new public subnets.
`PrivateSubnetIds`:: The IDs of the new private subnets.
`PrivateSubnetIds`:: The IDs of the new private subnets.

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-creating-aws-worker_{context}"]
= Creating the worker nodes in AWS

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
:prewrap!:

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-extracting-infraid_{context}"]
= Extracting the infrastructure name

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
[id="installation-generate-aws-user-infra-ignition_{context}"]
= Creating the Kubernetes manifest and Ignition config files

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
ifeval::["{context}" == "installing-restricted-networks-aws"]
:restricted:

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
ifeval::["{context}" == "installing-restricted-networks-aws"]
:restricted:

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
ifeval::["{context}" == "installing-restricted-networks-vsphere"]

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-infrastructure-user-infra_{context}"]

View File

@@ -4,7 +4,6 @@
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// Consider also adding the installation-configuration-parameters.adoc module.

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-installing-bare-metal_{context}"]

View File

@@ -1,14 +1,15 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// If you use this module in any other assembly, you must update the ifeval
// statements.
@@ -86,13 +87,12 @@ endif::gcp[]
$ ./openshift-install create cluster --dir=<installation_directory> \ <1>
--log-level info <2>
----
<1> For `<installation_directory>`, specify the
ifdef::custom-config[]
<1> For `<installation_directory>`, specify the location of your customized
`./install-config.yaml` file.
location of your customized `./install-config.yaml` file.
endif::custom-config[]
ifdef::no-config[]
<1> For `<installation_directory>`, specify the directory name to store the
files that the installation program creates.
directory name to store the files that the installation program creates.
endif::no-config[]
<2> To view different installation details, specify `warn`, `debug`, or
`error` instead of `info`.

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-network-user-infra_{context}"]

View File

@@ -1,16 +1,18 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-obtaining-installer_{context}"]
= Obtaining the installation program

View File

@@ -2,6 +2,9 @@
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-operators-config_{context}"]

View File

@@ -1,66 +0,0 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
[id="installation-provide-credentials_{context}"]
= Configuring your computer for installation
Before you install your {product-title} cluster, add your Amazon Web Services (AWS)
credentials to you computer.
.Prerequisites
* Configure an AWS account to host your cluster and a user with sufficient
privileges to complete the installation process. You need details about the
account and user, including the access key ID and secret access key values for
the user.
* You must configure a computer that uses a Linux or macOS operating system.
.Procedure
. Download the AWS CLI and install it on your computer. See
link:https://docs.aws.amazon.com/cli/latest/userguide/install-bundle.html[Install the AWS CLI Using the Bundled Installer (Linux, macOS, or Unix)]
in the AWS documentation.
. Provide the configuration details for your account. Run the following command,
and provide details about your account at the prompts:
+
----
$ aws configure --profile=<profile_name> <1>
AWS Access Key ID [None]: accesskey <2>
AWS Secret Access Key [None]: secretkey <2>
Default region name [None]: us-west-2 <3>
Default output format [None]:
----
<1> Enter a `<profile_name>` to store the credentials in.
<2> Enter the access key ID and secret access key values for the user that you
configured to run the installation program.
<3> Enter the name of the region that you plan to deploy your cluster to.
. Confirm that your profile is correctly configured:
+
----
$ aws sts get-caller-identity --profile=<profile_name> <1>
output:
{
"Account": "123123123123",
"UserId": "TH75ISMYR3F4RCHUS3R1D",
"Arn": "arn:aws:iam::123123123123:user/refarchuser"
}
----
<1> Specify the same `<profile_name>`.
+
If the command output resembles the sample output, your profile is correctly
configured. If an error displays, configure your credentials again.
. Save the AWS profile:
+
----
$ export AWS_PROFILE=<profile_name> <1>
----
<1> Enter the `<profile_name>` that you specified.

View File

@@ -2,6 +2,9 @@
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-registry-storage-config_{context}"]

View File

@@ -2,6 +2,9 @@
//
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-registry-storage-non-production_{context}"]

View File

@@ -1,6 +1,8 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-requirements-user-infra_{context}"]

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
[id="installation-user-infra-machines-iso_{context}"]
= Creating {op-system-first} machines using an ISO image

View File

@@ -1,6 +1,7 @@
// Module included in the following assemblies:
//
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
[id="installation-user-infra-machines-pxe_{context}"]
= Creating {op-system-first} machines by PXE or iPXE booting

View File

@@ -1,5 +1,6 @@
// Module included in the following assemblies:
//
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-vsphere-infrastructure_{context}"]

View File

@@ -1,5 +1,6 @@
// Module included in the following assemblies:
//
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="installation-vsphere-machines_{context}"]

View File

@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
//* architecture/installation-.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * registry/configuring-registry-storage-aws-user-infrastructure.adoc
[id="registry-configuring-storage-aws-user-infra_{context}"]

View File

@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
//* architecture/installation-.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * registry/configuring-registry-storage-baremetal
[id="registry-configuring-storage-baremetal_{context}"]

View File

@@ -1,6 +1,5 @@
// Module included in the following assemblies:
//
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * registry/configuring-registry-storage-gcp-user-infrastructure.adoc
[id="registry-configuring-storage-gcp-user-infra_{context}"]

View File

@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
//* architecture/installation-.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
// * registry/configuring-registry-storage-vsphere.adoc

View File

@@ -1,16 +1,20 @@
// Module included in the following assemblies:
//
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_aws_user_infra/installing-aws-user-infra.adoc
// * installing/installing_aws/installing-aws-customizations.adoc
// * installing/installing_aws/installing-aws-default.adoc
// * installing/installing_aws/installing-aws-network-customizations.adoc
// * installing/installing_azure/installing-azure-customizations.adoc
// * installing/installing_azure/installing-azure-default.adoc
// * installing/installing_bare_metal/installing-bare-metal.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_gcp/installing-gcp-customizations.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_gcp/installing-gcp-default.adoc
// * installing/installing_openstack/installing-openstack-installer-custom.adoc
// * installing/installing_openstack/installing-openstack-installer-kuryr.adoc
// * installing/installing_openstack/installing-openstack-installer.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-aws.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-bare-metal.adoc
// * installing/installing_restricted_networks/installing-restricted-networks-vsphere.adoc
// * installing/installing_vsphere/installing-vsphere.adoc
[id="ssh-agent-using_{context}"]

View File

@@ -11,7 +11,7 @@ Knative client does not have its own log in mechanism. To log in to the cluster
// Installation
include::modules/cli-install.adoc[leveloffset=+1]
include::modules/cli-installing-cli.adoc[leveloffset=+1]
include::modules/serverless-installing-cli-linux.adoc[leveloffset=+2]
// RPM install procedure commented out
// include::modules/serverless-installing-cli-linux-rpm.adoc[leveloffset=+2]