diff --git a/source/tutorials/kubernetes/kubernetes.rst b/source/tutorials/kubernetes/kubernetes.rst index ad9d10d9..f5d40a4d 100644 --- a/source/tutorials/kubernetes/kubernetes.rst +++ b/source/tutorials/kubernetes/kubernetes.rst @@ -7,20 +7,24 @@ This tutorial describes how to install, configure, and run the `Kubernetes container orchestration system`_ on |CL-ATTR| using CRI+O and kata-runtime. -Kubernetes\* is an open source system for automating deployment, scaling, and +.. contents:: + :local: + :depth: 1 + +Description +*********** + +Kubernetes is an open source system for automating deployment, scaling, and management of containerized applications. It groups containers that make up an application into logical units for easy management and discovery. Kata Containers\* kata-runtime adheres to -:abbr:`OCI (Open Container Initiative*)` guidelines and work seamlessly with -Kubernetes. `Kata Containers`_ provide strong isolation for untrusted +:abbr:`OCI (Open Container Initiative*)` guidelines and works seamlessly with +Kubernetes. `Kata Containers`_ provides strong isolation for untrusted workloads or multi-tenant scenarios. Kata Containers can be -allocated on a per-pod basis so you can mix and match both on the same host +allocated on a per-pod basis, so you can mix and match both on the same host to suit your needs. -.. contents:: :local: - :depth: 1 - Prerequisites ************* @@ -267,9 +271,10 @@ Proxy configuration (optional) ****************************** If you use a proxy server, you must set your proxy environment variables and -create an appropriate proxy configuration file for both CRI-O services. Consult your IT department if you are behind a corporate proxy for -the appropriate values. Ensure that your local IP is **explicitly included** -in the environment variable *NO_PROXY*. (Setting *localhost* is not enough.) +create an appropriate proxy configuration file for both CRI-O services. Consult +your IT department if you are behind a corporate proxy for the appropriate +values. Ensure that your local IP is **explicitly included** in the environment +variable *NO_PROXY*. (Setting *localhost* is not enough.) If you have already set your proxy environment variables, run the following commands as a shell script to configure all of these services in one step: @@ -304,7 +309,8 @@ Troubleshooting For example: 100.200.50.20 myhost - Use the commands :command:`hostname` and :command:`hostname -I` to retrieve them. + Use the commands :command:`hostname` and :command:`hostname -I` + to retrieve them. * Images cannot be pulled. @@ -343,8 +349,8 @@ Troubleshooting sudo touch profile - #. With a preferred editor, open `profile`, and enter your proxy settings. - Example shown below. + #. With your preferred editor, open `profile`, and enter your proxy settings. + An example is shown below. .. code-block:: bash @@ -359,7 +365,8 @@ Troubleshooting #. Save and exit the `profile`. - #. Run: + #. Update your system's environment settings by executing the following + command: .. code-block:: bash @@ -383,6 +390,8 @@ Troubleshooting /* Kubernetes with CRI-O + kata-runtime */ sudo -E kubeadm init --cri-socket=/run/crio/crio.sock + + .. _Kubernetes container orchestration system: https://kubernetes.io/ .. _Kata Containers: https://katacontainers.io/