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 Ceph based storage solution ( LXD container)
38 Optional Ingress Controller (on worker)
39 Optional Dashboard addon (on master) including Heapster for cluster monitoring
42 Performs the role of a certificate authority serving self signed certificates
43 to the requesting units of the cluster.
45 Etcd (distributed key value store)
46 Minimum Three node cluster for reliability.
48 Fraser release with the JOID deployment with Kubernetes will establish an
49 OPNFV target system on a Pharos compliant lab infrastructure.
51 NOTE: Detailed information on how to install in your lab can be find in installation guide
52 command to deploy lxd feature is:
54 #Kubernetes deployment
55 ./deploy.sh -m kubernetes -f lb,ceph -l custom
57 Using Kubernetes after Deployment
58 =================================
60 Once you have finished installinf the JOID with Kubernetes you can use the
61 following command to test the deployment.
63 To deploy 5 replicas of the microbot web application inside the Kubernetes
64 cluster run the following command:
66 juju run-action kubernetes-worker/0 microbot replicas=5
68 This action performs the following steps:
70 It creates a deployment titled 'microbots' comprised of 5 replicas defined
71 during the run of the action. It also creates a service named 'microbots'
72 which binds an 'endpoint', using all 5 of the 'microbots' pods.
73 Finally, it will create an ingress resource, which points at a
74 xip.io domain to simulate a proper DNS service.
76 Running the packaged example
78 You can run a Juju action to create an example microbot web application:
80 $ juju run-action kubernetes-worker/0 microbot replicas=3
81 Action queued with id: db7cc72b-5f35-4a4d-877c-284c4b776eb8
83 $ juju show-action-output db7cc72b-5f35-4a4d-877c-284c4b776eb8
85 address: microbot.104.198.77.197.xip.io
88 completed: 2016-09-26 20:42:42 +0000 UTC
89 enqueued: 2016-09-26 20:42:39 +0000 UTC
90 started: 2016-09-26 20:42:41 +0000 UTC
91 Note: Your FQDN will be different and contain the address of the cloud
93 At this point, you can inspect the cluster to observe the workload coming
96 Mor einformation on using Canonical distribution of kubernetes can be found
97 at https://jujucharms.com/canonical-kubernetes/
102 +--------------------------------------+--------------------------------------+
103 | **Project** | JOID |
105 +--------------------------------------+--------------------------------------+
106 | **Repo/tag** | gerrit.opnfv.org/gerrit/joid.git |
108 +--------------------------------------+--------------------------------------+
109 | **Release designation** | Fraser release |
111 +--------------------------------------+--------------------------------------+
112 | **Release date** | April 27 2018 |
114 +--------------------------------------+--------------------------------------+
115 | **Purpose of the delivery** | Fraser release |
117 +--------------------------------------+--------------------------------------+
122 Software deliverables
123 ~~~~~~~~~~~~~~~~~~~~~
124 `JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git>`_
126 Known Limitations, Issues and Workarounds
127 =========================================
134 +--------------------------------------+--------------------------------------+
135 | **JIRA REFERENCE** | **SLOGAN** |
137 +--------------------------------------+--------------------------------------+
138 | JIRA: | No support for yardstick and functest|
139 | | for Kubernetes scenarios (OPNFV) |
140 +--------------------------------------+--------------------------------------+
142 +--------------------------------------+--------------------------------------+
147 Name: joid-k8-nosdn-lb_ceph-noha
148 Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-k8-nosdn-lb_ceph-noha-baremetal-daily-fraser/
156 - `Juju Charm store <https://jujucharms.com/>`_
157 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
158 - `Canonical Distibuytion of Kubernetes <https://jujucharms.com/canonical-kubernetes/>`_
162 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
163 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
167 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
168 - `OPNFV JOID Get Started <https://wiki.opnfv.org/display/joid/JOID+Get+Started>`_
172 - `Kubernetes Release artifacts <https://get.k8s.io/>`_
173 - `Kubernetes documentation <https://kubernetes.io/>`_