Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix documentation for ClientSSLCertSecret and ServerSSLCertSecret #840

Merged
merged 3 commits into from
Aug 2, 2022
Merged

Fix documentation for ClientSSLCertSecret and ServerSSLCertSecret #840

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9562310
Fix documentation for ClientSSLCertSecret and ServerSSLCertSecret
bartam1 Jul 28, 2022
36415f0
Refactor 1
bartam1 Jul 28, 2022
a58fa30
Merge branch 'master' into fixdocssslcert
panyuenlau Jul 29, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions api/v1beta1/kafkacluster_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,8 +98,9 @@ type KafkaClusterSpec struct {
// It will be used by the koperator, cruise control, cruise control metrics reporter
// to communicate on SSL with that internal listener which is used for interbroker communication.
// The client certificate must share the same chain of trust as the server certificate used by the corresponding internal listener.
// The secret must contains the keystore, truststore jks files and the password for them in base64 encoded format
// under the keystore.jks, truststore.jks, password data fields.
// The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format and
// the tls certificate, tls private key, CA certificate in PEM format with base64 encoded
// under the keystore.jks, truststore.jks, password, tls.crt, tls.key, and ca.crt data fields.
ClientSSLCertSecret *corev1.LocalObjectReference `json:"clientSSLCertSecret,omitempty"`
}

Expand Down Expand Up @@ -517,8 +518,9 @@ type CommonListenerSpec struct {
// +kubebuilder:validation:Enum=ssl;plaintext;sasl_ssl;sasl_plaintext
Type SecurityProtocol `json:"type"`
// ServerSSLCertSecret is a reference to the Kubernetes secret that contains the server certificate for the listener to be used for SSL communication.
// The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format
// under the keystore.jks, truststore.jks, password data fields.
// The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format under the keystore.jks, truststore.jks, password data fields.
// When the listener is used for inner broker or controller communication the tls certificate is
// also needed in PEM format with base64 encoding under the tls.crt data field.
// If this field is omitted koperator will auto-create a self-signed server certificate using the configuration provided in 'sslSecrets' field.
ServerSSLCertSecret *corev1.LocalObjectReference `json:"serverSSLCertSecret,omitempty"`
// SSLClientAuth specifies whether client authentication is required, requested, or not required.
Expand Down
17 changes: 12 additions & 5 deletions charts/kafka-operator/templates/crds.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12257,10 +12257,11 @@ spec:
reporter to communicate on SSL with that internal listener which
is used for interbroker communication. The client certificate must
share the same chain of trust as the server certificate used by
the corresponding internal listener. The secret must contains the
the corresponding internal listener. The secret must contain the
keystore, truststore jks files and the password for them in base64
encoded format under the keystore.jks, truststore.jks, password
data fields.
encoded format and the tls certificate, tls private key, CA certificate
in PEM format with base64 encoded under the keystore.jks, truststore.jks,
password, tls.crt, tls.key, and ca.crt data fields.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Expand Down Expand Up @@ -19297,7 +19298,10 @@ spec:
to be used for SSL communication. The secret must contain
the keystore, truststore jks files and the password for
them in base64 encoded format under the keystore.jks,
truststore.jks, password data fields. If this field is
truststore.jks, password data fields. When the listener
is used for inner broker or controller communication the
tls certificate is also needed in PEM format with base64
encoding under the tls.crt data field. If this field is
omitted koperator will auto-create a self-signed server
certificate using the configuration provided in 'sslSecrets'
field.
Expand Down Expand Up @@ -19363,7 +19367,10 @@ spec:
to be used for SSL communication. The secret must contain
the keystore, truststore jks files and the password for
them in base64 encoded format under the keystore.jks,
truststore.jks, password data fields. If this field is
truststore.jks, password data fields. When the listener
is used for inner broker or controller communication the
tls certificate is also needed in PEM format with base64
encoding under the tls.crt data field. If this field is
omitted koperator will auto-create a self-signed server
certificate using the configuration provided in 'sslSecrets'
field.
Expand Down
17 changes: 12 additions & 5 deletions config/base/crds/kafka.banzaicloud.io_kafkaclusters.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12256,10 +12256,11 @@ spec:
reporter to communicate on SSL with that internal listener which
is used for interbroker communication. The client certificate must
share the same chain of trust as the server certificate used by
the corresponding internal listener. The secret must contains the
the corresponding internal listener. The secret must contain the
keystore, truststore jks files and the password for them in base64
encoded format under the keystore.jks, truststore.jks, password
data fields.
encoded format and the tls certificate, tls private key, CA certificate
in PEM format with base64 encoded under the keystore.jks, truststore.jks,
password, tls.crt, tls.key, and ca.crt data fields.
properties:
name:
description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Expand Down Expand Up @@ -19296,7 +19297,10 @@ spec:
to be used for SSL communication. The secret must contain
the keystore, truststore jks files and the password for
them in base64 encoded format under the keystore.jks,
truststore.jks, password data fields. If this field is
truststore.jks, password data fields. When the listener
is used for inner broker or controller communication the
tls certificate is also needed in PEM format with base64
encoding under the tls.crt data field. If this field is
omitted koperator will auto-create a self-signed server
certificate using the configuration provided in 'sslSecrets'
field.
Expand Down Expand Up @@ -19362,7 +19366,10 @@ spec:
to be used for SSL communication. The secret must contain
the keystore, truststore jks files and the password for
them in base64 encoded format under the keystore.jks,
truststore.jks, password data fields. If this field is
truststore.jks, password data fields. When the listener
is used for inner broker or controller communication the
tls certificate is also needed in PEM format with base64
encoding under the tls.crt data field. If this field is
omitted koperator will auto-create a self-signed server
certificate using the configuration provided in 'sslSecrets'
field.
Expand Down