mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
157 lines
5.0 KiB
Plaintext
157 lines
5.0 KiB
Plaintext
// Module included in the following assemblies:
|
|
//
|
|
// * installing/installing_aws/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_aws/installing-aws-private.adoc
|
|
// * installing/installing_aws/installing-aws-vpc.adoc
|
|
// * installing/installing_azure/installing-azure-customizations.adoc
|
|
// * installing/installing_azure/installing-azure-default.adoc
|
|
// * installing/installing_azure/installing-azure-private.adoc
|
|
// * installing/installing_azure/installing-azure-vnet.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_gcp/installing-gcp-vpc.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_aws/installing-restricted-networks-aws.adoc
|
|
// * installing/installing_bare_metal/installing-restricted-networks-bare-metal.adoc
|
|
// * installing/installing_vsphere/installing-restricted-networks-vsphere.adoc
|
|
// * installing/installing_vsphere/installing-vsphere.adoc
|
|
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
|
|
|
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
|
|
:user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
|
|
:user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-restricted-networks-aws"]
|
|
:user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-bare-metal"]
|
|
:user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-vsphere"]
|
|
:user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-aws-user-infra"]
|
|
:user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-openstack-installer-custom"]
|
|
:osp:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-openstack-installer-kuryr"]
|
|
:osp:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-openstack-installer"]
|
|
:osp:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-ibm-z"]
|
|
:ibm-z:
|
|
endif::[]
|
|
|
|
[id="ssh-agent-using_{context}"]
|
|
= Generating an SSH private key and adding it to the agent
|
|
|
|
If you want to perform installation debugging or disaster recovery on your cluster, you must provide an SSH key to both your `ssh-agent` and to the installation program.
|
|
[NOTE]
|
|
====
|
|
In a production environment, you require disaster recovery and debugging.
|
|
====
|
|
|
|
ifdef::ibm-z[]
|
|
[IMPORTANT]
|
|
====
|
|
Do not skip this procedure in production environments where disaster recovery and debugging is required.
|
|
====
|
|
endif::[]
|
|
|
|
You can use this key to SSH into the master nodes as the user `core`. When you
|
|
deploy the cluster, the key is added to the `core` user's
|
|
`~/.ssh/authorized_keys` list.
|
|
|
|
ifndef::osp,ibm-z[]
|
|
[NOTE]
|
|
====
|
|
You must use a local key, not one that you configured with platform-specific
|
|
approaches such as
|
|
link:https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html[AWS key pairs].
|
|
====
|
|
endif::[]
|
|
|
|
.Procedure
|
|
|
|
. If you do not have an SSH key that is configured for password-less authentication
|
|
on your computer, create one.
|
|
For example, on a computer that uses a Linux operating system, run the
|
|
following command:
|
|
+
|
|
----
|
|
$ ssh-keygen -t rsa -b 4096 -N '' \
|
|
-f <path>/<file_name> <1>
|
|
----
|
|
<1> Specify the path and file name, such as `~/.ssh/id_rsa`, of the SSH key.
|
|
+
|
|
Running this command generates an SSH key that does not require a password in
|
|
the location that you specified.
|
|
|
|
. Start the `ssh-agent` process as a background task:
|
|
+
|
|
----
|
|
$ eval "$(ssh-agent -s)"
|
|
|
|
Agent pid 31874
|
|
----
|
|
|
|
. Add your SSH private key to the `ssh-agent`:
|
|
+
|
|
----
|
|
$ ssh-add <path>/<file_name> <1>
|
|
|
|
Identity added: /home/<you>/<path>/<file_name> (<computer_name>)
|
|
----
|
|
<1> Specify the path and file name for your SSH private key, such as `~/.ssh/id_rsa`
|
|
|
|
|
|
.Next steps
|
|
|
|
* When you install {product-title}, provide the SSH public key to the installation program.
|
|
ifdef::user-infra[]
|
|
If you install a cluster on infrastructure that you provision, you must provide this key to your cluster's machines.
|
|
endif::user-infra[]
|
|
|
|
ifeval::["{context}" == "installing-restricted-networks-vsphere"]
|
|
:!user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-restricted-networks-bare-metal"]
|
|
:!user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-restricted-networks-aws"]
|
|
:!user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-bare-metal"]
|
|
:!user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-vsphere"]
|
|
:!user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-aws-user-infra"]
|
|
:!user-infra:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-openstack-installer-custom"]
|
|
:!osp:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-openstack-installer-kuryr"]
|
|
:!osp:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-openstack-installer"]
|
|
:!osp:
|
|
endif::[]
|
|
ifeval::["{context}" == "installing-ibm-z"]
|
|
:!ibm-z:
|
|
endif::[]
|