Skip to content

Commit 27e661b

Browse files
author
Vincent
authored
Add the description on how to to append customized the manifests (#3114)
1 parent 57f33d3 commit 27e661b

File tree

1 file changed

+65
-5
lines changed

1 file changed

+65
-5
lines changed

docs/install/knative-with-operators.md

Lines changed: 65 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,9 +143,15 @@ Put the manifest you want to apply first on the top.
143143
Knative Serving based your own requirements. As long as the manifests of customized Knative Serving are accessible to
144144
the operator, they can be installed.
145145

146-
For example, the version of the customized Knative Serving is `{{spec.version}}`, and it is available at `https://my-serving/serving.yaml`.
147-
You choose `net-istio` as the ingress plugin, which is available at `https://my-net-istio/net-istio.yaml`.
148-
You can create the content of Serving CR as below:
146+
There are two modes available for you to install the customized manifests: overwrite mode and append mode. With the
147+
overwrite mode, you need to define all the manifests for Knative Serving to install, because the operator will no long
148+
install any available default manifests. With the append mode, you only need to define your customized manifests, and
149+
the customized manifests are installed, after default manifests are applied.
150+
151+
1. You can use the overwrite mode to customize all the Knative Serving manifests. For example, the version of the customized
152+
Knative Serving is `{{spec.version}}`, and it is available at `https://my-serving/serving.yaml`. You choose `net-istio`
153+
as the ingress plugin, which is available at `https://my-net-istio/net-istio.yaml`. You can create the content of Serving
154+
CR as below to install your Knative Serving and the istio ingress:
149155

150156
```
151157
apiVersion: v1
@@ -170,6 +176,30 @@ of links. The ordering of the URLs is critical. Put the manifest you want to app
170176
you to specify the version and the valid links to the customized Knative Serving, by leveraging both `spec.version`
171177
and `spec.manifests`. Do not skip either field.
172178

179+
1. You can use the append mode to add your customized manifests into the default manifests. For example, you only customize
180+
a few resources, and make them available at `https://my-serving/serving-custom.yaml`. You still need to install the default
181+
Knative Serving. In this case, you can create the content of Serving CR as below:
182+
183+
```
184+
apiVersion: v1
185+
kind: Namespace
186+
metadata:
187+
name: knative-serving
188+
---
189+
apiVersion: operator.knative.dev/v1alpha1
190+
kind: KnativeServing
191+
metadata:
192+
name: knative-serving
193+
namespace: knative-serving
194+
spec:
195+
version: {{spec.version}}
196+
additionalManifests:
197+
- URL: https://my-serving/serving-custom.yaml
198+
```
199+
200+
Knative operator will install the default manifests of Knative Serving at the version `{{spec.version}}`, and then install
201+
your customized manifests based on them.
202+
173203
{{< /tab >}}
174204

175205
{{< /tabs >}}
@@ -621,8 +651,14 @@ to apply first on the top.
621651
Knative Eventing based your own requirements. As long as the manifests of customized Knative Eventing are accessible to
622652
the operator, they can be installed.
623653
624-
For example, the version of the customized Knative Eventing is `{{spec.version}}`, and it is available at `https://my-eventing/eventing.yaml`.
625-
You can create the content of Eventing CR as below:
654+
There are two modes available for you to install the customized manifests: overwrite mode and append mode. With the
655+
overwrite mode, you need to define all the manifests for Knative Eventing to install, because the operator will no long
656+
install any available default manifests. With the append mode, you only need to define your customized manifests, and
657+
the customized manifests are installed, after default manifests are applied.
658+
659+
1. You can use the overwrite mode to customize all the Knative Eventing manifests. For example, the version of the customized
660+
Knative Eventing is `{{spec.version}}`, and it is available at `https://my-eventing/eventing.yaml`. You can create the
661+
content of Eventing CR as below to install your Knative Eventing:
626662
627663
```
628664
apiVersion: v1
@@ -646,6 +682,30 @@ of links. The ordering of the URLs is critical. Put the manifest you want to app
646682
you to specify the version and the valid links to the customized Knative Eventing, by leveraging both `spec.version`
647683
and `spec.manifests`. Do not skip either field.
648684
685+
1. You can use the append mode to add your customized manifests into the default manifests. For example, you only customize
686+
a few resources, and make them available at `https://my-eventing/eventing-custom.yaml`. You still need to install the default
687+
Knative eventing. In this case, you can create the content of Eventing CR as below:
688+
689+
```
690+
apiVersion: v1
691+
kind: Namespace
692+
metadata:
693+
name: knative-eventing
694+
---
695+
apiVersion: operator.knative.dev/v1alpha1
696+
kind: KnativeEventing
697+
metadata:
698+
name: knative-eventing
699+
namespace: knative-eventing
700+
spec:
701+
version: {{spec.version}}
702+
additionalManifests:
703+
- URL: https://my-eventing/eventing-custom.yaml
704+
```
705+
706+
Knative operator will install the default manifests of Knative Eventing at the version `{{spec.version}}`, and then install
707+
your customized manifests based on them.
708+
649709
{{< /tab >}}
650710
651711
{{< /tabs >}}

0 commit comments

Comments
 (0)