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>
9 This document compiles the release notes for the Fraser release of
10 OPNFV when using JOID as a deployment tool for Kubernetes with cancal CNI.
15 These notes provides release information for the use of joid as deployment
16 tool for the Fraser release of OPNFV for Kubernetes scenario.
18 The goal of the Fraser 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.
22 Carefully follow the installation-instructions which guides a user to deploy
23 OPNFV using JOID which is based on MAAS and Juju.
28 Kubernetes is an open-source system for automating deployment, scaling, and
29 management of containerized applications.
31 This is a Kubernetes cluster that includes logging, monitoring, and operational
32 knowledge. It is comprised of the following components and features:
34 Kubernetes (automated deployment, operations, and scaling)
35 TLS used for communication between nodes for security.
36 A CNI plugin (e.g., Canal)
37 Optional Ingress Controller (on worker)
38 Optional Dashboard addon (on master) including Heapster for cluster monitoring
41 Performs the role of a certificate authority serving self signed certificates
42 to the requesting units of the cluster.
44 Etcd (distributed key value store)
45 Minimum Three node cluster for reliability.
47 Fraser release with the JOID deployment with Kubernetes will establish an
48 OPNFV target system on a Pharos compliant lab infrastructure.
50 NOTE: Detailed information on how to install in your lab can be find in installation guide
51 command to deploy lxd feature is:
53 #Kubernetes deployment
54 ./deploy.sh -m kubernetes -f lb -l custom -s canal
56 Using Kubernetes after Deployment
57 =================================
59 Once you have finished installinf the JOID with Kubernetes you can use the
60 following command to test the deployment.
62 To deploy 5 replicas of the microbot web application inside the Kubernetes
63 cluster run the following command:
65 juju run-action kubernetes-worker/0 microbot replicas=5
67 This action performs the following steps:
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.
75 Running the packaged example
77 You can run a Juju action to create an example microbot web application:
79 $ juju run-action kubernetes-worker/0 microbot replicas=3
80 Action queued with id: db7cc72b-5f35-4a4d-877c-284c4b776eb8
82 $ juju show-action-output db7cc72b-5f35-4a4d-877c-284c4b776eb8
84 address: microbot.104.198.77.197.xip.io
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
92 At this point, you can inspect the cluster to observe the workload coming
95 Mor einformation on using Canonical distribution of kubernetes can be found
96 at https://jujucharms.com/canonical-kubernetes/
101 +--------------------------------------+--------------------------------------+
102 | **Project** | JOID |
104 +--------------------------------------+--------------------------------------+
105 | **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git |
107 +--------------------------------------+--------------------------------------+
108 | **Release designation** | Fraser release |
110 +--------------------------------------+--------------------------------------+
111 | **Release date** | April 27 2018 |
113 +--------------------------------------+--------------------------------------+
114 | **Purpose of the delivery** | Fraser release |
116 +--------------------------------------+--------------------------------------+
121 Software deliverables
122 ~~~~~~~~~~~~~~~~~~~~~
123 `JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git>`_
125 Known Limitations, Issues and Workarounds
126 =========================================
133 +--------------------------------------+--------------------------------------+
134 | **JIRA REFERENCE** | **SLOGAN** |
136 +--------------------------------------+--------------------------------------+
137 | JIRA: | No support for yardstick and functest|
138 | | for Kubernetes scenarios (OPNFV) |
139 +--------------------------------------+--------------------------------------+
141 +--------------------------------------+--------------------------------------+
146 Name: joid-k8-canal-lb-noha
147 Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-k8-canal-lb-noha-baremetal-daily-fraser/
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/>`_
161 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
162 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
166 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
167 - `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_
171 - `Kubernetes Release artifacts <https://get.k8s.io/>`_
172 - `Kubernetes documentation <https://kubernetes.io/>`_