update

Signed-off-by: Lee Calcote <[email protected]>
captain-Akshay · Mar 19, 2024 · 197c190 · 197c190
1 parent a5cf4ba
commit 197c190
Show file tree

Hide file tree

Showing 3 changed files with 101 additions and 80 deletions.
diff --git a/docs/_data/toc.yml b/docs/_data/toc.yml
@@ -1,4 +1,4 @@
-- title: 🗺 Overview
+- title: 🗺 Overview & Installation
   url: project/overview
   links:
   - title: FAQ
@@ -90,7 +90,7 @@
 #   links:
 #     - title: Meshery Playground
 #       url: features/playground
-- title: 📚 Guides (all)
+- title: 📚 Administrator's Guide
   url: guides
   links:
     # - title: Deploying Designs
@@ -141,9 +141,9 @@
           url: guides/troubleshooting/installation
         - title: Meshery Operator 
           url: guides/troubleshooting/meshery-operator-meshsync
-        - title: Meshery Server 
+        - title: Meshery Server asdf
           url: guides/troubleshooting/meshery-server
-    - title: Tutorials ↆ
+    - title: 🧑‍🔬 Tutorials ↆ
       url: guides/tutorials
       children:
       - title: Exploring Kubernetes Pods
@@ -153,7 +153,7 @@
       children:
         - title: Meshery CLI
           url: guides/upgrade#upgrading-meshery-cli
-- title: ⚙️ Tasks (all)
+- title: ⚙️ Tasks & Operations (User Guide)
   url: tasks
   links:
     - title: Infrastructure Management

diff --git a/docs/pages/guides/tutorials/kubernetes-pods.md b/docs/pages/guides/tutorials/kubernetes-pods.md
@@ -12,61 +12,69 @@ list: include
 abstract: "Explore Kubernetes Pods using Meshery Playground, an interactive live cluster environment, through a series of hands-on excercises."
 ---
 
-### Introduction:
+### Introduction
+
 In this tutorial, we'll learn the fundamentals of Pods, the smallest deployable units in the Kubernetes ecosystem. Using Meshery Playground, an interactive live cluster environment, we'll perform hands-on labs to gain practical experience in deploying, managing, and understanding some of the concepts related to Pods.
 
-> **_NOTE:_**  This tutorial demonstrates stand alone pods, i.e. pods not managed through deployments.
+> **_NOTE:_** This tutorial demonstrates stand alone pods, i.e. pods not managed through deployments.
+
+### Prerequisites
 
-### Prerequisites:
 - Basic understanding of containerization and Kubernetes concepts.
 - Access to the _Meshery Playground_. If you don't have an account, sign up at [Meshery Playground](https://meshery.layer5.io/).
 
-### Lab Scenario:
+### Lab Scenario
+
 Deploy and explore an NGINX pod in a Kubernetes cluster. Additionally, expose the pod through a service.
 
-### Objective:
+### Objective
+
 Learn how to create, manage, and explore _Kubernetes Pods and Services_ within the context of a microservices architecture.
 
-### Steps:
+### Steps
 
 #### Access Meshery Playground
-   - Log in to the [Meshery Playground](https://meshery.layer5.io/) using your credentials. On successful login, you should be at the dashboard. Press the **X** on the _Where do you want to start?_ popup to close it (if required).
-   - Click **Explore** in the Cloud Native Playground tile to navigate to _MeshMap_.
 
-> **_NOTE:_**  MeshMap is still in beta.
+- Log in to the [Meshery Playground](https://meshery.layer5.io/) using your credentials. On successful login, you should be at the dashboard. Press the **X** on the _Where do you want to start?_ popup to close it (if required).
+- Click **Explore** in the Cloud Native Playground tile to navigate to _MeshMap_.
+
+> **_NOTE:_** MeshMap is still in beta.
 
 #### Create a simple stand-alone Pod
-   1. In the MeshMap screen, rename the design from _Untitled Design_ to a name of choice. This helps in identifying the design later easily.
-   2. Click **Components** tab.
-   3. Search for **Pod** in the list of components.
-      ![](./screenshots/2024-02-22_18-20.png)
-   4. Scroll down, _select and drag_ the **Pod** component from the search results to the design canvas on the right.
-      ![](./screenshots/2024-02-22_18-32.png)
-   5. You should now have a pod in the design canvas for further configuration. It has a default name assigned to it.
-      Click the pod component to load the configuration modal.
-   6. Rename the pod, if necessary.
-      ![](./screenshots/2024-02-22_18-35.png)
-
+
+1. In the MeshMap screen, rename the design from _Untitled Design_ to a name of choice. This helps in identifying the design later easily.
+2. Click **Components** tab.
+3. Search for **Pod** in the list of components.
+    ![](./screenshots/2024-02-22_18-20.png)
+4. Scroll down, _select and drag_ the **Pod** component from the search results to the design canvas on the right.
+    ![](./screenshots/2024-02-22_18-32.png)
+5. You should now have a pod in the design canvas for further configuration. It has a default name assigned to it.
+    Click the pod component to load the configuration modal.
+6. Rename the pod, if necessary.
+    ![](./screenshots/2024-02-22_18-35.png)
+
 #### Add a container to the Pod
+
 The pod at this stage does not have a container, so we will add one. This is similar to defining the containers in the _spec:_ section of a YAML file. For this hands-on we will make some basic and necessary configurations only.
 
-   7. Scroll down within the Pod configuration modal to the Containers section. Click **+** to add a container.
-      ![](./screenshots/2024-02-23_11-54.png)
-   8. Expand **Containers-0**.
-      ![](./screenshots/2024-02-23_11-54_1.png)
-   9. Next, fill out some of the required container specifications. Start by entering the container image, we will use _nginx:latest_ for this exercise.
-   10. Give the container a name.
-       ![](./screenshots/2024-02-23_11-57.png) 
-   11. Additionally, we will also give it a label. This will server many advantages later in this exercise. To do so, click the label icon on the modal.
-   12. Click **+** next to _Labels_. 
-   13. Set any label of choice. Preferably, give a unique label since the playground is a shared environment.
-       ![](./screenshots/2024-02-25_18-18.png)
-   12. Click outside to close the modal.
+7. Scroll down within the Pod configuration modal to the Containers section. Click **+** to add a container.
+    ![](./screenshots/2024-02-23_11-54.png)
+8. Expand **Containers-0**.
+    ![](./screenshots/2024-02-23_11-54_1.png)
+9. Next, fill out some of the required container specifications. Start by entering the container image, we will use _nginx:latest_ for this exercise.
+10. Give the container a name.
+    ![](./screenshots/2024-02-23_11-57.png)
+11. Additionally, we will also give it a label. This will server many advantages later in this exercise. To do so, click the label icon on the modal.
+12. Click **+** next to _Labels_.
+13. Set any label of choice. Preferably, give a unique label since the playground is a shared environment.
+    ![](./screenshots/2024-02-25_18-18.png)
+14. Click outside to close the modal.
 
 #### Validating and Deploying the Pod
-The next step in this process is to validate the design, after which we can deploy it. 
 
-To do this, click **Validate** on the top. 
+The next step in this process is to validate the design, after which we can deploy it.
+
+To do this, click **Validate** on the top.
 ![](./screenshots/2024-02-23_19-52.png)
 
 This should show a pop-up with details such as the number of components, annotations and errors (if any).
@@ -78,72 +86,82 @@ Ensure there are no errors before deploying. To deploy, click the **Deploy** (1)
 You should see a few alerts on the bottom right about the deployment.
 
 #### Visualizing the Pod
+
 To view the resources deployed we will use the **Visualize** section of the _MeshMap_. A view is created with necessary filters to show the relevant resources.
- 1. Click **Visualize** to begin.
- 2. Give the view a name (rename).
- 3. Click the filter icon.
- 4. Choose appropriate filters, for this hands-on choose the label that was set earlier during the pod creation. This helps in showing limited resources in the view.
-![](./screenshots/2024-02-25_18-22.png)
+
+1.  Click **Visualize** to begin.
+2.  Give the view a name (rename).
+3.  Click the filter icon.
+4.  Choose appropriate filters, for this hands-on choose the label that was set earlier during the pod creation. This helps in showing limited resources in the view.
+    ![](./screenshots/2024-02-25_18-22.png)
 
 Click the filter icon again to close. This should show a filtered view with only your resources something similar to the screenshot below:
 ![](./screenshots/2024-02-25_18-25.png)
 
 #### Pod state and information
+
 Select the **Details** tab and select the pod from the view to view details about the pod.
 The details tab shows the following:
- - Pod state, a green check means **running**.
- - The namespace where the pod is running.
- - Image details of the container in the pod like image tag and name.
- - It also shows the number of restarts and uptime.
+
+- Pod state, a green check means **running**.
+- The namespace where the pod is running.
+- Image details of the container in the pod like image tag and name.
+- It also shows the number of restarts and uptime.
 
 ![](./screenshots/2024-02-25_17-38.png)
 
 #### Connecting to the Pods / containers
+
 Meshery Playground provides terminal capabilities to connect to the container(s) and stream logs. The following steps demonstrate this.
 
- 1. Select the **Pod** (or container). If you have multiple containers in a pod, select a container.
- 2. Select the **Actions** tab to the right.
- 3. Click **Open Interactive Terminal**.
-![](./screenshots/2024-02-28_11-05.png)
-This displays the terminal on the screen.
-![](./screenshots/2024-02-28_11-10.png)
- 4. To view streaming logs, click **Stream Container Logs** to the right and an additional logs view is added to the terminal window.
-![](./screenshots/2024-02-28_11-11.png)
+1.  Select the **Pod** (or container). If you have multiple containers in a pod, select a container.
+2.  Select the **Actions** tab to the right.
+3.  Click **Open Interactive Terminal**.
+    ![](./screenshots/2024-02-28_11-05.png)
+    This displays the terminal on the screen.
+    ![](./screenshots/2024-02-28_11-10.png)
+4.  To view streaming logs, click **Stream Container Logs** to the right and an additional logs view is added to the terminal window.
+    ![](./screenshots/2024-02-28_11-11.png)
 
 #### Exposing a Pod with a Service
-> **_NOTE:_**  As of this writing, Meshery Playground supports only NodePort at the moment.
-
- 1. Go back to the _Design_ view.
- 2. From **Components** search for _service_ and the drag the service component to the design canvas.
- 3. Click the _service_ component to load the configuration modal.
-![](./screenshots/2024-02-28_11-33.png)
- 4. Rename it if required.
- 5. Change _Type_ to **NodePort** for this tutorial.
- ![](./screenshots/2024-02-28_11-35.png)
- 6. Click **+** to add a Port.
- 7. Expand the **Ports-0** service port to make changes.
- ![](./screenshots/2024-02-28_11-37.png)
- 8. For this tutorial we set the **Target Port** value to 80.
- 9. We also set the **Port** value to 80.
- ![](./screenshots/2024-02-28_11-45.png)
- 10. Click **+** next to Selector and add the key value pair **app:9870**. This is the same pair that is used as label in the Pod.
- ![](./screenshots/2024-02-28_11-48.png)
- 11. Finally label this service too, with the same key value pair. This also helps in filtering resources specific to us in the Visualize screen.
- ![](./screenshots/2024-02-28_11-53.png)
- 12. Move your mouse over the service component until you see the green dots on all four sides. Move your mouse over one of the green dots to reveal an arrow, then click the arrow. Select **Network** option, and then move your mouse to the pod to create the _relationship_. It should look similar to the screenshot below:
- ![](./screenshots/2024-02-29_20-37.png) 
- 12. Validate the design. Click **Validate** from the top menu to do so.
+
+> **_NOTE:_** As of this writing, Meshery Playground supports only NodePort at the moment.
+
+1.  Go back to the _Design_ view.
+2.  From **Components** search for _service_ and the drag the service component to the design canvas.
+3.  Click the _service_ component to load the configuration modal.
+    ![](./screenshots/2024-02-28_11-33.png)
+4.  Rename it if required.
+5.  Change _Type_ to **NodePort** for this tutorial.
+    ![](./screenshots/2024-02-28_11-35.png)
+6.  Click **+** to add a Port.
+7.  Expand the **Ports-0** service port to make changes.
+    ![](./screenshots/2024-02-28_11-37.png)
+8.  For this tutorial we set the **Target Port** value to 80.
+9.  We also set the **Port** value to 80.
+    ![](./screenshots/2024-02-28_11-45.png)
+10. Click **+** next to Selector and add the key value pair **app:9870**. This is the same pair that is used as label in the Pod.
+    ![](./screenshots/2024-02-28_11-48.png)
+11. Finally label this service too, with the same key value pair. This also helps in filtering resources specific to us in the Visualize screen.
+    ![](./screenshots/2024-02-28_11-53.png)
+12. Move your mouse over the service component until you see the green dots on all four sides. Move your mouse over one of the green dots to reveal an arrow, then click the arrow. Select **Network** option, and then move your mouse to the pod to create the _relationship_. It should look similar to the screenshot below:
+    ![](./screenshots/2024-02-29_20-37.png)
+13. Validate the design. Click **Validate** from the top menu to do so.
 
 #### Updating the deployment
+
 In order to apply the updated design (which contains a service now), we must undeploy and deploy the design.
 
- - Select **Undeploy** and click **Undeploy** again.
- - To deploy the updated components, select **Deploy** and click **Deploy**.
+- Select **Undeploy** and click **Undeploy** again.
+- To deploy the updated components, select **Deploy** and click **Deploy**.
 
 #### Deleting and Recreating Pods
+
 To delete the resources such as Pods, use the **Undeploy** option from the _Design_ view.
 
 To recreate, use the **Deploy** option.
 
 ### Conclusion
+
 Congratulations! You've successfully completed the lab on exploring Kubernetes Pods using Meshery Playground. This hands-on experience should have provided valuable insights into the deployment, management, and interaction with Pods in a Kubernetes environment. Continue exploring more scenarios in the Meshery Playground to enhance your skills.
+
diff --git a/docs/pages/reference/error-codes.md b/docs/pages/reference/error-codes.md
@@ -22,6 +22,9 @@ p.error-details {
     text-wrap: wrap;
     width:85%
 }
+td {
+  vertical-align: middle;
+}
 .tbl-head-row{
   background-color:#F2F2F2;
 }