.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
-.. Copyright 2019 Samsung Electronics Co., Ltd.
+.. Copyright 2021 Samsung Electronics Co., Ltd.
-.. _oooi_installguide:
-
-OOM ONAP Offline Installer - Installation Guide
-===============================================
+Offline Installer - Installation Guide
+======================================
This document describes the correct offline installation procedure for `OOM ONAP`_, which is done by the ansible based `offline-installer <https://gerrit.onap.org/r/#/admin/projects/oom/offline-installer>`_.
-----
-.. _oooi_installguide_preparations:
-
Part 1. Prerequisites
---------------------
Community recommended footprint from `El Alto requirements`_ page is 16 VMs ``224 GB RAM`` and ``112 vCPUs``. We will not follow strictly this setup due to such demanding resource consumption and so we will deploy our installation across four nodes (VMs) instead of sixteen. Our simplified setup is definitively not supported or recommended - you are free to diverge - you can follow the official guidelines or make completely different layout, but the minimal count of nodes should not drop below three - otherwise you may have to do some tweaking to make it work, which is not covered here (there is a pod count limit for a single kubernetes node - you can read more about it in this `discussion <https://lists.onap.org/g/onap-discuss/topic/oom_110_kubernetes_pod/25213556>`_).
-.. _oooi_installguide_preparations_k8s_cluster:
-
Kubernetes cluster
~~~~~~~~~~~~~~~~~~
We will expect from now on that you installed four VMs and they are connected to the shared network. All VMs must be reachable from our *install-server* (below), which can be the hypervisor, *infra-node* or completely different machine. But in either of these cases the *install-server* must be able to connect over ssh to all of these nodes.
-.. _oooi_installguide_preparations_installserver:
-
Install-server
~~~~~~~~~~~~~~
-----
-.. _oooi_installguide_config:
-
Part 2. Preparation and configuration
-------------------------------------
We *MUST* do all the following instructions from the *install-server* and also we will be running them as a user ``root``. But that is not necessary - you can without any problem pick and use a regular user. The ssh/ansible connection to the nodes will also expect that we are connecting as a ``root`` - you need to elevate privileges to be able to install on them. Although it can be achieved by other means (sudo), we decided here to keep instructions simple.
-.. _oooi_installguide_config_packages:
-
Installer packages
~~~~~~~~~~~~~~~~~~
$ mkdir ~/onap-offline-installer
$ tar -C ~/onap-offline-installer -xf /data/sw_package.tar
-.. _oooi_installguide_config_app:
-
Application directory
~~~~~~~~~~~~~~~~~~~~~
Following paragraphs describe fine-tuning of ``'inventory.yml'`` and ``'application_configuration.yml'`` to reflect your VMs setup.
-.. _oooi_installguide_config_hosts:
-
hosts.yml
~~~~~~~~~
hosts:
kubernetes-node-1
-.. _oooi_installguide_config_appconfig:
-
application_configuration.yml
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
slewclock: true
timezone: UTC
-.. _oooi_installguide_config_appconfig_overrides:
-
Helm chart value overrides
^^^^^^^^^^^^^^^^^^^^^^^^^^
In addition or alternatively to that one can configure ``helm_override_files`` key, which is new feature implemented in Change-Id: I8b8ded38b39aa9a75e55fc63fa0e11b986556cb8.
-.. _oooi_installguide_config_ssh:
-
SSH authentication
~~~~~~~~~~~~~~~~~~
-----
-.. _oooi_installguide_install:
-
Part 3. Installation
--------------------
----
-.. _oooi_installguide_postinstall:
-
Part 4. Post-installation and troubleshooting
---------------------------------------------
-----
-.. _oooi_installguide_appendix1:
-
Appendix 1. Ansible execution/bootstrap
---------------------------------------