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