docs/release/scenarios/k8-nosdn-nofeature-noha/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5
   6 Abstract
   7 ========
   8
   9 This document compiles the release notes for the Danube release of
  10 OPNFV when using JOID as a deployment tool for Kubernetes.
  11
  12 Introduction
  13 ============
  14
  15 These notes provides release information for the use of joid as deployment
  16 tool for the Danube release of OPNFV for Kubernetes scenario.
  17
  18 The goal of the Danube release and this JOID based deployment process is
  19 to establish a lab ready platform accelerating further development
  20 of the OPNFV infrastructure for docker based workloads.
  21
  22 Carefully follow the installation-instructions which guides a user to deploy
  23 OPNFV using JOID which is based on MAAS and Juju.
  24
  25 Summary
  26 =======
  27
  28 Kubernetes is an open-source system for automating deployment, scaling, and
  29 management of containerized applications.
  30
  31 This is a Kubernetes cluster that includes logging, monitoring, and operational
  32 knowledge. It is comprised of the following components and features:
  33
  34 Kubernetes (automated deployment, operations, and scaling)
  35   TLS used for communication between nodes for security.
  36   A CNI plugin (e.g., Flannel)
  37   Optional Ingress Controller (on worker)
  38   Optional Dashboard addon (on master) including Heapster for cluster monitoring
  39
  40 EasyRSA
  41  Performs the role of a certificate authority serving self signed certificates
  42  to the requesting units of the cluster.
  43
  44 Etcd (distributed key value store)
  45  Minimum Three node cluster for reliability.
  46
  47 Danube release with the JOID deployment with Kubernetes will establish an
  48 OPNFV target system on a Pharos compliant lab infrastructure.
  49
  50 NOTE: Detailed information on how to install in your lab can be find in installation guide
  51 command to deploy lxd feature is:
  52
  53 #Kubernetes deployment
  54 ./deploy.sh -m kubernetes -f none -l custom -s nosdn
  55
  56 Using Kubernetes after Deployment
  57 =================================
  58
  59 Once you have finished installinf the JOID with Kubernetes you can use the
  60 following command to test the deployment.
  61
  62 To deploy 5 replicas of the microbot web application inside the Kubernetes
  63 cluster run the following command:
  64
  65 juju run-action kubernetes-worker/0 microbot replicas=5
  66
  67 This action performs the following steps:
  68
  69 It creates a deployment titled 'microbots' comprised of 5 replicas defined
  70 during the run of the action. It also creates a service named 'microbots'
  71 which binds an 'endpoint', using all 5 of the 'microbots' pods.
  72 Finally, it will create an ingress resource, which points at a
  73 xip.io domain to simulate a proper DNS service.
  74
  75 Running the packaged example
  76
  77 You can run a Juju action to create an example microbot web application:
  78
  79 $ juju run-action kubernetes-worker/0 microbot replicas=3
  80 Action queued with id: db7cc72b-5f35-4a4d-877c-284c4b776eb8
  81
  82 $ juju show-action-output db7cc72b-5f35-4a4d-877c-284c4b776eb8
  83 results:
  84   address: microbot.104.198.77.197.xip.io
  85 status: completed
  86 timing:
  87   completed: 2016-09-26 20:42:42 +0000 UTC
  88   enqueued: 2016-09-26 20:42:39 +0000 UTC
  89   started: 2016-09-26 20:42:41 +0000 UTC
  90 Note: Your FQDN will be different and contain the address of the cloud
  91 instance.
  92 At this point, you can inspect the cluster to observe the workload coming
  93 online.
  94
  95 Mor einformation on using Canonical distribution of kubernetes can be found
  96 at https://jujucharms.com/canonical-kubernetes/
  97
  98 Release Data
  99 ============
 100
 101 +--------------------------------------+--------------------------------------+
 102 | **Project**                          | JOID                                 |
 103 |                                      |                                      |
 104 +--------------------------------------+--------------------------------------+
 105 | **Repo/tag**                         | gerrit.opnfv.org/gerrit/joid.git     |
 106 |                                      | stable/danube                        |
 107 +--------------------------------------+--------------------------------------+
 108 | **Release designation**              | Danube release                       |
 109 |                                      |                                      |
 110 +--------------------------------------+--------------------------------------+
 111 | **Release date**                     | March 31 2017                        |
 112 |                                      |                                      |
 113 +--------------------------------------+--------------------------------------+
 114 | **Purpose of the delivery**          | Danube release                       |
 115 |                                      |                                      |
 116 +--------------------------------------+--------------------------------------+
 117
 118 Deliverables
 119 ------------
 120
 121 Software deliverables
 122 ~~~~~~~~~~~~~~~~~~~~~
 123 `JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git>`_
 124
 125 Known Limitations, Issues and Workarounds
 126 =========================================
 127
 128 Known issues
 129 ------------
 130
 131 **JIRA TICKETS:**
 132
 133 +--------------------------------------+--------------------------------------+
 134 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 135 |                                      |                                      |
 136 +--------------------------------------+--------------------------------------+
 137 | JIRA:                                | No support for yardstick and functest|
 138 |                                      | for Kubernetes scenarios  (OPNFV)    |
 139 +--------------------------------------+--------------------------------------+
 140 | JIRA:                                |                                      |
 141 +--------------------------------------+--------------------------------------+
 142
 143
 144 Scenario Releases
 145 =================
 146 Name:      joid-k8-nosdn-nofeature-noha
 147 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-nosdn-nofeature-noha-baremetal-daily-danube/
 148 Notes:
 149
 150 References
 151 ==========
 152
 153 Juju
 154 ----
 155 - `Juju Charm store <https://jujucharms.com/>`_
 156 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
 157 - `Canonical Distibuytion of Kubernetes <https://jujucharms.com/canonical-kubernetes/>`_
 158
 159 MAAS
 160 ----
 161 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
 162 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
 163
 164 JOID
 165 ----
 166 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
 167 - `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_
 168
 169 Kubernetes
 170 ----------
 171 - `Kubernetes Release artifacts <https://get.k8s.io/>`_
 172 - `Kubernetes documentation <https://kubernetes.io/>`_
 173