Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions install_rhcl/install-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ toc::[]
[role="_abstract"]
You can install {prodname} on {ocp} clusters to apply authentication, rate limiting, and DNS policies to gateway resources.

Install the Kuadrant Operator by using a supported method for your environment, such as the {ocp} web console or the CLI procedures in this guide. The Kuadrant Operator manages {mcpg} and other included components through Helm charts. Do not install these managed components separately.

include::modules/proc-install-in-openshift-web-console.adoc[leveloffset=+1]

include::modules/proc-install-on-openshift-cli-cio.adoc[leveloffset=+1]
Expand Down
3 changes: 2 additions & 1 deletion mcp_gateway_install/mcp-gateway-install.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ include::_attributes/attributes.adoc[]
toc::[]

[role="_abstract"]
You can get started with the {mcpg} by using Operator Lifecycle Manager (OLM). After you install the Operator, set up connections by applying the custom resources that you require.
To use {mcpg} with {prodname}, first install the Kuadrant Operator by using the supported method for your environment. The Kuadrant Operator manages {mcpg} and other included components through Helm charts. You can use OLM or the {ocp} web console to install the Kuadrant Operator where supported. Do not install managed components separately. After installation, set up connections by applying the custom resources that you require.

:FeatureName: {mcpg}

Expand Down Expand Up @@ -35,6 +35,7 @@ include::modules/proc-mcp-gateway-config-verify.adoc[leveloffset=+1]
[role="_additional-resources"]
== Additional resources

* xref:../install_rhcl/install-guide.adoc#rhcl-install-on-ocp[Install {prodname} on {ocp}]
* xref:../reference/mcp-gateway-install-reference.adoc#ref-mcp-gateway-install-gateway-ext-api_mcp-gateway-install-reference[Use MCP gateway references for installation]
* xref:../mcp_gateway_config/mcp-gateway-register-on-prem-mcp-servers.adoc#con-mcp-gateway-register-mcp-server_mcp-gateway-register-on-prem-mcp-servers[Register on-premise MCP servers]
* xref:../mcp_gateway_config/mcp-gateway-register-ext-mcp-servers.adoc#proc-register-ext-mcp-server-serviceentry_mcp-gateway-register-ext-mcp-servers[Register external MCP servers]
11 changes: 2 additions & 9 deletions modules/con-about-connectivity-link.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,7 @@ User workflows::
Automatic updates::
+
--
{prodname} consists of the following four Operators bundled into a single catalog:

* The {prodname} Operator manages policy attachment and Gateway API integration.
* The Authorino Operator handles authentication and authorization.
* The Limitador Operator manages rate-limiting.
* The DNS Operator manages multi-cluster DNS.

The {prodname} Operator declares the other three Operators as dependencies through Operator Lifecycle Manager (OLM). This installation type means that updates are automatic.
Install the Kuadrant Operator by using the supported method for your environment. You can use Operator Lifecycle Manager (OLM) or OperatorHub to install it where supported. The Kuadrant Operator manages Authorino, Limitador, DNS, {mcpg}, and other included components through Helm charts. Do not install these managed components separately. The Kuadrant Operator manages their lifecycle and updates.
--

Example policy types::
Expand Down Expand Up @@ -83,4 +76,4 @@ Use the {ocp} web console plugin to manage APIs, for example:
[role="_additional-resources"]
.Additional resources

* link:https://gateway-api.sigs.k8s.io/[Gateway API]
* link:https://gateway-api.sigs.k8s.io/[Gateway API]
4 changes: 2 additions & 2 deletions modules/con-rhcl-install-disconnected.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ You can do many tasks on isolated clusters when you use {prodname} as a disconne

If you are using CoreDNS on a cluster that other clusters can access on an internal network, ensure that your CoreDNS instances is accessible to whatever uses them, such as internal DNS resolvers.

Install {prodname} Operators in disconnected {ocp} environments by mirroring the Operator catalog and images to your internal registry. Use the `oc-mirror` tool to perform the following actions, in order:
To install {prodname} in a disconnected {ocp} environment, mirror the Operator catalog and required images to your internal registry, then install the {prodname} Operator by using Operator Lifecycle Manager (OLM). The Kuadrant Operator manages {mcpg} and other included components through Helm charts; do not install these components separately. Use the `oc-mirror` tool to perform the following actions, in order:

. Mirror the Red Hat Operator catalog containing the {prodname} Operator package to your local registry.
. Configure your {ocp} cluster to use the mirrored catalog.
. Install the {prodname} Operator using Operator Lifecycle Manager (OLM).
. Install the {prodname} Operator from the mirrored catalog.

The following policy requirements apply in disconnected environments:

Expand Down
8 changes: 4 additions & 4 deletions modules/proc-install-in-openshift-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,11 @@ If you are using {service-mesh}, no additional configuration is required. {prodn

.Verification

After you have installed the Operator, click *Ecosystem > Installed Operators* to verify that the *{product-title}* Operator and the following component Operators are installed in your namespace:
. In *Ecosystem > Installed Operators*, verify that the *{product-title}* Operator has a status of *Succeeded*.

* *Authorino Operator*: Enables authentication and authorization for gateways and applications in a Gateway API network.
* *DNS Operator*: Configures how north-south traffic from outside the network is balanced and reaches gateways.
* *Limitador Operator*: Enables rate limiting for gateways and applications in a Gateway API network.
. Open the *{product-title}* Operator, click the *Kuadrant* tab, and select the `Kuadrant` CR that you created.

. In the *YAML* view, verify that `.status.conditions` includes a `Ready` condition with `status: "True"`.

.Next step

Expand Down
12 changes: 2 additions & 10 deletions modules/proc-install-on-openshift-cli-cio.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Replace `_<kuadrant_system>_` with the namespace where you installed {prodname}.
kuadrant.kuadrant.io/kuadrant Ready
----

. Verify that all component Operator pods are running by entering the following command:
. Verify that the Kuadrant Operator and its managed components have healthy pods by running the following command:
+
[source,terminal,subs="+quotes"]
----
Expand All @@ -166,15 +166,7 @@ $ oc get pods -n _<kuadrant_system>_
+
Replace `_<kuadrant_system>_` with the namespace where you installed {prodname}.
+
.Example output
[source,terminal]
----
NAME READY STATUS RESTARTS AGE
authorino-operator-controller-manager-<hash> 2/2 Running 0 5m
dns-operator-controller-manager-<hash> 2/2 Running 0 5m
kuadrant-operator-controller-manager-<hash> 2/2 Running 0 7m
limitador-operator-controller-manager-<hash> 2/2 Running 0 5m
----
The Kuadrant Operator deploys and manages included components through Helm charts. Check that the relevant pods show `Running` in the `STATUS` column and that all containers are ready in the `READY` column. You do not need to install component Operators separately.

. For a disconnected installation, verify that there are no image pull errors by running the following command:
+
Expand Down
5 changes: 5 additions & 0 deletions modules/proc-mcp-gateway-install-olm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@
[role="_abstract"]
You can install the {mcpg} deployment Operator by using Operator Lifecycle Manager (OLM) with the CLI. When choosing this path, you must create a `MCPGatewayExtension` custom resources (CR) manually and apply it to complete your initial setup.

[IMPORTANT]
====
For a {prodname} deployment, first install the Kuadrant Operator by using the supported method for your environment. The Kuadrant Operator manages {mcpg} and other included components through Helm charts. Do not install the {mcpg} Operator separately for a Kuadrant-managed deployment. The OLM steps in this section describe a standalone {mcpg} Operator installation.
====

.Prerequisites

* You installed {ocp}.
Expand Down
2 changes: 1 addition & 1 deletion modules/proc-migrate-policies-to-grpc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ A `GRPCRoute` CR cannot coexist with an `HTTPRoute` CR on the same hostname. If

* You installed {ocp}.
* You installed {oc-first}.
* You installed the {mcpg} Operator.
* You installed {prodname} by using a supported method for your environment.
* You created a Gateway object.
* You have an existing `HTTPRoute` CR routing traffic to a gRPC service.

Expand Down
34 changes: 21 additions & 13 deletions modules/proc-rhcl-disconnected-install-ts-ops.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,35 +4,43 @@

:_mod-docs-content-type: PROCEDURE
[id="proc-rhcl-disconnected-install-ts-ops_{context}"]
= Check for dependent Operators that are not installed
//Q: do we need this module anymore? or would this be relevant for mcp gateway now?
= Check a disconnected {prodname} installation

[role="_abstract"]
If you only see the {prodname} Operator `ClusterServiceVersion`, but the {prodname} Operator is missing, the catalog might be missing digest references or the dependencies are not declared. You can track the source of the problem by checking a couple of resources.
If the Kuadrant Operator or its managed components are not ready after a disconnected installation, check the mirrored catalog, Operator installation, and component pods to find the cause.

.Prerequisites

* You completed a disconnected installation of {prodname}.

.Procedure

. Verify that all of the required Operators are available as `PackageManifest` resources by running the following command:
. Verify that the {prodname} Operator package is available in the mirrored catalog by running the following command:
+
[source,terminal,subs="+quotes"]
[source,terminal]
----
$ oc get packagemanifest -n openshift-marketplace | grep -E '(rhcl|authorino|limitador|dns)-operator'
$ oc get packagemanifest rhcl-operator -n openshift-marketplace
----
+
If the package is missing, check that the mirrored catalog is ready and that the `ImageSetConfiguration` includes the `rhcl-operator` package.

. If any packages are missing, the catalog was not mirrored or applied correctly. Check that the catalog is ready and running with no errors and that the `ImageSetConfiguration` is created correctly.

. Check that the `InstallPlan` shows all dependencies by running the following command:
. Check the {prodname} Operator `Subscription` and `ClusterServiceVersion` (CSV) by running the following commands:
+
[source,terminal,subs="+quotes"]
----
$ oc get installplan -n _<kuadrant_system>_ -o yaml
$ oc get subscription rhcl-operator -n _<kuadrant_system>_
$ oc get csv -n _<kuadrant_system>_
----
+
* Replace `_<kuadrant_system>_` with the namespace in which you installed {prodname}.
* Look for all required Operators in the `InstallPlan` specification output.
Replace `_<kuadrant_system>_` with the namespace in which you installed {prodname}. The {prodname} Operator CSV should show `Succeeded`. If it does not, inspect the `InstallPlan` in the same namespace for errors.

. If an Operator is missing, check the `InstallPlan` for errors or re-mirror the catalog.
. If the Operator is installed but its managed components are not ready, check the `Kuadrant` custom resource (CR) and pods by running the following commands:
+
[source,terminal,subs="+quotes"]
----
$ oc describe kuadrant kuadrant -n _<kuadrant_system>_
$ oc get pods -n _<kuadrant_system>_
$ oc get events -n _<kuadrant_system>_ --field-selector reason=Failed
----
+
Replace `_<kuadrant_system>_` with the namespace in which you installed {prodname}. Check the `Kuadrant` CR conditions and pod status for errors. If events show image pull failures, verify that the required images were mirrored and that the cluster image mirror configuration points to your registry. The Kuadrant Operator manages the included components through Helm charts; they do not require separate OLM packages.
5 changes: 4 additions & 1 deletion modules/proc-update-rhcl-with-web-console.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@ Update your {product-title} with the {ocp} web console.
. If *Update approval* is set to *Automatic*, the update is installed immediately when the *Update channel* is set to `stable`.
. If *Update approval* is set to *Manual*, click *Install*.
. Wait until the {prodname} Operator is deployed.
. Verify that {prodname} {version} is installed and that your deployment is up and running.
. Verify that {prodname} {version} is installed. Open the *Kuadrant* tab, select the `Kuadrant` custom resource (CR), and verify in the *YAML* view that `.status.conditions` includes a `Ready` condition with `status: "True"`.
. In *Workloads > Pods*, select the namespace where you installed {prodname}. Verify that the managed component pods are running and all their containers are ready.

The Kuadrant Operator updates the components it manages through Helm charts. You do not need to update component Operators separately.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤖 [error] AsciiDocDITA.TaskStep: Content other than a single list cannot be mapped to DITA steps.