Add standardized helm chart for log
[oom.git] / docs / oom_cloud_setup_guide.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. Copyright 2018 Amdocs, Bell Canada
4
5 .. figure:: oomLogoV2-medium.png
6    :align: right
7
8 .. _cloud-setup-guide-label:
9
10 OOM Cloud Setup Guide
11 #####################
12
13 OOM deploys and manages ONAP on a pre-established Kubernetes_ cluster - the
14 creation of this cluster is outside of the scope of the OOM project as there
15 are many options including public clouds with pre-established environments.
16 However, this guide includes instructions for how to create and use some of the
17 more popular environments which could be used to host ONAP. If creation of a
18 Kubernetes cluster is required, the life-cycle of this cluster is independent
19 of the life-cycle of the ONAP components themselves. Much like an OpenStack
20 environment, the Kubernetes environment may be used for an extended period of
21 time, possibly spanning multiple ONAP releases.
22
23 .. note::
24   Inclusion of a cloud technology or provider in this guide does not imply any
25   endorsement of this technology.
26
27 .. _Kubernetes: https://kubernetes.io/
28
29 The versions of Kubernetes that are supported by OOM are as follows:
30
31 .. table:: OOM Software Requirements
32
33   ==============  ==========  =====  =======  ========
34   Release         Kubernetes  Helm   kubectl  Docker
35   ==============  ==========  =====  =======  ========
36   amsterdam       1.7.x       2.3.x  1.7.x    1.12.x
37   beijing/master  1.8.5       2.7.x  1.8.5    1.12.x
38   ==============  ==========  =====  =======  ========
39
40 Minimum Hardware Requirements
41 =============================
42
43
44 Cloud Installation
45 ==================
46
47 #. OOM supports deployment on major public clouds. The following guides
48    provide instructions on how to deploy ONAP on these clouds:
49
50    - Microsoft Azure,
51    - Amazon AWS,
52    - Google GCD,
53    - VMware VIO,
54    - IBM, and
55    - Openstack
56
57 #. Alternatively, OOM can be deployed on a private set of physical hosts or VMs
58    (or even a combination of the two). The following guides describe how to
59    create a Kubernetes cluster with popular tools:
60
61    - Setting up Kubernetes with Rancher (recommended)
62    - Setting up Kubernetes with Kubeadm
63    - Setting up Kubernetes with Cloudify
64