@kui-shell/plugin-tutorials/samples/@tutorials/kubernetes-basics/tutorial.json

IBM Cloud shell plugin for tutorials

{
  "time": "5 minutes",
  "skills": ["Learning the Ropes", "Kubernetes"],
  "steps": [
    {
      "heading": "Introduction",
      "content": "This tutorial introduces you to the basics of Kubernetes.",
      "transition": "next",
      "renderingHints": "fifty-fifty",
      "extras": {
        "learnMore": {
          "title": "Duration",
          "doc": "It should take you about **5 minutes** to walk through this interactive tutorial."
        },
        "alternate": [
          {
            "command": "play @tutorials/ibmcloud",
            "doc": "Learn more about using the IBM Cloud"
          }
        ]
      }
    },
    {
      "heading": "Resources as YAML",
      "content": "In Kubernetes, resources are described by YAML files.",
      "transition": "next",
      "extras": {
        "learnMore": {
          "doc": "- You need not use Kui's built-in editor. You may use your favorite code editor, and continue to leverage Kui for visual assistance."
        },
        "nextSteps": [
          {
            "display": "open pod.yaml",
            "command": "open plugins/plugin-k8s/tests/data/k8s/headless/pod.yaml",
            "doc": "View a sample resource description"
          }
        ]
      }
    },
    {
      "heading": "Deploying Resources",
      "content": "When you are ready to deploy a Kubernetes resource, you may use the **`kubectl create`** command. This will start an asynchronous activity to deploy all of the resources described by your YAML file.",
      "transition": "next",
      "renderingHints": "fifty-fifty",
      "extras": {
        "learnMore": {
          "doc": "- You may also apply updates to a deployed resource by using the **`kubectl apply`** command"
        },
        "nextSteps": [
          {
            "display": "kubectl create",
            "command": "kubectl create -f https://raw.githubusercontent.com/kubernetes/examples/master/staging/pod",
            "doc": "Kui will present you with a table that shows the ongoing status of the deployment."
          }
        ]
      }
    },
    {
      "heading": "Listing Resources",
      "content": "You may list deployed resources using the **kubectl get** command.",
      "transition": "next",
      "renderingHints": "fifty-fifty",
      "extras": {
        "learnMore": {
          "doc": "- Try adding **`--watch`** or **`-w`** to the suggested commands on the right. This will tell Kui to have the table show the **ongoing** status of each resource."
        },
        "nextSteps": [
          {
            "command": "kubectl get pods",
            "doc": "Show the **current** status of each **pod**."
          },
          {
            "command": "kubectl get ns",
            "doc": "Same, but for each **namespace**."
          }
        ]
      }
    },
    {
      "heading": "Deleting Resources",
      "content": "Once deployed, you may delete a resource by using the **kubectl delete** command.",
      "transition": "next",
      "renderingHints": "fifty-fifty",
      "extras": {
        "nextSteps": [
          {
            "display": "kubectl delete",
            "command": "kubectl delete -f https://raw.githubusercontent.com/kubernetes/examples/master/staging/pod",
            "doc": "Kui will present you with a table that shows the ongoing status of the deletion."
          }
        ]
      }
    },
    {
      "heading": "Conclusion",
      "content": "Congraulations, you have completed the Kubernetes Basics tutorial. Next, consider trying one of the other tutorials on the right.",
      "renderingHints": "fifty-fifty",
      "extras": {
        "nextSteps": [
          {
            "command": "play @tutorials/ibmcloud",
            "doc": "Learn more about using the IBM Cloud."
          },
          { "command": "tutorials", "doc": "Choose your own adventure!" }
        ]
      }
    }
  ]
}