3acb8b6ee6e2f01311038b6bfb80e17f0d19df84
[oom.git] / docs / sections / guides / deployment_guides / oom_customize_overrides.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 .. _helm deploy: https://github.com/onap/oom/blob/master/kubernetes/helm/plugins/deploy/deploy.sh
8
9 .. _oom_customize_overrides:
10
11 OOM Custom Overrides
12 ####################
13
14 The OOM `helm deploy`_ plugin requires deployment configuration as input, usually in the form of override yaml files.
15 These input files determine what ONAP components get deployed, and the configuration of the OOM deployment.
16
17 Other helm config options like `--set log.enabled=true|false` are available.
18
19 See the `helm deploy`_ plugin usage section for more detail, or it the plugin has already been installed, execute the following::
20
21     > helm deploy --help
22
23 Users can customize the override files to suit their required deployment.
24
25 .. note::
26   Standard and example override files (e.g. `onap-all.yaml`, `onap-all-ingress-istio.yaml`)
27   can be found in the `oom/kubernetes/onap/resources/overrides/` directory.
28
29  * Users can selectively enable or disable ONAP components by changing the ``enabled: true/false`` flags.
30
31  * Add to the command line a value for the global master password (ie. --set global.masterPassword=My_superPassw0rd).
32
33
34 Enabling/Disabling Components
35 -----------------------------
36 Here is an example of the nominal entries that need to be provided.
37 Different values files are available for different contexts.
38
39 .. collapse:: Default ONAP values.yaml
40
41     .. include:: ../../../../kubernetes/onap/values.yaml
42        :code: yaml
43
44 |
45
46 Some other heading
47 ------------------
48 adva