docs: add guidance to spectro-k8s-dashboard pack DOC-1442 (#4474)

* docs: add guidance to spectro-k8s-dashboard pack DOC-1442 * Optimised images with calibre/image-actions * Optimised images with calibre/image-actions * Apply suggestions from code review Co-authored-by: caroldelwing <[email protected]> * docs: adjust ingress steps DOC-1442 * docs: remove duplicated additional guidance --------- Co-authored-by: vault-token-factory-spectrocloud[bot] <133815545+vault-token-factory-spectrocloud[bot]@users.noreply.github.com> Co-authored-by: caroldelwing <[email protected]>
spectrocloud · Oct 29, 2024 · 554ea8c · 554ea8c
1 parent d97446c
commit 554ea8c
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 16 deletions.
diff --git a/docs/docs-content/clusters/cluster-management/kubernetes-dashboard.md b/docs/docs-content/clusters/cluster-management/kubernetes-dashboard.md
@@ -8,7 +8,15 @@ tags: ["clusters", "cluster management", "k"]
 ---
 
 The [Kubernetes Dashboard](https://github.com/kubernetes/dashboard) is a general-purpose, web-based UI for Kubernetes
-clusters. You can use the dashboard to manage the cluster, deploy and manage applications, and troubleshoot issues.
+clusters. The dashboard provides a rich variety of functionality by wrapping around the
+[kubectl](https://kubernetes.io/docs/tasks/tools/) CLI. You can use it to perform the following operations:
 
-Use the [Spectro Kubernetes Dashboard](../../integrations/spectro-k8s-dashboard.md) pack to add the Kubernetes dashboard
-to your cluster. The pack documentation page has instructions on how to use the pack.
+- List and manage Kubernetes cluster resources.
+- Deploy a containerized application to a host cluster.
+- Troubleshoot deployed applications and resources.
+
+<!-- prettier-ignore -->
+Use the <VersionedLink text="Spectro Kubernetes Dashboard" url="/integrations/packs/?pack=spectro-k8s-dashboard" /> pack to add the Kubernetes dashboard
+to your cluster. The pack documentation page has instructions on how to configure and use the dashboard.
+
+![Kubernetes dashboard login page](/integrations_spectro-k8s-dashboard_dashboard-page.webp)
diff --git a/docs/docs-content/integrations/k8s-dashboard.md b/docs/docs-content/integrations/k8s-dashboard.md
@@ -36,16 +36,16 @@ Dashboard on port 8080.
 <!-- prettier-ignore-end -->
 
 ```bash
-kubectl port-forward -namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
+kubectl port-forward --namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
 ```
 
 To access Kubernetes Dashboard, navigate to `https://localhost:8080` in a browser of your choice.
 
 From the Dashboard login page, run the following command from the terminal window to obtain the bearer token:
 
 ```bash
-kubectl -namespace kubernetes-dashboard describe secret  \
-$(kubectl -namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
+kubectl --namespace kubernetes-dashboard describe secret  \
+$(kubectl --namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
 ```
 
 The following example shows the command output with the token value.
@@ -115,15 +115,15 @@ Dashboard on port 8080.
 <!-- prettier-ignore-end -->
 
 ```bash
-kubectl port-forward -namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
+kubectl port-forward --namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
 ```
 
 To access Kubernetes Dashboard, navigate to `https://localhost:8080` in a browser of your choice.
 
 From the Dashboard login page, run the following command from the terminal window to obtain the bearer token:
 
 ```bash
-kubectl -namespace kubernetes-dashboard describe secret $(kubectl -namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
+kubectl --namespace kubernetes-dashboard describe secret $(kubectl --namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
 ```
 
 The following example shows the command output with the token value.
@@ -193,15 +193,15 @@ Dashboard on port 8080.
 <!-- prettier-ignore-end -->
 
 ```bash
-kubectl port-forward -namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
+kubectl port-forward --namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
 ```
 
 To access Kubernetes Dashboard, navigate to `https://localhost:8080` in a browser of your choice.
 
 From the Dashboard login page, run the following command from the terminal window to obtain the bearer token:
 
 ```bash
-kubectl -namespace kubernetes-dashboard describe secret $(kubectl -namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
+kubectl --namespace kubernetes-dashboard describe secret $(kubectl --namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
 ```
 
 The following example shows the command output with the token value.
@@ -267,15 +267,15 @@ When connected to the cluster remotely, run the following command to establish a
 Dashboard on port 80.
 
 ```bash
-kubectl port-forward -namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
+kubectl port-forward --namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
 ```
 
 To access Kubernetes Dashboard, navigate to `https://localhost:8080` in a browser of your choice.
 
 From the Dashboard login page, run the following command from the terminal window to obtain the bearer token:
 
 ```bash
-kubectl -namespace kubernetes-dashboard describe secret $(kubectl -namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
+kubectl --namespace kubernetes-dashboard describe secret $(kubectl --namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
 ```
 
 The following example shows the command output with the token value.
@@ -345,15 +345,15 @@ Dashboard on port 80.
 <!-- prettier-ignore-end -->
 
 ```bash
-kubectl port-forward -namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
+kubectl port-forward --namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
 ```
 
 To access Kubernetes Dashboard, navigate to `https://localhost:8080` in a browser of your choice.
 
 From the Dashboard login page, run the following command from the terminal window to obtain the bearer token:
 
 ```bash
-kubectl -namespace kubernetes-dashboard describe secret $(kubectl -namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
+kubectl --namespace kubernetes-dashboard describe secret $(kubectl --namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
 ```
 
 The following example shows the command output with the token value.
@@ -423,15 +423,15 @@ Dashboard on port 80.
 <!-- prettier-ignore-end -->
 
 ```bash
-kubectl port-forward -namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
+kubectl port-forward --namespace kubernetes-dashboard service/kubernetes-dashboard 8080:443
 ```
 
 To access Kubernetes Dashboard, navigate to `https://localhost:8080` in a browser of your choice.
 
 From the Dashboard login page, run the following command from the terminal window to obtain the bearer token:
 
 ```bash
-kubectl -namespace kubernetes-dashboard describe secret $(kubectl -namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
+kubectl --namespace kubernetes-dashboard describe secret $(kubectl --namespace kubernetes-dashboard get secret | grep kubernetes-dashboard-token | awk '{print $1}')
 ```
 
 The following example shows the command output with the token value.

diff --git a/static/assets/docs/images/integrations_spectro-k8s-dashboard_dashboard-page.webp b/static/assets/docs/images/integrations_spectro-k8s-dashboard_dashboard-page.webp