Skip to content

Commit 0dde4db

Browse files
committed
Fix
Signed-off-by: Pavol Loffay <[email protected]>
1 parent 441fcdd commit 0dde4db

File tree

1 file changed

+65
-1
lines changed

1 file changed

+65
-1
lines changed

docs/api.md

+65-1
Original file line numberDiff line numberDiff line change
@@ -1625,7 +1625,71 @@ Exporter defines exporter configuration.
16251625
<td><b>endpoint</b></td>
16261626
<td>string</td>
16271627
<td>
1628-
Endpoint is address of the collector with OTLP endpoint.<br/>
1628+
Endpoint is address of the collector with OTLP endpoint.
1629+
The TLS is enabled<br/>
1630+
</td>
1631+
<td>false</td>
1632+
</tr><tr>
1633+
<td><b><a href="#instrumentationspecexportertls">tls</a></b></td>
1634+
<td>object</td>
1635+
<td>
1636+
TLS defines certificates for TLS.
1637+
TLS needs to be enabled by specifying https:// scheme in the Endpoint.<br/>
1638+
</td>
1639+
<td>false</td>
1640+
</tr></tbody>
1641+
</table>
1642+
1643+
1644+
### Instrumentation.spec.exporter.tls
1645+
<sup><sup>[↩ Parent](#instrumentationspecexporter)</sup></sup>
1646+
1647+
1648+
1649+
TLS defines certificates for TLS.
1650+
TLS needs to be enabled by specifying https:// scheme in the Endpoint.
1651+
1652+
<table>
1653+
<thead>
1654+
<tr>
1655+
<th>Name</th>
1656+
<th>Type</th>
1657+
<th>Description</th>
1658+
<th>Required</th>
1659+
</tr>
1660+
</thead>
1661+
<tbody><tr>
1662+
<td><b>ca</b></td>
1663+
<td>string</td>
1664+
<td>
1665+
CA defines the key of certificate in the secret or absolute path to a certificate.
1666+
The absolute path can be used when certificate is already present on the workload filesystem e.g.
1667+
/var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt<br/>
1668+
</td>
1669+
<td>false</td>
1670+
</tr><tr>
1671+
<td><b>cert</b></td>
1672+
<td>string</td>
1673+
<td>
1674+
Cert defines the key of the client certificate in the secret or absolute path to a certificate.
1675+
The absolute path can be used when certificate is already present on the workload filesystem.<br/>
1676+
</td>
1677+
<td>false</td>
1678+
</tr><tr>
1679+
<td><b>key</b></td>
1680+
<td>string</td>
1681+
<td>
1682+
Key defines a key of the private key in the secret or absolute path to a certificate.
1683+
The absolute path can be used when certificate is already present on the workload filesystem.<br/>
1684+
</td>
1685+
<td>false</td>
1686+
</tr><tr>
1687+
<td><b>secretName</b></td>
1688+
<td>string</td>
1689+
<td>
1690+
SecretName defines a secret name that will be used to configure TLS on the exporter.
1691+
It is user responsibility to create the secret in the namespace of the workload.
1692+
The secret should contain keys ca.crt, tls.key, tls.crt<br/>
16291693
</td>
16301694
<td>false</td>
16311695
</tr></tbody>

0 commit comments

Comments
 (0)