Fix documentation for ClientSSLCertSecret and ServerSSLCertSecret #840
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
panyuenlau
previously approved these changes
Jul 28, 2022
api/v1beta1/kafkacluster_types.go
Outdated
| // 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 and base64 encoded format |
There was a problem hiding this comment.
Suggested change
| // the tls certificate, tls private key, CA certificate in PEM and base64 encoded format | |
| // the tls certificate, tls private key, CA certificate in PEM format with base64 encoding |
api/v1beta1/kafkacluster_types.go
Outdated
| @@ -510,7 +511,7 @@ 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 | |||
| // The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format and the tls certificate in PEM and base64 encoded format | |||
There was a problem hiding this comment.
Suggested change
| // The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format and the tls certificate in PEM and base64 encoded format | |
| // The secret must contain the keystore, truststore jks files and the password for them in base64 encoded format and the tls certificate in PEM format with base64 encoding |
pregnor
previously approved these changes
Jul 28, 2022
stoader
requested changes
Jul 28, 2022
stoader
approved these changes
Jul 29, 2022
panyuenlau
approved these changes
Jul 29, 2022
|
@bartam1 Can we merge this? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's in this PR?
It fixes the documentation for the ClientSSLCertSecret and ServerSSLCertSecret.
Why?
The secrets which are referenced by the ClientSSLCertSecret and ServerSSLCertSecret need to contain other fields than the keystore.jks, truststore.jks and password when they are used for inner broker or controller communication