Merge branch 'master' of github.com:clearlinux/clear-linux-documentation into rtd-theme

source/clear-linux/tutorials/redis.rst

@@ -0,0 +1,215 @@
+.. _redis:
+
+Run Redis on |CL-ATTR|
+######################
+
+Redis is an in-memory key:value store designed for quick lookups, accessible
+over the network. In this tutorial, you'll install redis and launch a
+redis-server on |CL|, plus learn a few basic redis commands. We also invite
+you to pull our `Clear Linux Redis instance`_ on dockerhub\* for application
+or infrastructure development.
+
+While the `redis data structure store`_ can serve as a NoSQL database for a Web application, it's also easy to integrate in an existing stack. For example, you could use the Redis caching layer for real-time responses on a leaderboard in a gaming app. Redis offers many client libraries with language-specific bindings for Python, Perl, Ruby, and more.
+
+.. contents::
+   :local:
+   :depth: 1
+
+Prerequisites
+*************
+* Install the `redis-native` bundle in |CL|
+* Install the `containers-basic` bundle in |CL| (only required in Example 2)
+
+Install the redis bundle
+************************
+
+In |CL|, find redis in the `redis-native` bundle.
+
+#. Open a Terminal and login as an administrative user.
+
+#. Add :file:`redis-native`.
+
+.. code-block:: bash
+
+   sudo swupd bundle-add redis-native
+
+.. note::
+
+   If the bundle already exists, no action is required.
+
+Start the redis-server
+**********************
+
+A `systemd` service unit is available to control the redis server.
+By default, redis runs on port 6379.
+
+#. Start the service.
+
+   .. code-block:: bash
+
+      systemctl start redis
+
+   .. note::
+
+      To stop redis run :command:`systemctl stop redis`.
+
+#. Assure the service is running.
+
+   .. code-block:: bash
+
+      systemctl status redis
+
+#. Verify the redis-server sends a reply.
+
+   .. code-block:: bash
+
+      redis-cli ping
+
+   .. note::
+
+      Expected output: `PONG`.
+
+#. Optional: If you wish to apply advanced configuration, copy the
+   `redis.conf` into /etc/ directory.
+
+   .. code-block:: bash
+
+      sudo cp /usr/share/defaults/etc/redis.conf /etc/
+
+The redis-server is now ready to use on |CL|. Try some examples below.
+
+Example 1: Use the redis-cli and try commands
+*********************************************
+
+One advantage of redis over other NoSQL databases is that developers can
+easily access data structures like lists, sets, sorted sets, strings, and
+hashes using collection operations commands similar to those found in many
+programming languages. These exercises are inspired by `try redis io`_.
+
+After your `redis-server` is running, try some basic commands.
+
+#. Enter the `redis-cli`. It provides syntax suggestions as you type.
+
+   .. code-block:: bash
+
+      redis-cli
+
+#. SET key to hold string value. In the set create connections and increment.
+
+   .. code-block:: bash
+
+      SET server:name "clearlinux"
+
+   .. code-block:: bash
+
+      MGET server:name
+
+   .. note::
+      If the key does not exist or hold a key value, `nil` is returned.
+
+   .. code-block:: bash
+
+      SET connections 100
+
+   .. code-block:: bash
+
+      INCR connections
+
+   .. code-block:: bash
+
+      INCR connections
+
+   .. code-block:: bash
+
+      DEL connections
+
+#. Create a `friends` list and insert new values at the end of the list.
+
+   .. code-block:: bash
+
+      RPUSH friends "Deb"
+
+   .. code-block:: bash
+
+      RPUSH friends "David"
+
+   .. code-block:: bash
+
+      RPUSH friends "Mary"
+
+#. Modify `friends` list, using a common slice method with a 0-index.
+
+   .. code-block:: bash
+
+      LRANGE friends 0 1
+
+   .. code-block:: bash
+
+      LLEN friends
+
+   .. code-block:: bash
+
+      LPOP friends
+
+   .. code-block:: bash
+
+      RPOP friends
+
+   .. code-block:: bash
+
+      LLEN friends
+
+#. Consider using a hash, a very useful data type, which maps string fields
+   and string values, offering multiple lookup methods.
+
+   Enter many user key:values with `HMSET`. Then try `HGET` and `HGETALL`.
+
+   .. code-block:: bash
+
+      HMSET user:1000 name "Robert Noyce" password "SuperEngi9eer" email "robert.noyce@intel.com"
+
+   .. code-block:: bash
+
+      HGET user:1000 name
+
+   .. code-block:: bash
+
+      HGET user:1000 email
+
+   .. code-block:: bash
+
+      HGETALL user:1000
+
+
+Example 2: Run the |CL| redis docker image
+******************************************
+
+We also provide a `Clear Linux Redis instance`_, which is
+updated continuously and maintained by |CL| development.
+
+.. code-block:: bash
+
+   sudo swupd bundle-add containers-basic
+
+.. code-block:: bash
+
+   sudo systemctl start docker
+
+.. code-block:: bash
+
+   sudo -E docker pull clearlinux/redis
+
+Next Steps
+**********
+
+* Follow the `redis quickstart tutorial`_ to expand potential uses.
+
+* Learn to :ref:`docker`.
+
+.. _try redis io: https://try.redis.io/
+
+.. _Clear Linux Redis instance: https://hub.docker.com/r/clearlinux/redis
+
+.. _redis data structure store: https://redis.io/
+
+.. _redis quickstart tutorial: https://redis.io/topics/quickstart

source/guides/guides.rst

@@ -4,7 +4,10 @@ Guides
 ######
 
 The following guides provide step-by-step instructions on using |CL|.
-Note: As of 22 May 2019 :file:`mixin` is no longer supported.
+
+.. note::
+
+   As of 22 May 2019 :file:`mixin` is no longer supported.
 
 Maintenance
 ===========

source/tutorials/kubernetes/kubernetes.rst

@@ -150,12 +150,30 @@ Configure and run CRI-O + kata-runtime
        sudo systemctl daemon-reload
        sudo systemctl restart crio
 
-#.  Initialize the master control plane with the command:
+#.  Initialize the master control plane with the command below and follow the displayed instructions to set up `kubectl`:
 
     .. code-block:: bash
 
        sudo kubeadm init --cri-socket=/run/crio/crio.sock
 
+#.  Register kata-runtime as a RuntimeClass handler:
+
+    .. code-block:: bash
+
+       cat << EOF | kubectl apply -f -
+       kind: RuntimeClass
+       apiVersion: node.k8s.io/v1beta1
+       metadata:
+           name: native
+       handler: runc
+       ---
+       kind: RuntimeClass
+       apiVersion: node.k8s.io/v1beta1
+       metadata:
+           name: kata-containers
+       handler: kata
+       EOF
+
 Install pod network add-on
 **************************
 
@@ -163,32 +181,6 @@ You must choose and install a `pod network add-on`_ to allow your pods to
 communicate. Check whether or not your add-on requires special flags when you
 initialize the master control plane.
 
-The CRI-O default plugin_dir is :file:`/opt/cni/bin`. This must be a
-writable directory because third-party networking add-ons will install
-themselves there.
-
-.. note::
-
-   CNI plugins provided by |CL| are installed as part of *cloud-native-basic*
-   in :file:`/usr/libexec/cni/` and are currently *not* found by CRI-O by
-   default. These separate directories are required because `swupd` controls
-   the content of :file:`/usr` and leaves :file:`/opt` unchanged.
-
-When using third-party network add-ons that rely on those plugins, such as
-Weave or Flannel do, make them available by creating symlinks:
-
-.. code-block:: bash
-
-   sudo mkdir -p /opt/cni/bin
-
-.. code-block:: bash
-
-   for i in /usr/libexec/cni/*; do sudo ln -sf $i /opt/cni/bin; done
-
-**Notes about Weave Net add-on**
-
-The Weave Net add-on works by default when the above configuration is done.
-
 **Notes about flannel add-on**
 
 If you choose the `flannel` add-on, then you must add the following to the
@@ -198,7 +190,7 @@ If you choose the `flannel` add-on, then you must add the following to the
 
    --pod-network-cidr 10.244.0.0/16
 
-If you are using CRI-O and `flannel` and you want to use Kata Containers,
+Furthermore, if you are using CRI-O and `flannel` and you want to use Kata Containers,
 edit the :file:`/etc/crio/crio.conf` file to add:
 
 ..  code-block:: bash

source/tutorials/tutorials.rst

@@ -27,3 +27,4 @@ Explore our tutorials to discover what you can do with |CL|!
    yubikey-u2f
    nvidia
    dars
+   redis