-
Notifications
You must be signed in to change notification settings - Fork 23
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Service Protection components installation guide
- Loading branch information
1 parent
2db61d7
commit dd376e0
Showing
4 changed files
with
103 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
# Installing Kuadrant Service Protection into an existing OCM Managed Cluster | ||
|
||
## Introduction | ||
This walkthrough will show you how to install and setup the Kuadrant Operator into an [OCM](https://open-cluster-management.io/) [Managed Cluster](https://open-cluster-management.io/concepts/managedcluster/). | ||
|
||
## Prerequisites | ||
* Access to an Open Cluster Management (>= 0.6.0) Managed Cluster, which has already been bootstrapped and registered with a hub cluster | ||
* We have [a guide](./mgc-setup.md) which covers this in detail | ||
* Also see: | ||
* https://open-cluster-management.io/getting-started/quick-start/ | ||
* https://open-cluster-management.io/concepts/managedcluster/ | ||
* OLM will need to be installed into the ManagedCluster where you want to run the Kuadrant Service Protection components | ||
* See https://olm.operatorframework.io/docs/getting-started/ | ||
* Kuadrant uses Istio as a Gateway API provider - this will need to be installed into the data plane clusters | ||
* See https://istio.io/v1.16/blog/2022/getting-started-gtwapi/ | ||
* We recommend installing Istio 1.17.0 | ||
|
||
|
||
Alternatively, if you'd like to quickly get started locally, without having to worry to much about the pre-requisites, take a look at [this guide](./ocm-control-plane-walkthrough.md). It will get you setup with Kind, OLM, OCM & Kuadrant in a few short steps. | ||
|
||
|
||
## Install the Kuadrant OCM Add-On | ||
|
||
To install the Kuadrant Service Protection components into a `ManagedCluster`, target your cluster and run: | ||
|
||
```bash | ||
kubectl apply -f - <<EOF | ||
apiVersion: addon.open-cluster-management.io/v1alpha1 | ||
kind: ManagedClusterAddOn | ||
metadata: | ||
name: kuadrant-addon | ||
namespace: kind-mgc-workload-1 | ||
spec: | ||
installNamespace: open-cluster-management-agent-addon | ||
EOF | ||
``` | ||
|
||
**Note:** if you've run our Quickstart Setup guide, you'll be set to run this command as-is. | ||
|
||
The above command will install the `ManagedClusterAddOn` resource needed to install the Kuadrant addon into the `kind-mgc-workload-1` namespace, and install the Kuadrant data-plane components into the `open-cluster-management-agent-addon` namespace. | ||
|
||
The Kuadrant addon will install: | ||
|
||
* the Kuadrant Operator | ||
* Limitador (and its associated operator) | ||
* Authorino (and its associated operator) | ||
|
||
For more details, see the Kuadrant components installed by the (kuadrant-operator)[https://github.com/Kuadrant/kuadrant-operator#kuadrant-components] | ||
|
||
## Verify the Kuadrant addon installation | ||
|
||
To verify the Kuadrant OCM addon has installed currently, run: | ||
|
||
```bash | ||
kubectl get pods -n kuadrant-system | ||
``` | ||
|
||
You should see the namespace `kuadrant-system`, and the following pods come up: | ||
* authorino-*value* | ||
* authorino-operator-*value* | ||
* kuadrant-operator-controller-manager-*value* | ||
* limitador-*value* | ||
* limitador-operator-controller-manager-*value* | ||
|
||
# Further Reading | ||
With the Kuadrant data plane components installed, here is some further reading material to help you utilise Authorino and Limitador: | ||
|
||
[Getting started with Authorino](https://docs.kuadrant.io/authorino/) | ||
[Getting started With Limitador](https://docs.kuadrant.io/limitador-operator/) | ||
|
||
|
||
|
||
|
||
|