diff --git a/modules/install-creating-install-config-aws-edge-zones.adoc b/modules/install-creating-install-config-aws-edge-zones.adoc index a9bdce54ebe9..09b5ab206227 100644 --- a/modules/install-creating-install-config-aws-edge-zones.adoc +++ b/modules/install-creating-install-config-aws-edge-zones.adoc @@ -38,15 +38,20 @@ ifdef::local-zone[] # ... platform: aws: - region: <1> + region: compute: - name: edge platform: aws: - zones: <2> + zones: - #... ---- ++ +where: ++ +:: Specifies the AWS Region name. +:: Specifies the list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field. endif::local-zone[] ifdef::wavelength-zone[] + @@ -55,18 +60,21 @@ ifdef::wavelength-zone[] # ... platform: aws: - region: <1> + region: compute: - name: edge platform: aws: - zones: <2> + zones: - #... ---- ++ +where: ++ +:: Specifies the AWS Region name. +:: Specifies the list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field. endif::wavelength-zone[] -<1> The AWS Region name. -<2> The list of {zone-type} names that you use must exist in the same AWS Region specified in the `platform.aws.region` field. + .Example of a configuration to install a cluster in the `us-west-2` AWS Region that extends edge nodes to {zone-type} in `Los Angeles` and `Las Vegas` locations + diff --git a/modules/installation-launching-installer.adoc b/modules/installation-launching-installer.adoc index 80ecdc87b6cd..c57c3e2732e4 100644 --- a/modules/installation-launching-installer.adoc +++ b/modules/installation-launching-installer.adoc @@ -322,18 +322,20 @@ endif::single-step,azure-restricted[] + [source,terminal] ---- -$ ./openshift-install create cluster --dir \ <1> - --log-level=info <2> +$ ./openshift-install create cluster --dir \ + --log-level=info ---- -<1> For ``, specify the ++ +where: ++ +:: ifdef::custom-config[] -location of your customized `./install-config.yaml` file. +Specifies the location of your customized `./install-config.yaml` file. endif::custom-config[] ifdef::no-config[] -directory name to store the files that the installation program creates. +Specifies the 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`. +--log-level:: Specifies different installation details. To view different installation details, specify `warn`, `debug`, or `error` instead of `info`. ifdef::azure-gov,azure-private[] + diff --git a/modules/installation-uninstall-clouds.adoc b/modules/installation-uninstall-clouds.adoc index 92cb2cefba2e..a115b03e963f 100644 --- a/modules/installation-uninstall-clouds.adoc +++ b/modules/installation-uninstall-clouds.adoc @@ -119,11 +119,13 @@ endif::ibm-cloud,ibm-power-vs[] [source,terminal] ---- $ ./openshift-install destroy cluster \ ---dir --log-level info <1> <2> +--dir --log-level info ---- -<1> For ``, specify the path to the directory that you -stored the installation files in. -<2> To view different details, specify `warn`, `debug`, or `error` instead of `info`. ++ +where: ++ +:: Specifies the path to the directory that you stored the installation files in. +--log-level:: Specifies different details to view. To view different details, specify `warn`, `debug`, or `error` instead of `info`. ifndef::ibm-power-vs[] + [NOTE] diff --git a/modules/installing-a-cluster-with-multiarch-support.adoc b/modules/installing-a-cluster-with-multiarch-support.adoc index 3a9eca63f7dd..65d4278b7f72 100644 --- a/modules/installing-a-cluster-with-multiarch-support.adoc +++ b/modules/installing-a-cluster-with-multiarch-support.adoc @@ -40,17 +40,20 @@ The output must contain `release architecture multi` to indicate that the `opens apiVersion: v1 baseDomain: example.openshift.com compute: -- architecture: amd64 <1> +- architecture: amd64 hyperthreading: Enabled name: worker platform: {} replicas: 3 controlPlane: - architecture: arm64 <2> + architecture: arm64 name: master platform: {} replicas: 3 # ... ---- -<1> Specify the architecture of the worker node. You can set this field to either `arm64` or `amd64`. -<2> Specify the control plane node architecture. You can set this field to either `arm64` or `amd64`. ++ +where: ++ +compute.architecture:: Specifies the architecture of the worker node. You can set this field to either `arm64` or `amd64`. +controlPlane.architecture:: Specifies the control plane node architecture. You can set this field to either `arm64` or `amd64`. diff --git a/modules/installing-aws-edge-zones-custom-vpc-config.adoc b/modules/installing-aws-edge-zones-custom-vpc-config.adoc index 31747fc761a0..6449e5fbd35b 100644 --- a/modules/installing-aws-edge-zones-custom-vpc-config.adoc +++ b/modules/installing-aws-edge-zones-custom-vpc-config.adoc @@ -37,7 +37,7 @@ ifdef::local-zone[] platform: aws: region: us-west-2 - subnets: <1> + subnets: - publicSubnetId-1 - publicSubnetId-2 - publicSubnetId-3 @@ -47,7 +47,8 @@ platform: - publicSubnetId-LocalZone-1 # ... ---- -<1> List of subnet IDs created in the zones: Availability and {zone-type}. ++ +List of subnet IDs created in the zones: Availability and {zone-type}. endif::local-zone[] ifdef::wavelength-zone[] .Example installation configuration file with {zone-type} subnets @@ -57,7 +58,7 @@ ifdef::wavelength-zone[] platform: aws: region: us-west-2 - subnets: <1> + subnets: - publicSubnetId-1 - publicSubnetId-2 - publicSubnetId-3 @@ -67,7 +68,8 @@ platform: - publicOrPrivateSubnetID-Wavelength-1 # ... ---- -<1> List of subnet IDs created in the zones: Availability and {zone-type}. ++ +List of subnet IDs created in the zones: Availability and {zone-type}. endif::wavelength-zone[] ifeval::["{context}" == "installing-aws-localzone"] diff --git a/modules/machineset-creating.adoc b/modules/machineset-creating.adoc index 4a3ab8287f7a..48103df788c0 100644 --- a/modules/machineset-creating.adoc +++ b/modules/machineset-creating.adoc @@ -68,10 +68,10 @@ endif::win[] . Create a new YAML file that contains the compute machine set custom resource (CR) sample and is named `.yaml`. + ifndef::ash[] -Ensure that you set the `` and `` parameter values. +The `` parameter specifies the name of the YAML file. Ensure that you set the `` and `` parameter values. endif::ash[] ifdef::ash[] -Ensure that you set the ``, ``, and `` parameter values. +The `` parameter specifies the name of the YAML file. Ensure that you set the ``, ``, and `` parameter values. endif::ash[] . Optional: If you are not sure which value to set for a specific field, you can check an existing compute machine set from your cluster. @@ -111,8 +111,8 @@ apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: labels: - machine.openshift.io/cluster-api-cluster: <1> - name: - <2> + machine.openshift.io/cluster-api-cluster: + name: - namespace: openshift-machine-api spec: replicas: 1 @@ -128,17 +128,20 @@ spec: machine.openshift.io/cluster-api-machine-type: machine.openshift.io/cluster-api-machineset: - spec: - providerSpec: <3> + providerSpec: ... ---- -<1> The cluster infrastructure ID. -<2> A default node label. ++ +where: ++ +:: The cluster infrastructure ID. +:: A default node label. + [NOTE] ==== For clusters that have user-provisioned infrastructure, a compute machine set can only create `worker` and `infra` type machines. ==== -<3> The values in the `` section of the compute machine set CR are platform-specific. For more information about `` parameters in the CR, see the sample compute machine set CR configuration for your provider. +providerSpec:: The values in the `` section of the compute machine set CR are platform-specific. For more information about `` parameters in the CR, see the sample compute machine set CR configuration for your provider. -- ifdef::vsphere[] @@ -157,8 +160,8 @@ template: value: apiVersion: machine.openshift.io/v1beta1 credentialsSecret: - name: vsphere-cloud-credentials <1> - dataDisks: <2> + name: vsphere-cloud-credentials + dataDisks: - name: provisioningMode: sizeGiB: 10 @@ -171,22 +174,24 @@ template: numCPUs: 4 numCoresPerSocket: 4 snapshot: "" - template: <3> + template: userDataSecret: - name: worker-user-data <4> + name: worker-user-data workspace: datacenter: datastore: folder: resourcepool: - server: <5> + server: ---- -<1> The name of the secret in the `openshift-machine-api` namespace that contains the required vCenter credentials. -<2> The collection of data disk definitions. -For more information, see "Configuring data disks by using machine sets". -<3> The name of the {op-system} VM template for your cluster that was created during installation. -<4> The name of the secret in the `openshift-machine-api` namespace that contains the required Ignition configuration credentials. -<5> The IP address or fully qualified domain name (FQDN) of the vCenter server. ++ +where: ++ +credentialsSecret.name:: The name of the secret in the `openshift-machine-api` namespace that contains the required vCenter credentials. +dataDisks:: The collection of data disk definitions. For more information, see "Configuring data disks by using machine sets". +template:: The name of the {op-system} VM template for your cluster that was created during installation. +userDataSecret.name:: The name of the secret in the `openshift-machine-api` namespace that contains the required Ignition configuration credentials. +workspace.server:: The IP address or fully qualified domain name (FQDN) of the vCenter server. endif::vsphere[] . Create a `MachineSet` CR by running the following command: diff --git a/modules/machineset-yaml-aws.adoc b/modules/machineset-yaml-aws.adoc index 55cb617858aa..6c1020d84e9b 100644 --- a/modules/machineset-yaml-aws.adoc +++ b/modules/machineset-yaml-aws.adoc @@ -44,69 +44,69 @@ apiVersion: machine.openshift.io/v1beta1 kind: MachineSet metadata: labels: - machine.openshift.io/cluster-api-cluster: <1> + machine.openshift.io/cluster-api-cluster: ifndef::infra,edge[] - name: -- <2> + name: -- endif::infra,edge[] ifdef::infra[] - name: -infra- <2> + name: -infra- endif::infra[] ifdef::edge[] - name: -edge- <2> + name: -edge- endif::edge[] namespace: openshift-machine-api spec: replicas: 1 selector: matchLabels: - machine.openshift.io/cluster-api-cluster: + machine.openshift.io/cluster-api-cluster: ifdef::edge[] machine.openshift.io/cluster-api-machineset: -edge- endif::edge[] ifndef::infra,edge[] - machine.openshift.io/cluster-api-machineset: -- + machine.openshift.io/cluster-api-machineset: -- endif::infra,edge[] ifdef::infra[] - machine.openshift.io/cluster-api-machineset: -infra- + machine.openshift.io/cluster-api-machineset: -infra- endif::infra[] template: metadata: labels: - machine.openshift.io/cluster-api-cluster: + machine.openshift.io/cluster-api-cluster: ifndef::infra,edge[] - machine.openshift.io/cluster-api-machine-role: <3> - machine.openshift.io/cluster-api-machine-type: - machine.openshift.io/cluster-api-machineset: -- + machine.openshift.io/cluster-api-machine-role: + machine.openshift.io/cluster-api-machine-type: + machine.openshift.io/cluster-api-machineset: -- endif::infra,edge[] ifdef::infra[] - machine.openshift.io/cluster-api-machine-role: infra <3> - machine.openshift.io/cluster-api-machine-type: infra - machine.openshift.io/cluster-api-machineset: -infra- + machine.openshift.io/cluster-api-machine-role: infra + machine.openshift.io/cluster-api-machine-type: infra + machine.openshift.io/cluster-api-machineset: -infra- endif::infra[] ifdef::edge[] - machine.openshift.io/cluster-api-machine-role: edge <3> - machine.openshift.io/cluster-api-machine-type: edge - machine.openshift.io/cluster-api-machineset: -edge- + machine.openshift.io/cluster-api-machine-role: edge + machine.openshift.io/cluster-api-machine-type: edge + machine.openshift.io/cluster-api-machineset: -edge- endif::edge[] spec: metadata: labels: ifndef::infra,edge[] - node-role.kubernetes.io/: "" + node-role.kubernetes.io/: "" endif::infra,edge[] ifdef::infra[] - node-role.kubernetes.io/infra: "" + node-role.kubernetes.io/infra: "" endif::infra[] ifdef::edge[] machine.openshift.io/parent-zone-name: machine.openshift.io/zone-group: machine.openshift.io/zone-type: - node-role.kubernetes.io/edge: "" + node-role.kubernetes.io/edge: "" endif::edge[] providerSpec: value: ami: - id: ami-046fe691f52a953f9 <4> + id: ami-046fe691f52a953f9 apiVersion: machine.openshift.io/v1beta1 blockDevices: - ebs: @@ -117,12 +117,12 @@ endif::edge[] name: aws-cloud-credentials deviceIndex: 0 iamInstanceProfile: - id: -worker-profile + id: -worker-profile instanceType: m6i.large kind: AWSMachineProviderConfig placement: - availabilityZone: <5> - region: <6> + availabilityZone: + region: securityGroups: - filters: - name: tag:Name @@ -137,21 +137,21 @@ ifndef::edge[] filters: - name: tag:Name values: - - -private- <7> + - -private- endif::edge[] ifdef::edge[] - id: <7> + id: publicIp: true endif::edge[] tags: - - name: kubernetes.io/cluster/ + - name: kubernetes.io/cluster/ value: owned - - name: <8> - value: + - name: + value: userDataSecret: name: worker-user-data ifdef::infra,edge[] - taints: <9> + taints: ifdef::infra[] - key: node-role.kubernetes.io/infra endif::infra[] @@ -161,26 +161,28 @@ endif::edge[] effect: NoSchedule endif::infra,edge[] ---- -<1> Specify the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command: ++ +where: ++ +:: Specifies the infrastructure ID that is based on the cluster ID that you set when you provisioned the cluster. If you have the OpenShift CLI installed, you can obtain the infrastructure ID by running the following command: + [source,terminal] ---- $ oc get -o jsonpath='{.status.infrastructureName}{"\n"}' infrastructure cluster ---- ifndef::infra,edge[] -<2> Specify the infrastructure ID, role node label, and zone. -<3> Specify the role node label to add. +name:: Specifies the infrastructure ID, role node label, and zone. +machine-role:: Specifies the role node label to add. endif::infra,edge[] ifdef::infra[] -<2> Specify the infrastructure ID, `infra` role node label, and zone. -<3> Specify the `infra` role node label. +name:: Specifies the infrastructure ID, `infra` role node label, and zone. +machine-role:: Specifies the `infra` role node label. endif::infra[] ifdef::edge[] -<2> Specify the infrastructure ID, `edge` role node label, and zone name. -<3> Specify the `edge` role node label. +name:: Specifies the infrastructure ID, `edge` role node label, and zone name. +machine-role:: Specifies the `edge` role node label. endif::edge[] -<4> Specify a valid {op-system-first} Amazon -Machine Image (AMI) for your AWS zone for your {product-title} nodes. If you want to use an AWS Marketplace image, you must complete the {product-title} subscription from the link:https://aws.amazon.com/marketplace/fulfillment?productId=59ead7de-2540-4653-a8b0-fa7926d5c845[AWS Marketplace] to obtain an AMI ID for your region. +ami.id:: Specifies a valid {op-system-first} Amazon Machine Image (AMI) for your AWS zone for your {product-title} nodes. If you want to use an AWS Marketplace image, you must complete the {product-title} subscription from the link:https://aws.amazon.com/marketplace/fulfillment?productId=59ead7de-2540-4653-a8b0-fa7926d5c845[AWS Marketplace] to obtain an AMI ID for your region. + [source,terminal] ---- @@ -189,26 +191,26 @@ $ oc -n openshift-machine-api \ get machineset/-- ---- ifndef::edge[] -<5> Specify the zone name, for example, `us-east-1a`. +placement.availabilityZone:: Specifies the zone name, for example, `us-east-1a`. endif::edge[] ifdef::edge[] -<5> Specify the zone name, for example, `us-east-1-nyc-1a`. -endif::edge[] -<6> Specify the region, for example, `us-east-1`. +placement.availabilityZone:: Specifies the zone name, for example, `us-east-1-nyc-1a`. +endif::edge[] +placement.region:: Specifies the region, for example, `us-east-1`. ifndef::edge[] -<7> Specify the infrastructure ID and zone. +subnet:: Specifies the infrastructure ID and zone. endif::edge[] ifdef::edge[] -<7> The ID of the public subnet that you created in AWS {zone-type}. You created this public subnet ID when you finished the procedure for "Creating a subnet in an AWS zone". +subnet.id:: Specifies the ID of the public subnet that you created in AWS {zone-type}. You created this public subnet ID when you finished the procedure for "Creating a subnet in an AWS zone". endif::edge[] -<8> Optional: Specify custom tag data for your cluster. For example, you might add an admin contact email address by specifying a `name:value` pair of `Email:\admin-email@example.com`. +tags:: Specifies optional custom tag data for your cluster. For example, you might add an admin contact email address by specifying a `name:value` pair of `Email:\admin-email@example.com`. + [NOTE] ==== Custom tags can also be specified during installation in the `install-config.yml` file. If the `install-config.yml` file and the machine set include a tag with the same `name` data, the value for the tag from the machine set takes priority over the value for the tag in the `install-config.yml` file. ==== ifdef::infra,edge[] -<9> Specify a taint to prevent user workloads from being scheduled on +taints:: Specify a taint to prevent user workloads from being scheduled on ifdef::infra[`infra`] ifdef::edge[`edge`] nodes. diff --git a/modules/manually-create-identity-access-management.adoc b/modules/manually-create-identity-access-management.adoc index f90de4d428df..e22084a392b0 100644 --- a/modules/manually-create-identity-access-management.adoc +++ b/modules/manually-create-identity-access-management.adoc @@ -217,13 +217,16 @@ $ RELEASE_IMAGE=$(./openshift-install version | awk '/release image/ {print $3}' $ oc adm release extract \ --from=$RELEASE_IMAGE \ --credentials-requests \ - --included \// <1> - --install-config=/install-config.yaml \// <2> - --to= <3> + --included \// + --install-config=/install-config.yaml \// + --to= ---- -<1> The `--included` parameter includes only the manifests that your specific cluster configuration requires. -<2> Specify the location of the `install-config.yaml` file. -<3> Specify the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. ++ +where: ++ +--included:: Specifies that the `--included` parameter includes only the manifests that your specific cluster configuration requires. +--install-config:: Specifies the location of the `install-config.yaml` file. +--to:: Specifies the path to the directory where you want to store the `CredentialsRequest` objects. If the specified directory does not exist, this command creates it. + This command creates a YAML file for each `CredentialsRequest` object. + diff --git a/modules/nw-aws-load-balancer-with-outposts.adoc b/modules/nw-aws-load-balancer-with-outposts.adoc index f9220554cf8f..37ed67876238 100644 --- a/modules/nw-aws-load-balancer-with-outposts.adoc +++ b/modules/nw-aws-load-balancer-with-outposts.adoc @@ -36,7 +36,7 @@ kind: Ingress metadata: name: annotations: - alb.ingress.kubernetes.io/subnets: # <1> + alb.ingress.kubernetes.io/subnets: spec: ingressClassName: alb rules: @@ -50,7 +50,9 @@ spec: port: number: 80 ---- -<1> Specifies the subnet to use. ++ +The `alb.ingress.kubernetes.io/subnets` annotation specifies the subnet to use: ++ * To use the Application Load Balancer in an Outpost, specify the Outpost subnet ID. * To use the Application Load Balancer in the cloud, you must specify at least two subnets in different availability zones. -- diff --git a/modules/nw-aws-nlb-new-cluster.adoc b/modules/nw-aws-nlb-new-cluster.adoc index 9a79b5fec4a3..96c80ba37f40 100644 --- a/modules/nw-aws-nlb-new-cluster.adoc +++ b/modules/nw-aws-nlb-new-cluster.adoc @@ -21,19 +21,19 @@ Create an Ingress Controller backed by an AWS NLB on a new cluster. + [source,terminal] ---- -$ ./openshift-install create manifests --dir <1> +$ ./openshift-install create manifests --dir ---- -<1> For ``, specify the name of the directory that -contains the `install-config.yaml` file for your cluster. ++ +The `` parameter specifies the name of the directory that contains the `install-config.yaml` file for your cluster. . Create a file that is named `cluster-ingress-default-ingresscontroller.yaml` in the `/manifests/` directory: + [source,terminal] ---- -$ touch /manifests/cluster-ingress-default-ingresscontroller.yaml <1> +$ touch /manifests/cluster-ingress-default-ingresscontroller.yaml ---- -<1> For ``, specify the directory name that contains the -`manifests/` directory for your cluster. ++ +The `` parameter specifies the directory name that contains the `manifests/` directory for your cluster. + After creating the file, several network configuration files are in the `manifests/` directory, as shown: diff --git a/modules/nw-endpoint-route53.adoc b/modules/nw-endpoint-route53.adoc index 99c99fbc33f1..b03ce34fa436 100644 --- a/modules/nw-endpoint-route53.adoc +++ b/modules/nw-endpoint-route53.adoc @@ -28,9 +28,12 @@ platform: - name: elasticloadbalancing url: https://elasticloadbalancing.us-gov-west-1.amazonaws.com - name: route53 - url: https://route53.us-gov.amazonaws.com <1> + url: https://route53.us-gov.amazonaws.com - name: tagging - url: https://tagging.us-gov-west-1.amazonaws.com <2> + url: https://tagging.us-gov-west-1.amazonaws.com ---- -<1> Route 53 defaults to `https://route53.us-gov.amazonaws.com` for both AWS GovCloud (US) regions. -<2> Only the US-West region has endpoints for tagging. Omit this parameter if your cluster is in another region. ++ +where: ++ +route53:: Specifies that Route 53 defaults to `https://route53.us-gov.amazonaws.com` for both AWS GovCloud (US) regions. +tagging:: Specifies that only the US-West region has endpoints for tagging. Omit this parameter if your cluster is in another region. diff --git a/modules/nw-modifying-operator-install-config.adoc b/modules/nw-modifying-operator-install-config.adoc index 4f7545e53ec5..88a34768c342 100644 --- a/modules/nw-modifying-operator-install-config.adoc +++ b/modules/nw-modifying-operator-install-config.adoc @@ -42,9 +42,10 @@ Customizing your network configuration by modifying the {product-title} manifest + [source,terminal] ---- -$ ./openshift-install create manifests --dir <1> +$ ./openshift-install create manifests --dir ---- -<1> `` specifies the name of the directory that contains the `install-config.yaml` file for your cluster. ++ +The `` parameter specifies the name of the directory that contains the `install-config.yaml` file for your cluster. . Create a stub manifest file for the advanced network configuration that is named `cluster-network-03-config.yml` in the `/manifests/` directory: + diff --git a/modules/post-install-edge-aws-extend-machineset.adoc b/modules/post-install-edge-aws-extend-machineset.adoc index 5c7e4f91df16..3a922a9bd306 100644 --- a/modules/post-install-edge-aws-extend-machineset.adoc +++ b/modules/post-install-edge-aws-extend-machineset.adoc @@ -26,17 +26,20 @@ The following procedure details how you can create a machine set configuraton th + [source,terminal] ---- -$ aws ec2 describe-availability-zones --region \// <1> +$ aws ec2 describe-availability-zones --region \// --query 'AvailabilityZones[].{ ZoneName: ZoneName, ParentZoneName: ParentZoneName, GroupName: GroupName, ZoneType: ZoneType}' \ - --filters Name=zone-name,Values= \// <2> + --filters Name=zone-name,Values= \// --all-availability-zones ---- -<1> For ``, specify the name of the region for the zone. -<2> For ``, specify the name of the {zone-type}. ++ +where: ++ +:: Specifies the name of the region for the zone. +:: Specifies the name of the {zone-type}. + .Example output for Local Zone `us-east-1-nyc-1a` [source,terminal] diff --git a/modules/ssh-agent-using.adoc b/modules/ssh-agent-using.adoc index 65f8663f6434..328d5d504141 100644 --- a/modules/ssh-agent-using.adoc +++ b/modules/ssh-agent-using.adoc @@ -146,9 +146,10 @@ endif::openshift-origin[] + [source,terminal] ---- -$ ssh-keygen -t ed25519 -N '' -f / <1> +$ ssh-keygen -t ed25519 -N '' -f / ---- -<1> Specify the path and file name, such as `~/.ssh/id_ed25519`, of the new SSH key. If you have an existing key pair, ensure your public key is in the your `~/.ssh` directory. ++ +The `/` parameter specifies the path and file name, such as `~/.ssh/id_ed25519`, of the new SSH key. If you have an existing key pair, ensure your public key is in the your `~/.ssh` directory. + ifndef::ibm-power-vs[] [NOTE] @@ -202,9 +203,10 @@ endif::ibm-power-vs[] + [source,terminal] ---- -$ ssh-add / <1> +$ ssh-add / ---- -<1> Specify the path and file name for your SSH private key, such as `~/.ssh/id_ed25519` ++ +The `/` parameter specifies the path and file name for your SSH private key, such as `~/.ssh/id_ed25519` + .Example output [source,terminal]