aboutsummaryrefslogtreecommitdiffstats
path: root/docs/sections/guides/deployment_guides
diff options
context:
space:
mode:
authorAndreas Geissler <andreas-geissler@telekom.de>2023-12-06 10:02:43 +0100
committerAndreas Geissler <andreas-geissler@telekom.de>2023-12-07 15:13:54 +0000
commite68c766712ed6c95aff054004335813952bf5ffa (patch)
tree83db344a3b583fd6d1b2a269430353ac718b11f8 /docs/sections/guides/deployment_guides
parentc5cdaf46f0c414ad2be7efcc4b792e9d3d9c51eb (diff)
[COMMON][DOC] Add documentation for Montral and GatewayAPI
Add override file to use GatewayAPI as Ingress provider A precreated GW named "common-gateway" is used. Added documentation for Montreal like release notes, Infrastructure guides... Issue-ID: OOM-3184 Issue-ID: OOM-3242 Change-Id: I18107bac52abf34dbc0b217fd8b7542ba51aab84 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de>
Diffstat (limited to 'docs/sections/guides/deployment_guides')
-rw-r--r--docs/sections/guides/deployment_guides/oom_customize_overrides.rst22
-rw-r--r--docs/sections/guides/deployment_guides/oom_helm_release_repo_deploy.rst2
2 files changed, 21 insertions, 3 deletions
diff --git a/docs/sections/guides/deployment_guides/oom_customize_overrides.rst b/docs/sections/guides/deployment_guides/oom_customize_overrides.rst
index f3e3113ff5..a5458f8562 100644
--- a/docs/sections/guides/deployment_guides/oom_customize_overrides.rst
+++ b/docs/sections/guides/deployment_guides/oom_customize_overrides.rst
@@ -23,7 +23,7 @@ See the `helm deploy`_ plugin usage section for more detail, or it the plugin ha
Users can customize the override files to suit their required deployment.
.. note::
- Standard and example override files (e.g. `onap-all.yaml`, `onap-all-ingress-istio.yaml`)
+ Standard and example override files (e.g. `onap-all.yaml`, `onap-all-ingress-gatewayapi.yaml`)
can be found in the `oom/kubernetes/onap/resources/overrides/` directory.
* Users can selectively enable or disable ONAP components by changing the ``enabled: true/false`` flags.
@@ -70,6 +70,20 @@ Global settings relevant for ServiceMesh and Ingress:
enabled: true
# enable all component's Ingress interfaces
enable_all: false
+
+ # Provider: ingress, istio, gw-api
+ provider: gw-api
+ # Ingress class (only for provider "ingress"): e.g. nginx, traefik
+ ingressClass:
+ # Ingress Selector (only for provider "istio") to match with the
+ # ingress pod label "istio=ingress"
+ ingressSelector: ingress
+ # optional: common used Gateway (for Istio, GW-API) and listener names
+ commonGateway:
+ name: ""
+ httpListener: ""
+ httpsListener: ""
+
# default Ingress base URL
# All http requests via ingress will be redirected
virtualhost:
@@ -119,6 +133,10 @@ Ingress settings:
- 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,
@@ -130,7 +148,7 @@ Ingress settings:
- namespace: istio-ingress → (optional) overrides the namespace of the ingress gateway which is used for the created SSL certificate
.. note::
- For the Ingress setup an example override file (`onap-all-ingress-istio.yaml`)
+ For the Ingress setup example override files (`onap-all-ingress-istio.yaml`, `onap-all-ingress-gatewayapi.yaml`)
can be found in the `oom/kubernetes/onap/resources/overrides/` directory.
External Authentication configuration
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 f932360e44..e7dc2f0a35 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,7 @@ 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. 11.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