Skip to content

Commit a450af0

Browse files
authored
docs: improve old changelog entry (#5078)
docs: Change patch to being commented-out by default. This is to match scaffolding code. Fixes #5073 Signed-off-by: Marcin Owsiany <[email protected]>
1 parent 2a9d830 commit a450af0

File tree

2 files changed

+41
-35
lines changed

2 files changed

+41
-35
lines changed

website/content/en/docs/upgrading-sdk-version/v1.6.0.md

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -122,24 +122,26 @@ _See [#4655](https://github.com/operator-framework/operator-sdk/pull/4655) for m
122122
OLM does [not yet support cert-manager](https://olm.operatorframework.io/docs/advanced-tasks/adding-admission-and-conversion-webhooks/#certificate-authority-requirements), so a JSON patch was added to remove this volume and mount such that OLM can itself create and manage certs for your Operator.
123123
In `config/manifests/kustomization.yaml`, add the following:
124124
```yaml
125-
patchesJson6902:
126-
- target:
127-
group: apps
128-
version: v1
129-
kind: Deployment
130-
name: controller-manager
131-
namespace: system
132-
patch: |-
133-
# Remove the manager container's "cert" volumeMount, since OLM will create and mount a set of certs.
134-
# Update the indices in this path if adding or removing containers/volumeMounts in the manager's Deployment.
135-
- op: remove
136-
path: /spec/template/spec/containers/1/volumeMounts/0
137-
# Remove the "cert" volume, since OLM will create and mount a set of certs.
138-
# Update the indices in this path if adding or removing volumes in the manager's Deployment.
139-
- op: remove
140-
path: /spec/template/spec/volumes/0
125+
#patchesJson6902:
126+
#- target:
127+
# group: apps
128+
# version: v1
129+
# kind: Deployment
130+
# name: controller-manager
131+
# namespace: system
132+
# patch: |-
133+
# # Remove the manager container's "cert" volumeMount, since OLM will create and mount a set of certs.
134+
# # Update the indices in this path if adding or removing containers/volumeMounts in the manager's Deployment.
135+
# - op: remove
136+
# path: /spec/template/spec/containers/1/volumeMounts/0
137+
# # Remove the "cert" volume, since OLM will create and mount a set of certs.
138+
# # Update the indices in this path if adding or removing volumes in the manager's Deployment.
139+
# - op: remove
140+
# path: /spec/template/spec/volumes/0
141141
```
142142

143+
If you have configured your operator to use webhooks, add this YAML block uncommented.
144+
143145
_See [#4623](https://github.com/operator-framework/operator-sdk/pull/4623) for more details._
144146

145147
## (go/v2, go/v3, ansible/v1, helm/v1) Add scheme, token, and TLS config to the Prometheus `ServiceMonitor` metrics endpoint.
@@ -217,7 +219,8 @@ _See [#4406](https://github.com/operator-framework/operator-sdk/pull/4406) for m
217219

218220
## (ansible/v1, helm/v1) Add the `controller-manager` ServiceAccount to your project.
219221

220-
A non-default ServiceAccount `controller-manager` is scaffolded on `operator-sdk init`, to improve security for operators installed in shared namespaces. To add this ServiceAccount to your project, do the following: ```sh
222+
A non-default ServiceAccount `controller-manager` is scaffolded on `operator-sdk init`, to improve security for operators installed in shared namespaces. To add this ServiceAccount to your project, do the following:
223+
```sh
221224
# Create the ServiceAccount.
222225
cat <<EOF > config/rbac/service_account.yaml apiVersion: v1
223226
kind: ServiceAccount

website/content/en/docs/upgrading-sdk-version/v1.6.1.md

Lines changed: 21 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -122,24 +122,26 @@ _See [#4655](https://github.com/operator-framework/operator-sdk/pull/4655) for m
122122
OLM does [not yet support cert-manager](https://olm.operatorframework.io/docs/advanced-tasks/adding-admission-and-conversion-webhooks/#certificate-authority-requirements), so a JSON patch was added to remove this volume and mount such that OLM can itself create and manage certs for your Operator.
123123
In `config/manifests/kustomization.yaml`, add the following:
124124
```yaml
125-
patchesJson6902:
126-
- target:
127-
group: apps
128-
version: v1
129-
kind: Deployment
130-
name: controller-manager
131-
namespace: system
132-
patch: |-
133-
# Remove the manager container's "cert" volumeMount, since OLM will create and mount a set of certs.
134-
# Update the indices in this path if adding or removing containers/volumeMounts in the manager's Deployment.
135-
- op: remove
136-
path: /spec/template/spec/containers/1/volumeMounts/0
137-
# Remove the "cert" volume, since OLM will create and mount a set of certs.
138-
# Update the indices in this path if adding or removing volumes in the manager's Deployment.
139-
- op: remove
140-
path: /spec/template/spec/volumes/0
125+
#patchesJson6902:
126+
#- target:
127+
# group: apps
128+
# version: v1
129+
# kind: Deployment
130+
# name: controller-manager
131+
# namespace: system
132+
# patch: |-
133+
# # Remove the manager container's "cert" volumeMount, since OLM will create and mount a set of certs.
134+
# # Update the indices in this path if adding or removing containers/volumeMounts in the manager's Deployment.
135+
# - op: remove
136+
# path: /spec/template/spec/containers/1/volumeMounts/0
137+
# # Remove the "cert" volume, since OLM will create and mount a set of certs.
138+
# # Update the indices in this path if adding or removing volumes in the manager's Deployment.
139+
# - op: remove
140+
# path: /spec/template/spec/volumes/0
141141
```
142142

143+
If you have configured your operator to use webhooks, add this YAML block uncommented.
144+
143145
_See [#4623](https://github.com/operator-framework/operator-sdk/pull/4623) for more details._
144146

145147
## (go/v2, go/v3, ansible/v1, helm/v1) Add scheme, token, and TLS config to the Prometheus `ServiceMonitor` metrics endpoint.
@@ -217,7 +219,8 @@ _See [#4406](https://github.com/operator-framework/operator-sdk/pull/4406) for m
217219

218220
## (ansible/v1, helm/v1) Add the `controller-manager` ServiceAccount to your project.
219221

220-
A non-default ServiceAccount `controller-manager` is scaffolded on `operator-sdk init`, to improve security for operators installed in shared namespaces. To add this ServiceAccount to your project, do the following: ```sh
222+
A non-default ServiceAccount `controller-manager` is scaffolded on `operator-sdk init`, to improve security for operators installed in shared namespaces. To add this ServiceAccount to your project, do the following:
223+
```sh
221224
# Create the ServiceAccount.
222225
cat <<EOF > config/rbac/service_account.yaml apiVersion: v1
223226
kind: ServiceAccount
@@ -277,4 +280,4 @@ The changes should look like:
277280
+ namespace: system
278281
```
279282

280-
_See [#4653](https://github.com/operator-framework/operator-sdk/pull/4653) for more details._
283+
_See [#4653](https://github.com/operator-framework/operator-sdk/pull/4653) for more details._

0 commit comments

Comments
 (0)