Skip to content

Commit 8b0e5e6

Browse files
committed
improve docs
1 parent a77b501 commit 8b0e5e6

File tree

9 files changed

+19
-0
lines changed

9 files changed

+19
-0
lines changed

api/v1alpha1/common_types.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ type RemoteSpec struct {
4848

4949
// GenerateCABundleContainer configures the init container that builds
5050
// the built-in CA store with the user-provided CA bundle or CA from TLS-enabled services.
51+
// If enabled is false, the operator does not add this init container, but when certificates or
52+
// TLS-enabled services are configured it still mounts /etc/ssl/certs so users can provide their
53+
// own init container to populate the trust store.
5154
type GenerateCABundleContainer struct {
5255
// (Optional) Enables the init container that builds the built-in CA store.
5356
// If not specified, the init container is enabled.

api/v1alpha1/database_types.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,8 @@ type DatabaseClusterSpec struct {
6868

6969
// (Optional) Configure the init container that builds the built-in CA store.
7070
// When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
71+
// If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
72+
// mounted so you can provide your own init container to populate the trust store.
7173
// If `enabled` is not specified, the init container is enabled.
7274
// +optional
7375
GenerateCABundleContainer *GenerateCABundleContainer `json:"generateCABundleContainer,omitempty"`

api/v1alpha1/storage_types.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ type StorageClusterSpec struct {
6262

6363
// (Optional) Configure the init container that builds the built-in CA store.
6464
// When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
65+
// If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
66+
// mounted so you can provide your own init container to populate the trust store.
6567
// If `enabled` is not specified, the init container is enabled.
6668
// +optional
6769
GenerateCABundleContainer *GenerateCABundleContainer `json:"generateCABundleContainer,omitempty"`

deploy/ydb-operator/crds/database.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1040,6 +1040,8 @@ spec:
10401040
description: |-
10411041
(Optional) Configure the init container that builds the built-in CA store.
10421042
When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
1043+
If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
1044+
mounted so you can provide your own init container to populate the trust store.
10431045
If `enabled` is not specified, the init container is enabled.
10441046
properties:
10451047
enabled:

deploy/ydb-operator/crds/databasenodeset.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1055,6 +1055,8 @@ spec:
10551055
description: |-
10561056
(Optional) Configure the init container that builds the built-in CA store.
10571057
When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
1058+
If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
1059+
mounted so you can provide your own init container to populate the trust store.
10581060
If `enabled` is not specified, the init container is enabled.
10591061
properties:
10601062
enabled:

deploy/ydb-operator/crds/remotedatabasenodeset.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1056,6 +1056,8 @@ spec:
10561056
description: |-
10571057
(Optional) Configure the init container that builds the built-in CA store.
10581058
When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
1059+
If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
1060+
mounted so you can provide your own init container to populate the trust store.
10591061
If `enabled` is not specified, the init container is enabled.
10601062
properties:
10611063
enabled:

deploy/ydb-operator/crds/remotestoragenodeset.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1210,6 +1210,8 @@ spec:
12101210
description: |-
12111211
(Optional) Configure the init container that builds the built-in CA store.
12121212
When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
1213+
If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
1214+
mounted so you can provide your own init container to populate the trust store.
12131215
If `enabled` is not specified, the init container is enabled.
12141216
properties:
12151217
enabled:

deploy/ydb-operator/crds/storage.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1209,6 +1209,8 @@ spec:
12091209
description: |-
12101210
(Optional) Configure the init container that builds the built-in CA store.
12111211
When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
1212+
If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
1213+
mounted so you can provide your own init container to populate the trust store.
12121214
If `enabled` is not specified, the init container is enabled.
12131215
properties:
12141216
enabled:

deploy/ydb-operator/crds/storagenodeset.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1209,6 +1209,8 @@ spec:
12091209
description: |-
12101210
(Optional) Configure the init container that builds the built-in CA store.
12111211
When any certificates or TLS-enabled services are configured, the shared cert volumes are added.
1212+
If `enabled=false`, the operator does not add this init container, but /etc/ssl/certs is still
1213+
mounted so you can provide your own init container to populate the trust store.
12121214
If `enabled` is not specified, the init container is enabled.
12131215
properties:
12141216
enabled:

0 commit comments

Comments
 (0)