Skip to content

Commit 862efcf

Browse files
(DOCSP-12102): update tls ca settings (#366)
* (DOCSP-12102): update tls ca settings * (DOCSP-12102): update om https deployment procedure * (DOCSP-12102): language tweaks
1 parent c860d05 commit 862efcf

File tree

3 files changed

+50
-5
lines changed

3 files changed

+50
-5
lines changed

source/includes/steps-deploy-k8s-opsmgr-https.yaml

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ content: |
3636
3737
kubectl create secret generic om-http-cert --from-file="server.pem" -n <namespace>
3838
---
39-
title: "If necessary, validate your TLS Certificate"
39+
title: "If necessary, validate your TLS Certificate."
4040
stepnum: 4
4141
ref: validate-tls-cert
4242
content: |
@@ -68,7 +68,7 @@ content: |
6868
.. literalinclude:: /reference/k8s/example-opsmgr-https.yaml
6969
:language: yaml
7070
:linenos:
71-
:emphasize-lines: 5,7-11,15-17,19,21-23
71+
:emphasize-lines: 5,7-11,14-18,20,22-24
7272
7373
---
7474
title: "Open your preferred text editor and paste the |k8s-obj| specification into a new text file."
@@ -135,6 +135,21 @@ content: |
135135
136136
- ``om-admin-secret``
137137
138+
* - | ``spec``
139+
| ``.security``
140+
| ``.tls``
141+
| ``.``:opsmgrkube:`~spec.security.tls.ca`
142+
- string
143+
- Name of the |k8s-configmap| you created to verify |tls|
144+
certificates signed using a Custom Certificate Authority.
145+
146+
.. important::
147+
148+
This field is required if you signed your |tls|
149+
certificates using a Custom Certificate Authority.
150+
151+
- ``om-http-cert-ca``
152+
138153
* - | ``spec``
139154
| ``.security``
140155
| ``.tls``

source/reference/k8s-operator-om-specification.txt

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -187,12 +187,25 @@ Optional |onprem| Resource Settings
187187
Name of the |k8s| |k8s-configmap| containing the |certauth| file for
188188
the application database.
189189

190+
.. important::
191+
192+
:opsmgrkube:`spec.applicationDatabase.security.tls.ca` is required
193+
if you use a Custom Certificate Authority to sign your application
194+
database |tls| certificates.
195+
196+
This |certauth| signs the certificates that:
197+
198+
- the application database replica set members use to communicate
199+
with one another, and
200+
- |onprem| uses to communicate with the application database replica
201+
set.
202+
190203
.. opsmgrkube:: spec.applicationDatabase.security.tls.secretRef.name
191204

192205
*Type*: string
193206

194-
Name of the |k8s| |k8s-secret| object created to secure the
195-
application database resources.
207+
Name of the |k8s| |k8s-secret| you created to secure the application
208+
database resources.
196209

197210
.. opsmgrkube:: spec.backup.enabled
198211

@@ -810,11 +823,27 @@ Optional |onprem| Resource Settings
810823
|application| based on the container's memory. Changing the
811824
``-Xms`` and ``-Xmx`` values can cause issues with |onprem|.
812825

826+
.. opsmgrkube:: spec.security.tls.ca
827+
828+
Name of the |k8s| |k8s-configmap| that contains a custom |certauth|
829+
file for |onprem|.
830+
831+
.. important::
832+
833+
:opsmgrkube:`spec.security.tls.ca` is required if you use a Custom
834+
Certificate Authority to sign your |onprem| |tls| certificates.
835+
836+
This |certauth| signs the certificates that:
837+
838+
- clients use to connect to the |application|, and
839+
- agents in the application database |k8s-pods| use to communicate
840+
with |onprem|.
841+
813842
.. opsmgrkube:: spec.security.tls.secretRef.name
814843

815844
*Type*: string
816845

817-
Name of the |k8s| |k8s-secret| you created for your |tls|
846+
Name of the |k8s| |k8s-secret| you created for your |onprem| |tls|
818847
certificate. Used when creating an |onprem| instance which runs
819848
over |https|.
820849

source/reference/k8s/example-opsmgr-https.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ spec:
1111
# for the admin user
1212
security:
1313
tls:
14+
ca: <om-http-cert-ca>
1415
secretRef:
1516
name: <tlscertificate> # Should match metadata.name
1617
# in the Kubernetes secret

0 commit comments

Comments
 (0)