Doc: Updating Connection Docs for SSL in UI for Messaging & Dashboard (…

…#17592)
open-metadata · Sep 2, 2024 · 4491396 · 4491396
1 parent d74cbed
commit 4491396
Show file tree

Hide file tree

Showing 3 changed files with 46 additions and 4 deletions.
diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/QlikSense.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/QlikSense.md
@@ -108,6 +108,20 @@ You will have to replace new lines with `\n` and the final private key that you
 ```
 $$
 
+$$section
+### SSL CA $(id="caCertificate")
+The CA certificate used for SSL validation.
+$$
+
+$$section
+### SSL Certificate $(id="sslCertificate")
+The SSL certificate used for client authentication.
+$$
+
+$$section
+### SSL Key $(id="sslKey")
+The private key associated with the SSL certificate.
+$$
 
 $$section
 ### Staging Directory Path $(id="stagingDir")

diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/Tableau.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Dashboard/Tableau.md
@@ -109,9 +109,16 @@ Client SSL configuration in case we are connection to a host with SSL enabled.
 $$
 
 $$section
-### Certificate Path $(id="certificatePath")
-
-CA certificate path in the instance where the ingestion run. E.g., `/path/to/public.cert`. 
+### SSL CA $(id="caCertificate")
+The CA certificate used for SSL validation.
+$$
 
-Will be used if Verify SSL is set to `validate`.
+$$section
+### SSL Certificate $(id="sslCertificate")
+The SSL certificate used for client authentication.
 $$
+
+$$section
+### SSL Key $(id="sslKey")
+The private key associated with the SSL certificate.
+$$
diff --git a/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Messaging/Kafka.md b/openmetadata-ui/src/main/resources/ui/public/locales/en-US/Messaging/Kafka.md
@@ -81,3 +81,24 @@ $$section
 
 The accepted additional values for the Schema Registry configuration can be found in the following [link](https://docs.confluent.io/5.5.1/clients/confluent-kafka-python/index.html#confluent_kafka.schema_registry.SchemaRegistryClient).
 $$
+
+$$section
+### SSL Config $(id="sslConfig")
+
+Client SSL configuration in case we are connection to a host with SSL enabled.
+$$
+
+$$section
+### SSL CA $(id="caCertificate")
+The CA certificate used for SSL validation.
+$$
+
+$$section
+### SSL Certificate $(id="sslCertificate")
+The SSL certificate used for client authentication.
+$$
+
+$$section
+### SSL Key $(id="sslKey")
+The private key associated with the SSL certificate.
+$$