doc(aws): markdown formatting updates

gnufied · Aug 2, 2022 · f3663e9 · f3663e9
1 parent 1d3282c
commit f3663e9
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 34 deletions.
diff --git a/docs/content/how-to/aws/create-infra-iam-separately.md b/docs/content/how-to/aws/create-infra-iam-separately.md
@@ -18,7 +18,7 @@ In order to do this, you need to:
 
 Use the `hypershift create infra aws` command:
 
-    ./bin/hypershift create infra aws --name CLUSTER_NAME \
+    hypershift create infra aws --name CLUSTER_NAME \
         --aws-creds AWS_CREDENTIALS_FILE \
         --base-domain BASEDOMAIN \
         --infra-id INFRA_ID \
@@ -27,19 +27,19 @@ Use the `hypershift create infra aws` command:
 
 where
 
-* CLUSTER_NAME is the name of the hosted cluster you intend to create. This is used for creating
+* `CLUSTER_NAME` is the name of the hosted cluster you intend to create. This is used for creating
     the Route53 private hosted zones that belong to the cluster.
-* AWS_CREDENTIALS_FILE points to an AWS credentials file that has permission to create 
+* `AWS_CREDENTIALS_FILE` points to an AWS credentials file that has permission to create
     infrastructure resources for your cluster such as VPCs, subnets, NAT gateways, etc.
     It should correspond to the AWS account for your guest cluster, where workers will live.
-* BASEDOMAIN is the base domain that will be used for your hosted cluster's ingress. It must
+* `BASEDOMAIN` is the base domain that will be used for your hosted cluster's ingress. It must
     correspond to an existing Route53 public zone that you have access to create records in.
-* INFRA_ID is a unique name that will be used to identify your infrastructure via tags. It is used
+* `INFRA_ID` is a unique name that will be used to identify your infrastructure via tags. It is used
     by the cloud controller manager in Kubernetes and the CAPI manager to identify infrastructure
     for your cluster. Typically this is the name of your cluster (CLUSTER_NAME) with a random
     suffix appended to it.
-* REGION is the region where you want to create the infrastructure for your cluster.
-* OUTPUT_INFRA_FILE is the file where IDs of the infrastructure that has been created will be stored in JSON format.
+* `REGION` is the region where you want to create the infrastructure for your cluster.
+* `OUTPUT_INFRA_FILE` is the file where IDs of the infrastructure that has been created will be stored in JSON format.
     This file can then be used as input to the `hypershift create cluster aws` command to populate
     the appropriate fields in the HostedCluster and NodePool resources.
 
@@ -58,13 +58,13 @@ Running this command should result in the following resources getting created:
 
 All of these resources will contain the following tag:
 `kubernetes.io/cluster/INFRA_ID=owned`
-where INFRA_ID is what you specified on the command invocation.
+where `INFRA_ID` is what you specified on the command invocation.
 
 ## Creating the AWS IAM resources
 
 Use the `hypershift create iam aws` command:
 
-    ./bin/hypershift create iam aws --infra-id INFRA_ID \
+    hypershift create iam aws --infra-id INFRA_ID \
         --aws-creds AWS_CREDENTIALS_FILE \
         --oidc-storage-provider-s3-bucket-name OIDC_BUCKET_NAME \
         --oidc-storage-provider-s3-region OIDC_BUCKET_REGION \
@@ -76,25 +76,25 @@ Use the `hypershift create iam aws` command:
 
 where
 
-* INFRA_ID should be the same id that was specified in the `create infra aws` command. It is
+* `INFRA_ID` should be the same id that was specified in the `create infra aws` command. It is
     used to identify the IAM resources associated with the hosted cluster.
-* AWS_CREDENTIALS_FILE points to an AWS credentials file that has permission to create 
+* `AWS_CREDENTIALS_FILE` points to an AWS credentials file that has permission to create
     IAM resources such as roles. It does not have to be the same credentials specified to create
     the infrastructure but it does have to correspond to the same AWS account.
-* OIDC_BUCKET_NAME is the name of the bucket used to store OIDC documents. This bucket should have been
-    created as a prerequisite for installing Hypershift (See [Prerequisites](../getting-started/#Prerequisites))
+* `OIDC_BUCKET_NAME` is the name of the bucket used to store OIDC documents. This bucket should have been
+    created as a prerequisite for installing Hypershift (See [Prerequisites](../../../getting-started/#Prerequisites))
     The name of the bucket is used to construct URLs for the OIDC provider created by this command.
-* OIDC_BUCKET_REGION is the region where the OIDC bucket lives.
-* REGION is the region where the infrastructure of the cluster will live. This is used to create a worker
+* `OIDC_BUCKET_REGION` is the region where the OIDC bucket lives.
+* `REGION` is the region where the infrastructure of the cluster will live. This is used to create a worker
     instance profile for machines that belong to the hosted cluster.
-* PUBLIC_ZONE_ID is the ID of the public zone for the guest cluster. It is used in creating the policy for the ingress operator.
-    It can be found in the OUTPUT_INFRA_FILE generated by the `create infra aws` command.
-* PRIVATE_ZONE_ID is the ID of the private zone for the guest cluster. It is used in creating the policy for the ingress operator.
-    It can be found in the OUTPUT_INFRA_FILE generated by the `create infra aws` command.
-* LOCAL_ZONE_ID is the ID of the local zone for the guest cluster (when creating a private cluster). It is used in creating the policy
+* `PUBLIC_ZONE_ID` is the ID of the public zone for the guest cluster. It is used in creating the policy for the ingress operator.
+    It can be found in the `OUTPUT_INFRA_FILE` generated by the `create infra aws` command.
+* `PRIVATE_ZONE_ID` is the ID of the private zone for the guest cluster. It is used in creating the policy for the ingress operator.
+    It can be found in the `OUTPUT_INFRA_FILE` generated by the `create infra aws` command.
+* `LOCAL_ZONE_ID` is the ID of the local zone for the guest cluster (when creating a private cluster). It is used in creating the policy
     for the control plane operator so it can manage records for the PrivateLink endpoint.
-    It can be found in the OUTPUT_INFRA_FILE generated by the `create infra aws` command.
-* OUTPUT_IAM_FILE is the file where IDs of the IAM resources that have been created will be stored in JSON format.
+    It can be found in the `OUTPUT_INFRA_FILE` generated by the `create infra aws` command.
+* `OUTPUT_IAM_FILE` is the file where IDs of the IAM resources that have been created will be stored in JSON format.
     This file can then be used as input to the `hypershift create cluster aws` command to populate
     the appropriate fields in the HostedCluster and NodePool resource.
 
@@ -108,7 +108,7 @@ Running this command should result in the following resources getting created:
 
 Use the `hypershift create cluster aws` command:
 
-    ./bin/hypershift create cluster aws \
+    hypershift create cluster aws \
         --infra-id INFRA_ID \
         --name CLUSTER_NAME \
         --aws-creds AWS_CREDENTIALS \
@@ -120,13 +120,13 @@ Use the `hypershift create cluster aws` command:
 
 where
 
-* INFRA_ID should be the same id that was specified in the `create infra aws` command. It is
+* `INFRA_ID` should be the same id that was specified in the `create infra aws` command. It is
     used to identify the IAM resources associated with the hosted cluster.
-* CLUSTER_NAME should be the same name that was specified in the `create infra aws` command.
-* AWS_CREDENTIALS should be the same that was specified in the `create infra aws` command.
-* OUTPUT_INFRA_FILE is the file where the output of the `create infra aws` command was saved.
-* OUTPUT_IAM_FILE is the file where the output of the `create iam aws` command was saved.
-* PULL_SECRET_FILE is a file that contains a valid OpenShift pull secret.
+* `CLUSTER_NAME` should be the same name that was specified in the `create infra aws` command.
+* `AWS_CREDENTIALS` should be the same that was specified in the `create infra aws` command.
+* `OUTPUT_INFRA_FILE` is the file where the output of the `create infra aws` command was saved.
+* `OUTPUT_IAM_FILE` is the file where the output of the `create iam aws` command was saved.
+* `PULL_SECRET_FILE` is a file that contains a valid OpenShift pull secret.
 
 !!! note
 
@@ -144,4 +144,4 @@ Running this command should result in the following resources getting applied to
 * 1 SSH key secret (if --generate-ssh was specified)
 
 You can also add the `--render` flag to the command and redirect output to a file where you 
-can do further editing of the resources before applying them to the cluster.
+can do further editing of the resources before applying them to the cluster.
diff --git a/docs/content/how-to/distribute-hosted-cluster-workloads.md b/docs/content/how-to/distribute-hosted-cluster-workloads.md
@@ -25,7 +25,7 @@ If the `ControllerAvailabilityPolicy` is `HighlyAvailable` Pods for each Deploym
 HyperShift leverages PriorityClasses for driving Priority and Preemption of their managed Pods.
 It will install three four priority classes in a management cluster with the following order of priority from highest to lowest:
 
-- hypershift-operator: Hypershift operator pods
-- hypershift-etcd`: Pods for etcd.
-- hypershift-api-critical`: Pods that are required for API calls and resource admission to succeed. This includes pods like kube-apiserver, aggregated API servers, and webhooks.
-- hypershift-control-plane`: pods in the HyperShift Control Plane that are not API critical but still need elevated priority. E.g Cluster Version Operator.
+- `hypershift-operator`: Hypershift operator pods
+- `hypershift-etcd`: Pods for etcd.
+- `hypershift-api-critical`: Pods that are required for API calls and resource admission to succeed. This includes pods like kube-apiserver, aggregated API servers, and webhooks.
+- `hypershift-control-plane`: pods in the HyperShift Control Plane that are not API critical but still need elevated priority. E.g Cluster Version Operator.