fix markdownlint issues

Author: remkohdev-ibm

workshop/Lab5/README.md

@@ -66,4 +66,4 @@ If you want to learn more about the IBM Cloud Object Storage plugin and s3fs-fus
 
 ## Next
 
-[Lab 5: Add Object Storage to a Persistent Database](cos-with-s3fs/README.md)
+[Lab 5: Add Object Storage to a Persistent Database](cos-with-s3fs/README.md)

workshop/Lab5/cos-with-s3fs/CLUSTER.md

@@ -3,7 +3,7 @@
 You now have an Object Storage instance with a bucket, and have found the corresponding private endpoint for your Object Storage. Next, we can configure a Kubernetes cluster:
 
 1. Create a New Namespace in your Cluster,
-2. Create a Secret to Access the Object Storage,
+1. Create a Secret to Access the Object Storage,
 
 ## Create a New Namespace in your Cluster
 
@@ -15,7 +15,7 @@ You now have an Object Storage instance with a bucket, and have found the corres
 
     **Note:** if you use a single-sign-on provider, use the `-sso` flag.
 
-2. If you needed to switch accounts, you will have logged in again, and when prompted to `Select an account`, this time, choose the account with your cluster. In the example below, I have to choose account number **2** from the list, `2. IBM Client Developer Advocacy (e65910fa61) <-> 1234567`,
+1. If you needed to switch accounts, you will have logged in again, and when prompted to `Select an account`, this time, choose the account with your cluster. In the example below, I have to choose account number **2** from the list, `2. IBM Client Developer Advocacy (e65910fa61) <-> 1234567`,
 
     ```console
     ibmcloud login -u b.newell2@remkoh.dev
@@ -33,7 +33,7 @@ You now have an Object Storage instance with a bucket, and have found the corres
     Targeted account IBM Client Developer Advocacy (e65910fa61) <-> 1234567
     ```
 
-3. Retrieve your cluster information.
+1. Retrieve your cluster information.
 
     ```console
     ibmcloud ks clusters
@@ -48,19 +48,19 @@ You now have an Object Storage instance with a bucket, and have found the corres
     <yourcluster>    br78vuhd069a00er8s9g    normal    1 day ago      1    Dallas    1.16.10_1533    default    classic
     ```
 
-4. Retrieve the name of your cluster, in this example, I set the name of the first cluster with index `0`,
+1. Retrieve the name of your cluster, in this example, I set the name of the first cluster with index `0`,
 
     ```console
     CLUSTER_NAME=$(ibmcloud ks clusters --output json | jq -r '.[0].name')
     echo $CLUSTER_NAME
     ```
 
-5.  **In your browser:** get the login command for your cluster:
+1. **In your browser:** get the login command for your cluster:
 
-    1. Go to the IBM Cloud resources page at https://cloud.ibm.com/resources,
+    1. Go to the IBM Cloud resources page at [https://cloud.ibm.com/resources](https://cloud.ibm.com/resources),
     Under `Clusters` find and select your cluster, and load the cluster overview page. There are two ways to retrieve the login command with token:
     1. Click the `Actions` drop down next to the `OpenShift web console` button, and select `Connect via CLI`, in the pop-up window, click the `oauth token request page` link, or
-    1. Click `OpenShift web console` button, in the `OpenShift web console`, click your profile name, such as IAM#name@email.com, and then click `Copy Login Command`.
+    2. Click `OpenShift web console` button, in the `OpenShift web console`, click your profile name, such as `IAM#name@email.com`, and then click `Copy Login Command`.
 
     ![Copy Login Command](../images/cluster/ocp_copylogincommand.png)
 
@@ -84,13 +84,13 @@ You now have an Object Storage instance with a bucket, and have found the corres
     Welcome! See 'oc help' to get started.
     ```
 
-6.  Create a new project `cos-with-s3fs`,
+1. Create a new project `cos-with-s3fs`,
 
     ```console
     oc new-project $NAMESPACE
     ```
 
-7.  Make sure you're still logged in to your cluster and namespace,
+1. Make sure you're still logged in to your cluster and namespace,
 
     ```console
     oc project
@@ -100,19 +100,19 @@ You now have an Object Storage instance with a bucket, and have found the corres
 
 ## Create a Secret to Access the Object Storage
 
-1. Create a `Kubernetes Secret` to store the COS service credentials named `cos-write-access`.
+Create a `Kubernetes Secret` to store the COS service credentials named `cos-write-access`.
 
-    ```console
-    oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=$COS_APIKEY --from-literal=service-instance-id=$COS_GUID
-    ```
+```console
+oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=$COS_APIKEY --from-literal=service-instance-id=$COS_GUID
+```
 
-    outputs,
+outputs,
 
-    ```console
-    $ oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=$COS_APIKEY --from-literal=service-instance-id=$COS_GUID
+```console
+$ oc create secret generic cos-write-access --type=ibm/ibmc-s3fs --from-literal=api-key=$COS_APIKEY --from-literal=service-instance-id=$COS_GUID
 
-    secret/cos-write-access created
-    ```
+secret/cos-write-access created
+```
 
 ## Next
 

workshop/Lab5/cos-with-s3fs/COS-PLUGIN.md

@@ -174,7 +174,7 @@ You are going to install the `IBM Cloud Object Storage Plugin` in your cluster,
     Events:                <none>
     ```
 
-    Additional information is available at https://cloud.ibm.com/docs/containers?topic=containers-object_storage#configure_cos.
+    Additional information is available at [https://cloud.ibm.com/docs/containers?topic=containers-object_storage#configure_cos](https://cloud.ibm.com/docs/containers?topic=containers-object_storage#configure_cos).
 
 1. Verify that plugin pods are in "Running" state and indicate `READY` state of `1/1`:
 

workshop/Lab5/cos-with-s3fs/COS.md

@@ -25,15 +25,15 @@ Steps:
     COS_PRIVATE_ENDPOINT=s3.private.$REGION.cloud-object-storage.appdomain.cloud
     ```
 
-1. Create an instance of the `IBM Cloud Object Storage` service. For information, go to https://cloud.ibm.com/catalog/services/cloud-object-storage. You can only have 1 single free Lite instance per account. Login to your **personal account**,
+2. Create an instance of the `IBM Cloud Object Storage` service. For information about the IBM Cloud Object Storage service, go [here](https://cloud.ibm.com/catalog/servicecloud-object-storage). You can only have 1 single free Lite instance per account. Login to your **personal account**,
 
     ```console
     ibmcloud login -u $IBM_ID
     ```
 
     **Note:** if you use a single-sign-on provider, use the `-sso` flag.
 
-1. You will be prompted to select an account. You must choose your own account under your own name. In the example below, account 1 is my own account under my own name, account 2 is where my Kubernetes cluster is located and that was provisioned to me, but on that second account I have no permission to create new resources. I have to select account **1** under my own name, e.g. `B Newell's Account',
+3. You will be prompted to select an account. You must choose your own account under your own name. In the example below, account 1 is my own account under my own name, account 2 is where my Kubernetes cluster is located and that was provisioned to me, but on that second account I have no permission to create new resources. I have to select account **1** under my own name, e.g. `B Newell's Account',
 
     ```console
     Select an account:
@@ -43,7 +43,7 @@ Steps:
       Targeted account B Newell's Account (31296e3a285f)
     ```
 
-1. You also need a resource group. Check if a resource-group exists,
+4. You also need a resource group. Check if a resource-group exists,
 
     ```console
     ibmcloud resource groups
@@ -87,7 +87,7 @@ Steps:
     Resource Group ID: 93f7a4cd3c824c0cbe90d8f21b46f758
     ```
 
-1. Set the environment variable $RESOURCEGROUP,
+5. Set the environment variable $RESOURCEGROUP,
 
     ```console
     RESOURCEGROUP=$(ibmcloud resource groups --output json | jq -r '.[0].name')
@@ -176,7 +176,7 @@ Data in `IBM Cloud Object Storage` is stored and organized in so-called `buckets
     ```
 
     Review the CRN property.
-    
+
     ```console
     $ ibmcloud cos config list
     Key                     Value   
@@ -200,10 +200,10 @@ Data in `IBM Cloud Object Storage` is stored and organized in so-called `buckets
     Check the config again, to make sure the CRN is set now,
 
     ```console
-    $ ibmcloud cos config list
+    ibmcloud cos config list
     ```
 
-1. Create a new bucket.
+2. Create a new bucket.
 
     ```console
     ibmcloud cos bucket-create --bucket $COS_BUCKET_NAME --class Standard --ibm-service-instance-id $COS_CRN
@@ -220,7 +220,7 @@ Data in `IBM Cloud Object Storage` is stored and organized in so-called `buckets
     Class: Standard
     ```
 
-1. Verify the new bucket was created successfully.
+3. Verify the new bucket was created successfully.
 
     ```console
     ibmcloud cos list-buckets --ibm-service-instance-id $COS_CRN
@@ -269,7 +269,7 @@ The `IBM Cloud Object Storage plugin` uses the `private endpoint` of the Object
     ServiceEndpointURL
     ```
 
-    With your bucket's location, e.g. `us-south`, you can find your bucket's private endpoint here https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types, OR in the following steps you find it in your Cloud Object Storage's bucket configuration.
+    With your bucket's location, e.g. `us-south`, you can find your bucket's private endpoint here [https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types](https://cloud.ibm.com/docs/cloud-object-storage?topic=cloud-object-storage-endpoints#advanced-endpoint-types), OR in the following steps you find it in your Cloud Object Storage's bucket configuration.
 
     If your region is `us-south` the private endpoint is `s3.private.us-south.cloud-object-storage.appdomain.cloud`. Set an environment variable `$REGION` with the found region, and construct the service endpoint as follows.
 
@@ -279,16 +279,16 @@ The `IBM Cloud Object Storage plugin` uses the `private endpoint` of the Object
     echo $COS_PRIVATE_ENDPOINT
     ```
 
-1. **In a browser**, you can verify the private endpoint for your region by navigating to https://cloud.ibm.com/resources.
+1. **In a browser**, you can verify the private endpoint for your region by navigating to [https://cloud.ibm.com/resources](https://cloud.ibm.com/resources).
 
    1. Expand the Storage section.
    1. Locate and select your IBM Cloud Object Storage service instance.
    1. In the left menu, select the `buckets` section Select your new `bucket` in the `Buckets` tab.
-   1.  Select the `Configuration` tab under `Buckets` iin the left pane.
+   1. Select the `Configuration` tab under `Buckets` iin the left pane.
 
-       ![](../.gitbook/images/cos-04.png)
+       ![Buckets](../.gitbook/images/cos-04.png)
 
-   1.  Take note of the `Private` endpoint. It should match your environment variable `$COS_PRIVATE_ENDPOINT`.
+   1. Take note of the `Private` endpoint. It should match your environment variable `$COS_PRIVATE_ENDPOINT`.
 
 ## Next
 

workshop/Lab5/cos-with-s3fs/IBMC-S3FS.md

@@ -19,7 +19,7 @@ S3, the Simple Storage Service, originated as Amazon. the central storage compon
 
 Instead of always providing all parameters via the API, it is more convenient to mount the bucket as a folder onto the existing file system. This can be done via s3fs or goofys.
 
-## Using s3fs 
+## Using s3fs
 
 Create a credentials file `~/.cos_creds` with:
 
@@ -47,4 +47,4 @@ s3fs can yield good performance results when used with workloads reading or writ
 
 ## Next
 
-[Lab 5: Add Object Storage to a Persistent Database](README.md)
+[Lab 5: Add Object Storage to a Persistent Database](README.md)

workshop/Lab5/cos-with-s3fs/MONGODB.md

@@ -7,7 +7,7 @@ In this section, you are going to deploy an instance of MongoDB to your OpenShif
 1. [Optional] If you want to configure the MongoDB via a `values.yaml` file, or want to review the default values of the Helm chart, in the `Cloud Shell`, you can download the default `values.yaml` file from the bitnami/mongodb Helm chart, which is used to configure and deploy the MongoDB Helm chart. In this lab we will overwrite the values from the commandline when we install the chart.
 
     ```console
-    $ wget https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mongodb/values.yaml
+    wget https://raw.githubusercontent.com/bitnami/charts/master/bitnami/mongodb/values.yaml
     ```
 
 1. [Optional] To review the available configuration options, open the `values.yaml` file in a file editor and review the parameters that can be modified during mongdb deployment. In this exercise however, you'll overwrite the default values using Helm command parameters instead of a `values.yaml` file.
@@ -304,4 +304,4 @@ To verify MongoDB deployment,
 
 You are awesome! You have now added IBM Cloud Object Storage persistent storage to your MongoDB database using dynamic provisioning the `IBM Cloud Object Storage plugin` based on `s3fs-fuse`. What remains is configuring your application to use the MongoDB service.
 
-You can use the instructions in the [FUSE lab](../../fuse/README.md) to mount a local filesystem to the remote Object Storage and inspect the documents.
+You can use the instructions in the [FUSE lab](../../fuse/README.md) to mount a local filesystem to the remote Object Storage and inspect the documents.

workshop/Lab5/cos-with-s3fs/PVC.md

@@ -11,27 +11,25 @@ In this exercise, you are going to use an existing bucket when assigning persist
 
     > **Note:** Replace the values for:
 
-      - `ibm.io/bucket`,
-      - `ibm.io/secret-name` and
-      - `ibm.io/endpoint`.
-      
+      * `ibm.io/bucket`,
+      * `ibm.io/secret-name` and
+      * `ibm.io/endpoint`.
+
       If your values are not exactly matching with the bucket name you created, the secret name you created and the private endpoint of your bucket, the PVC will remain in state pending and fail to create.
 
     > **Note:** The `secret-name` should be set to `cos-write-access` unless you changed the name of the secret we created earlier,
-
     > **Note:** `ibm.io/endpoint` should be set to the output of command `echo "https://$COS_PRIVATE_ENDPOINT"`
-
     > Create the file first and then edit the file with `vi` if changes are needed,
 
-1. You need the bucket name and namespace to configure the PVC,
+2. You need the bucket name and namespace to configure the PVC,
 
     ```console
     echo "https://$COS_PRIVATE_ENDPOINT"
     echo $COS_BUCKET_NAME
     oc project
     ```
 
-1. Create the file,
+3. Create the file,
 
 ```console
 echo 'kind: PersistentVolumeClaim
@@ -58,14 +56,14 @@ spec:
 
 1. In `Theia` the integrated browser IDE, in the directory `/project/cos-with-s3fs`, open the file `my-iks-pvc.yaml`,
 
-![](../images/cos-with-s3fs/theia-open-my-pvc.png)
+![Theia IDE Open File](../images/cos-with-s3fs/theia-open-my-pvc.png)
 
 and set the right values if changes are still needed,
 
-    * change the `namespace` value to the project name found with `oc project`,
-    * the `ibm.io/bucket` should be set to the value defined in `echo $COS_BUCKET_NAME`,
-    * `ibm.io/secret-name` should be set to `"cos-write-access"`,
-    * validate the `ibm.io/endpoint` to be set to the private service endpoint for your Object Storage bucket for the correct region,
+* change the `namespace` value to the project name found with `oc project`,
+* the `ibm.io/bucket` should be set to the value defined in `echo $COS_BUCKET_NAME`,
+* `ibm.io/secret-name` should be set to `"cos-write-access"`,
+* validate the `ibm.io/endpoint` to be set to the private service endpoint for your Object Storage bucket for the correct region,
 
 1. Create a `PersistentVolumeClaim`.
 
@@ -97,7 +95,6 @@ and set the right values if changes are still needed,
     ```
 
     > Note: If the state of the PVC remains `Pending`, you can inspect the error for why the PVC remains pending by using the `describe` command: `oc describe pvc <pvc_name>`. For example, `oc describe pvc my-iks-pvc`.
-
     > Note: If the state of the PVC stays as `Pending`, the problem must be resolved before you move to the next step.
 
 1. Verify a new `PersistentVolume` was also created successfully.

workshop/Lab5/cos-with-s3fs/README.md

@@ -33,4 +33,4 @@ Related labs using Object Storage are:
 
 ## Next
 
-[Setup](../setup/README.md)
+[Setup](../setup/README.md)

workshop/Lab5/setup/README.md

@@ -113,4 +113,4 @@ should output the directory `/home/project/cos-with-s3fs`.
 
 ## Next
 
-[Setup Object Storage](../cos-with-s3fs/COS.md)
+[Setup Object Storage](../cos-with-s3fs/COS.md)

workshop/Lab5/share-docs-with-cos/README.md

@@ -59,7 +59,6 @@ ibmcloud iam api-key-create $IAM_APIKEY_NAME --file $IAM_APIKEY_NAME.txt
     ibmcloud resource service-instance-create $COS_NAME cloud-object-storage $COS_PLAN global -g $RESOURCEGROUP
     ```
 
-
 1. Get the GUID for the Cloud Object Storage service,
 
     ```console