Fix

Signed-off-by: Pavol Loffay <[email protected]>

Author: pavolloffay

apis/v1alpha1/instrumentation_types.go

@@ -97,7 +97,7 @@ type Resource struct {
 // Exporter defines OTLP exporter configuration.
 type Exporter struct {
 	// Endpoint is address of the collector with OTLP endpoint.
-	// The TLS is enabled
+	// If the endpoint defines https:// scheme TLS has to be specified.
 	// +optional
 	Endpoint string `json:"endpoint,omitempty"`
 
@@ -110,21 +110,22 @@ type Exporter struct {
 type TLS struct {
 	// SecretName defines secret name that will be used to configure TLS on the exporter.
 	// It is user responsibility to create the secret in the namespace of the workload.
-	// The secret should contain keys ca.crt, tls.key, tls.crt
+	// The secret must contain client certificate (Cert) and private key (Key).
+	// The CA certificate might be defined in the secret or in the config map.
 	SecretName string `json:"secretName,omitempty"`
 
 	// ConfigMapName defines configmap name with CA certificate. If it is not defined CA certificate will be
 	// used from the secret defined in SecretName.
 	ConfigMapName string `json:"configMapName,omitempty"`
 
-	// CA defines the key of certificate in the configmap map, secret or absolute path to a certificate.
+	// CA defines the key of certificate (e.g. ca.crt) in the configmap map, secret or absolute path to a certificate.
 	// The absolute path can be used when certificate is already present on the workload filesystem e.g.
 	// /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt
 	CA string `json:"ca,omitempty"`
-	// Cert defines the key of the client certificate in the secret or absolute path to a certificate.
+	// Cert defines the key (e.g. tls.crt) of the client certificate in the secret or absolute path to a certificate.
 	// The absolute path can be used when certificate is already present on the workload filesystem.
 	Cert string `json:"cert,omitempty"`
-	// Key defines a key of the private key in the secret or absolute path to a certificate.
+	// Key defines a key (e.g. tls.key) of the private key in the secret or absolute path to a certificate.
 	// The absolute path can be used when certificate is already present on the workload filesystem.
 	Key string `json:"key,omitempty"`
 }

docs/api.md

@@ -1626,7 +1626,7 @@ Exporter defines exporter configuration.
         <td>string</td>
         <td>
           Endpoint is address of the collector with OTLP endpoint.
-The TLS is enabled<br/>
+If the endpoint defines https:// scheme TLS has to be specified.<br/>
         </td>
         <td>false</td>
       </tr><tr>
@@ -1662,7 +1662,7 @@ TLS needs to be enabled by specifying https:// scheme in the Endpoint.
         <td><b>ca</b></td>
         <td>string</td>
         <td>
-          CA defines the key of certificate in the secret or absolute path to a certificate.
+          CA defines the key of certificate (e.g. ca.crt) in the configmap map, secret or absolute path to a certificate.
 The absolute path can be used when certificate is already present on the workload filesystem e.g.
 /var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt<br/>
         </td>
@@ -1671,25 +1671,34 @@ The absolute path can be used when certificate is already present on the workloa
         <td><b>cert</b></td>
         <td>string</td>
         <td>
-          Cert defines the key of the client certificate in the secret or absolute path to a certificate.
+          Cert defines the key (e.g. tls.crt) of the client certificate in the secret or absolute path to a certificate.
 The absolute path can be used when certificate is already present on the workload filesystem.<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b>configMapName</b></td>
+        <td>string</td>
+        <td>
+          ConfigMapName defines configmap name with CA certificate. If it is not defined CA certificate will be
+used from the secret defined in SecretName.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>key</b></td>
         <td>string</td>
         <td>
-          Key defines a key of the private key in the secret or absolute path to a certificate.
+          Key defines a key (e.g. tls.key) of the private key in the secret or absolute path to a certificate.
 The absolute path can be used when certificate is already present on the workload filesystem.<br/>
         </td>
         <td>false</td>
       </tr><tr>
         <td><b>secretName</b></td>
         <td>string</td>
         <td>
-          SecretName defines a secret name that will be used to configure TLS on the exporter.
+          SecretName defines secret name that will be used to configure TLS on the exporter.
 It is user responsibility to create the secret in the namespace of the workload.
-The secret should contain keys ca.crt, tls.key, tls.crt<br/>
+The secret must contain client certificate (Cert) and private key (Key).
+The CA certificate might be defined in the secret or in the config map.<br/>
         </td>
         <td>false</td>
       </tr></tbody>