|
1 | 1 | = Installing the Runtime Component Operator using kustomize |
2 | 2 |
|
3 | | -This directory contains kustomize files that can be used to install the operator |
4 | | -in your cluster in various different configurations, and also some example overlays |
5 | | -which show how the installation can be customized. |
| 3 | +This directory contains configuration files that helps installing the Runtime Component operator |
| 4 | +using `kustomize` with the Kubernetes command-line interface (CLI) (`kubectl`). These configurations |
| 5 | +are useful when the cluster is not a Red Hat® OpenShift® Container Platform cluster or when |
| 6 | +Operator Lifecycle Manager is not being used. |
6 | 7 |
|
7 | | -== Install and watch own namespace |
| 8 | +== Installing and watching own namespace |
8 | 9 |
|
9 | 10 | === base |
10 | | -The simplest configuration will install the operator into the 'default' namespace, and the operator |
11 | | -will watch for Runtime Component custom resource instances only in its own namespace. To install, run: |
12 | | -`kubectl create -k base` |
13 | | -and to uninstall, run: |
14 | | -`kubectl delete -k base` |
| 11 | +The base configuration installs the operator into the 'runtime-component' namespace, |
| 12 | +and the operator watches for Runtime Component custom resource instances only in its own namespace. |
| 13 | +Create a namespace called 'runtime-component' for the operator. |
| 14 | +To install, run: `kubectl create -k base` and to uninstall, run: `kubectl delete -k base` |
15 | 15 |
|
16 | 16 | === examples/watch-own-namespace |
17 | | -This example overlay demonstrates how to modify the base configuration to install/watch a |
18 | | -namespace other than 'default'. The example installs the operator to a namespace called |
19 | | -'rco-ns' which should already exist. To install, run `kubectl create -k examples/watch-own-namespace` |
| 17 | +This example overlay demonstrates how to modify the base configuration to install the operator and have it |
| 18 | +watch a namespace other than 'runtime-component'. Create a namespace called 'rco-ns' for the operator. |
| 19 | +To install the operator into the 'rco-ns' namespace, run: `kubectl create -k examples/watch-own-namespace` |
20 | 20 |
|
21 | | -== Install and watch another namespace |
| 21 | +== Installing and watching another namespace |
22 | 22 |
|
23 | 23 | === overlays/watch-another-namespace |
24 | 24 | This overlay installs the operator into the namespace 'rco-ns', but configures it to |
25 | | -watch for Runtime Component custom resource instances in a different namespace called 'rco-watched-ns'. As |
26 | | -this overlay install resources into two different namespaces, the namespace must not be specified |
27 | | -in the kustomize.yaml file. To install, run `kubectl create -k overlays/watch-another-namespace` |
| 25 | +watch for Runtime Component custom resource instances in a different namespace called 'rco-watched-ns'. |
| 26 | +Because this overlay installs resources into two different namespaces, the namespace must not be specified |
| 27 | +in the kustomize.yaml file. To install, run: `kubectl create -k overlays/watch-another-namespace` |
28 | 28 |
|
29 | 29 | === examples/watch-another-namespace |
30 | | -This example overlay builds on the previous one, but demonstrates how to change the |
31 | | -install and watched namespaces. In this case, the operator is installed into 'rco-ns2' |
32 | | -and it will watch for resources in 'rco-watched-ns2'. To install run `kubectl create -k |
| 30 | +This example overlay builds on the previous example, but demonstrates how to change |
| 31 | +the install and watched namespaces. In this case, the operator is installed into 'rco-ns2' |
| 32 | +and watches for resources in 'rco-watched-ns2'. To install run: `kubectl create -k |
33 | 33 | examples/watch-another-namespace` |
34 | 34 |
|
35 | | -== Install and watch all namespaces |
| 35 | +== Installing and watching all namespaces |
36 | 36 |
|
37 | 37 | === overlays/watch-all-namespaces |
38 | | -This overlay installs the operator into the default namespace, but configures it |
39 | | -to watch for Runtime Component custom resource instances in any namespace. Compared to the base, |
40 | | -this requires additional ClusterRoles and ClusterRoleBindings. To install run: |
41 | | -`kubectl create -k overlays/watch-all-namespaces` |
| 38 | +This overlay installs the operator into the 'runtime-component' namespace, |
| 39 | +but configures it to watch for Runtime Component custom resource instances in any namespaces. |
| 40 | +Compared to the base configuration, this overlay requires additional ClusterRoles and ClusterRoleBindings. |
| 41 | +To install, run: `kubectl create -k overlays/watch-all-namespaces` |
42 | 42 |
|
43 | 43 | === examples/watch-all-namespaces |
44 | | -This example overlay builds on the previous one, and demonstrates how to change |
45 | | -which namespace the operator is installed into. In this example, the operator |
46 | | -is installed into a namespace called 'rco-ns', and will still watch for |
47 | | -Runtime Component custom resource instances in any namespace. To install, run: |
48 | | -`kubectl create -k examples/watch-all-namespaces` |
| 44 | +This example overlay builds on the previous example and demonstrates how to change |
| 45 | +the namespace that the operator installs into. In this example, the operator installs |
| 46 | +into a namespace that is called 'rco-ns' and watches for Runtime Component custom resource |
| 47 | +instances in any namespaces. To install, run: `kubectl create -k examples/watch-all-namespaces` |
0 commit comments