[DOC] ServiceMesh documentation
[oom.git] / docs / sections / guides / infra_guides / oom_infra_setup.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0
2 .. International License.
3 .. http://creativecommons.org/licenses/by/4.0
4 .. Copyright (C) 2022 Nordix Foundation
5
6 .. Links
7 .. _Kubernetes: https://kubernetes.io/
8 .. _Kubernetes best practices: https://kubernetes.io/docs/setup/best-practices/cluster-large/
9 .. _kubelet confg guide: https://kubernetes.io/docs/reference/command-line-tools-reference/kubelet/
10
11 .. _oom_infra_setup_guide:
12
13 OOM Infrastructure Guide
14 ########################
15
16 .. figure:: ../../resources/images/oom_logo/oomLogoV2-medium.png
17    :align: right
18
19 OOM deploys and manages ONAP on a pre-established Kubernetes_ cluster - the
20 creation of this cluster is outside of the scope of the OOM project as there
21 are many options including public clouds with pre-established environments.
22 If creation of a Kubernetes cluster is required, the life-cycle of this
23 cluster is independent of the life-cycle of the ONAP components themselves.
24
25 .. rubric::  Minimum Hardware Configuration
26
27 Some recommended hardware requirements are provided below. Note that this is for a
28 full ONAP deployment (all components).
29
30 .. table:: OOM Hardware Requirements
31
32   =====  =====  ======  ====================
33   RAM    HD     vCores  Ports
34   =====  =====  ======  ====================
35   224GB  160GB  112     0.0.0.0/0 (all open)
36   =====  =====  ======  ====================
37
38 Customizing ONAP to deploy only components that are needed will drastically reduce these requirements.
39 See the :ref:`OOM customized deployment<oom_customize_overrides>` section for more details.
40
41 .. note::
42     | Kubernetes supports a maximum of 110 pods per node - this can be overcome by modifying your kubelet config.
43     | See the `kubelet confg guide`_ for more information.
44
45     | The use of many small nodes is preferred over a few larger nodes (for example 14 x 16GB - 8 vCores each).
46
47     | OOM can be deployed on a private set of physical hosts or VMs (or even a combination of the two).
48
49 .. rubric:: Software Requirements
50
51 The versions of software that are supported by OOM are as follows:
52
53 .. _versions_table:
54
55 .. table:: OOM Software Requirements (base)
56
57   ==============     ===========  =======  ========  ========  ============  =======
58   Release            Kubernetes   Helm     kubectl   Docker    Cert-Manager  Strimzi
59   ==============     ===========  =======  ========  ========  ============  =======
60   Jakarta            1.22.4       3.6.3    1.22.4    20.10.x   1.8.0         0.28.0
61   Kohn               1.23.8       3.8.2    1.23.8    20.10.x   1.8.0         0.32.0
62   ==============     ===========  =======  ========  ========  ============  =======
63
64 .. table:: OOM Software Requirements (optional)
65
66   ==============     =================  ======
67   Release            Prometheus Stack   Istio
68   ==============     =================  ======
69   Jakarta            35.x               ---
70   Kohn               35.x               1.15.1
71   ==============     =================  ======
72
73
74 .. toctree::
75   :hidden:
76
77   oom_base_config_setup.rst
78   oom_base_optional_addons.rst
79   oom_setup_ingress_controller.rst
80
81