diff options
Diffstat (limited to 'docs/sections/guides/deployment_guides')
5 files changed, 52 insertions, 27 deletions
diff --git a/docs/sections/guides/deployment_guides/oom_customize_overrides.rst b/docs/sections/guides/deployment_guides/oom_customize_overrides.rst index a5458f8562..52fb7e5d5b 100644 --- a/docs/sections/guides/deployment_guides/oom_customize_overrides.rst +++ b/docs/sections/guides/deployment_guides/oom_customize_overrides.rst @@ -11,12 +11,15 @@ OOM Custom Overrides #################### -The OOM `helm deploy`_ plugin requires deployment configuration as input, usually in the form of override yaml files. -These input files determine what ONAP components get deployed, and the configuration of the OOM deployment. +The OOM `helm deploy`_ plugin requires deployment configuration as input, +usually in the form of override yaml files. +These input files determine what ONAP components get deployed, and the +configuration of the OOM deployment. Other helm config options like `--set log.enabled=true|false` are available. -See the `helm deploy`_ plugin usage section for more detail, or it the plugin has already been installed, execute the following:: +See the `helm deploy`_ plugin usage section for more detail, or it the plugin +has already been installed, execute the following:: > helm deploy --help @@ -121,31 +124,46 @@ Global settings relevant for ServiceMesh and Ingress: ServiceMesh settings: -- enabled: true → enables ServiceMesh functionality in the ONAP Namespace (Istio: enables Sidecar deployment) +- enabled: true → enables ServiceMesh functionality in the ONAP Namespace + (Istio: enables Sidecar deployment) - tls: true → enables mTLS encryption in Sidecar communication - engine: istio → sets the SM engine (currently only Istio is supported) - aafEnabled: false → disables AAF usage for TLS interfaces - tlsEnabled: false → disables creation of TLS in component services - cmpv2Enabled: false → disable cmpv2 feature -- msbEnabled: false → MSB is not used in Istio setup (Open, if all components are MSB independend) +- msbEnabled: false → MSB is not used in Istio setup (Open, if all components + are MSB independend) Ingress settings: -- enabled: true → enables Ingress using: Nginx (when SM disabled), Istio IngressGateway (when SM enabled) +- enabled: true → enables Ingress using: Nginx (when SM disabled), Istio + IngressGateway (when SM enabled) - enable_all: true → enables Ingress configuration in each component - provider: "..." → sets the Ingress provider (ingress, istio, gw-api) -- ingressClass: "" → Ingress class (only for provider "ingress"): e.g. nginx, traefik -- ingressSelector: "" → Selector (only for provider "istio") to match with the ingress pod label "istio=ingress" -- commonGateway: "" → optional: common used Gateway (for Istio, GW-API) and http(s) listener names -- virtualhost.baseurl: "simpledemo.onap.org" → sets globally the URL for all Interfaces set by the components, - resulting in e.g. "aai-api.simpledemo.onap.org", can be overwritten in the component via: ingress.baseurlOverride -- virtualhost.preaddr: "pre-" → sets globally a prefix for the Application name for all Interfaces set by the components, - resulting in e.g. "pre-aai-api.simpledemo.onap.org", can be overwritten in the component via: ingress.preaddrOverride -- virtualhost.postaddr: "-post" → sets globally a postfix for the Application name for all Interfaces set by the components, - resulting in e.g. "aai-api-post.simpledemo.onap.org", can be overwritten in the component via: ingress.postaddrOverride -- config.ssl: redirect → sets in the Ingress globally the redirection of all Interfaces from http (port 80) to https (port 443) -- config.tls.secret: "..." → (optional) overrides the default selfsigned SSL certificate with a certificate stored in the specified secret -- namespace: istio-ingress → (optional) overrides the namespace of the ingress gateway which is used for the created SSL certificate +- ingressClass: "" → Ingress class (only for provider "ingress"): e.g. nginx, + traefik +- ingressSelector: "" → Selector (only for provider "istio") to match with the + ingress pod label "istio=ingress" +- commonGateway: "" → optional: common used Gateway (for Istio, GW-API) and + http(s) listener names +- virtualhost.baseurl: "simpledemo.onap.org" → sets globally the URL for all + Interfaces set by the components, resulting in e.g. + "aai-api.simpledemo.onap.org", can be overwritten in the component via: + ingress.baseurlOverride +- virtualhost.preaddr: "pre-" → sets globally a prefix for the Application name + for all Interfaces set by the components, resulting in e.g. + "pre-aai-api.simpledemo.onap.org", can be overwritten in the component via: + ingress.preaddrOverride +- virtualhost.postaddr: "-post" → sets globally a postfix for the Application + name for all Interfaces set by the components, resulting in e.g. + "aai-api-post.simpledemo.onap.org", can be overwritten in the component via: + ingress.postaddrOverride +- config.ssl: redirect → sets in the Ingress globally the redirection of all + Interfaces from http (port 80) to https (port 443) +- config.tls.secret: "..." → (optional) overrides the default selfsigned SSL + certificate with a certificate stored in the specified secret +- namespace: istio-ingress → (optional) overrides the namespace of the ingress + gateway which is used for the created SSL certificate .. note:: For the Ingress setup example override files (`onap-all-ingress-istio.yaml`, `onap-all-ingress-gatewayapi.yaml`) diff --git a/docs/sections/guides/deployment_guides/oom_deployment.rst b/docs/sections/guides/deployment_guides/oom_deployment.rst index ba4f4e22eb..21e988da5b 100644 --- a/docs/sections/guides/deployment_guides/oom_deployment.rst +++ b/docs/sections/guides/deployment_guides/oom_deployment.rst @@ -14,7 +14,8 @@ OOM Deployment Guide .. figure:: ../../resources/images/oom_logo/oomLogoV2-medium.png :align: right -ONAP OOM supports several options for the deployment of ONAP using it's helm charts. +ONAP OOM supports several options for the deployment of ONAP using it's helm +charts. * :ref:`oom_helm_release_repo_deploy` * :ref:`oom_helm_testing_repo_deploy` @@ -27,7 +28,8 @@ ONAP OOM supports several options for the deployment of ONAP using it's helm cha | :ref:`Set up your base platform<oom_base_setup_guide>` -Each deployment method can be customized to deploy a subset of ONAP component applications. +Each deployment method can be customized to deploy a subset of ONAP component +applications. See the :ref:`oom_customize_overrides` section for more details. diff --git a/docs/sections/guides/deployment_guides/oom_dev_testing_local_deploy.rst b/docs/sections/guides/deployment_guides/oom_dev_testing_local_deploy.rst index b0deff0e2b..debca31918 100644 --- a/docs/sections/guides/deployment_guides/oom_dev_testing_local_deploy.rst +++ b/docs/sections/guides/deployment_guides/oom_dev_testing_local_deploy.rst @@ -10,8 +10,8 @@ OOM Developer Testing Deployment ================================ -Developing and testing changes to the existing OOM project can be done locally by setting up some additional -tools to host the updated helm charts. +Developing and testing changes to the existing OOM project can be done locally +by setting up some additional tools to host the updated helm charts. **Step 1.** Clone the OOM repository from ONAP gerrit:: @@ -31,7 +31,8 @@ tools to host the updated helm charts. **Step 3.** Install Chartmuseum -Chart museum is required to host the helm charts locally when deploying in a development environment:: +Chart museum is required to host the helm charts locally when deploying in a +development environment:: > curl https://raw.githubusercontent.com/helm/chartmuseum/main/scripts/get-chartmuseum | bash @@ -41,7 +42,8 @@ Chart museum is required to host the helm charts locally when deploying in a dev > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 & -Note the port number that is listed and use it in the Helm repo add as follows:: +Note the port number that is listed and use it in the Helm repo add as +follows:: > helm repo add local http://127.0.0.1:8879 diff --git a/docs/sections/guides/deployment_guides/oom_helm_release_repo_deploy.rst b/docs/sections/guides/deployment_guides/oom_helm_release_repo_deploy.rst index df2ede39dc..5e3115da6b 100644 --- a/docs/sections/guides/deployment_guides/oom_helm_release_repo_deploy.rst +++ b/docs/sections/guides/deployment_guides/oom_helm_release_repo_deploy.rst @@ -32,7 +32,8 @@ Add the repository: To customize what applications are deployed, see the :ref:`oom_customize_overrides` section for more details, to provide your own custom overrides yaml file. -- To deploy a release, execute the following, substituting the <version> tag with your preferred release (ie. 13.0.0):: +- To deploy a release, execute the following, substituting the <version> tag with + your preferred release (ie. 13.0.0):: > helm deploy dev onap-release/onap --namespace onap --create-namespace --set global.masterPassword=myAwesomePasswordThatINeedToChange --version <version> -f oom/kubernetes/onap/resources/overrides/onap-all.yaml diff --git a/docs/sections/guides/deployment_guides/oom_helm_testing_repo_deploy.rst b/docs/sections/guides/deployment_guides/oom_helm_testing_repo_deploy.rst index e9312382b3..92c0e68dff 100644 --- a/docs/sections/guides/deployment_guides/oom_helm_testing_repo_deploy.rst +++ b/docs/sections/guides/deployment_guides/oom_helm_testing_repo_deploy.rst @@ -12,12 +12,14 @@ OOM Helm Testing Deployment =========================== -ONAP hosts the OOM `testing` helm charts in it's `ONAP helm testing repository`_. +ONAP hosts the OOM `testing` helm charts in it's +`ONAP helm testing repository`_. This is helm repo contains: * The `latest` charts built from the head of the `OOM`_ project's master - branch, tagged with the version number of the current development cycle (ie. 12.0.0). + branch, tagged with the version number of the current development cycle + (ie. 15.0.0). Add the OOM testing repo & Deploy |