[vmclarity] Unify access ui steps in getting started (#35)

Also removes unneeded install-vmclarity page
openclarity · Dec 5, 2023 · 9bd68bf · 9bd68bf
1 parent d947348
commit 9bd68bf
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 40 deletions.
diff --git a/content/docs/vmclarity/getting-started/_index.md b/content/docs/vmclarity/getting-started/_index.md
@@ -1,6 +1,8 @@
 ---
 title: Getting started
 weight: 200
+aliases:
+- /docs/vmclarity/getting-started/install-vmclarity/
 ---
 
 This chapter guides you through the installation of the VMClarity backend and the CLI, and shows you the most common tasks that you can perform with VMClarity.
diff --git a/content/docs/vmclarity/getting-started/deploy-aws/_index.md b/content/docs/vmclarity/getting-started/deploy-aws/_index.md
@@ -70,4 +70,12 @@ To deploy the VMClarity AWS CloudFormation Stack, complete the following steps.
         <img width="100%" src="aws-vmclarity-ssh.png">
     </p>
 
-1. [Open the VMClarity UI](/docs/vmclarity/getting-started/install-vmclarity#access-ui).
+1. {{< include-headless "vmclarity/ssh-tunnel-to-server.md" >}}
+
+1. Access the VMClarity UI.
+
+    {{< include-headless "vmclarity/access-ui.md" >}}
+
+## Next steps
+
+Complete the {{% xref "/docs/vmclarity/getting-started/first-tasks/_index.md" %}}.
diff --git a/content/docs/vmclarity/getting-started/deploy-azure/_index.md b/content/docs/vmclarity/getting-started/deploy-azure/_index.md
@@ -55,4 +55,12 @@ weight: 110
         <img width="75%" src="azure-deploy-output.png">
     </p>
 
-1. [Open the VMClarity UI]({{< relref "/docs/vmclarity/getting-started/install-vmclarity/_index.md#access-ui" >}}).
+1. {{< include-headless "vmclarity/ssh-tunnel-to-server.md" >}}
+
+1. Access the VMClarity UI.
+
+    {{< include-headless "vmclarity/access-ui.md" >}}
+
+## Next steps
+
+Complete the {{% xref "/docs/vmclarity/getting-started/first-tasks/_index.md" %}}.
diff --git a/content/docs/vmclarity/getting-started/deploy-docker/_index.md b/content/docs/vmclarity/getting-started/deploy-docker/_index.md
@@ -59,18 +59,20 @@ To run VMClarity in Docker on a local machine, complete the following steps.
         <img width="75%" src="vmclarity-docker.png">
     </p>
 
-1. After you've finished your tasks, stop the running containers.
-
-    ```shell
-    docker compose --project-name vmclarity --file docker-compose.yml down --remove-orphans
-    ```
-
-## Access VMClarity UI
-
-1. Navigate to [http://localhost:8080/](http://localhost:8080/) in your browser.
+1. Access the VMClarity UI. Navigate to [http://localhost:8080/](http://localhost:8080/) in your browser.
 
     <p align="center" width="100%">
         <img width="75%" src="/img/vmclarity-ui-1.png">
     </p>
 
-1. Complete the {{% xref "/docs/vmclarity/getting-started/first-tasks/_index.md" %}}.
+## Next steps
+
+Complete the {{% xref "/docs/vmclarity/getting-started/first-tasks/_index.md" %}}.
+
+## Stop the containers
+
+1. After you've finished your tasks, stop the running containers.
+
+    ```shell
+    docker compose --project-name vmclarity --file docker-compose.yml down --remove-orphans
+    ```
diff --git a/content/docs/vmclarity/getting-started/deploy-gcp/_index.md b/content/docs/vmclarity/getting-started/deploy-gcp/_index.md
@@ -68,20 +68,20 @@ To install VMClarity on [Google Cloud Platform (GCP)](https://cloud.google.com),
    gcloud deployment-manager deployments create <vmclarity deployment name> --config vmclarity-config.yaml
    ```
 
-## Access VMClarity UI
-
 1. Open an SSH tunnel to the VMClarity server with gcloud. For further information on how to create an SSH connection
    with gcloud to one of your instances check the [official page](https://cloud.google.com/compute/docs/connect/standard-ssh#gcloud).
 
    ```shell
    gcloud compute ssh --project=<project id> --zone=<zone name> <name of your VM> -- -NL 8080:localhost:80
    ```
 
-1. Open the VMClarity UI in your browser at [http://localhost:8080](http://localhost:8080).
+1. Access the VMClarity UI.
+
+    {{< include-headless "vmclarity/access-ui.md" >}}
 
-   ![VMClarity UI Dashboard](/img/vmclarity-ui-1.png)
+## Next steps
 
-1. Complete the {{% xref "/docs/vmclarity/getting-started/first-tasks/_index.md" %}}.
+Complete the {{% xref "/docs/vmclarity/getting-started/first-tasks/_index.md" %}}.
 
 ## Uninstall VMClarity
 

diff --git a/content/docs/vmclarity/getting-started/install-vmclarity/_index.md b/content/docs/vmclarity/getting-started/install-vmclarity/_index.md
diff --git a/content/headless/vmclarity/access-ui.md b/content/headless/vmclarity/access-ui.md
@@ -1,11 +1,5 @@
 ---
 ---
-1. Open an SSH tunnel to VMClarity the server
-
-    ```shell
-    ssh -N -L 8080:localhost:80 -i  "<Path to the SSH key specified during install>" ubuntu@<VmClarity SSH Address copied during install>
-    ```
-
 1. Open the VMClarity UI in your browser at [http://localhost:8080/](http://localhost:8080/). The dashboard opens.
 
     ![VMClarity UI Dashboard](/img/vmclarity-ui-1.png)

diff --git a/content/headless/vmclarity/ssh-tunnel-to-server.md b/content/headless/vmclarity/ssh-tunnel-to-server.md
@@ -0,0 +1,7 @@
+---
+---
+Open an SSH tunnel to VMClarity the server
+
+```shell
+ssh -N -L 8080:localhost:80 -i  "<Path to the SSH key specified during install>" ubuntu@<VmClarity SSH Address copied during install>
+```