Skip to content

Commit 6e44128

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 89c24ef commit 6e44128

File tree

1 file changed

+25
-13
lines changed

1 file changed

+25
-13
lines changed

README.md

Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,7 @@ should all require unique credentials.*
9292
### K8SNS
9393

9494
The `K8SNS` store type is used to manage Kubernetes secrets of type `kubernetes.io/tls` and/or type `Opaque` in a single
95-
Keyfactor Command certificate store using an alias pattern of
96-
97-
**NOTE**: This store type will only inventory K8S secrets that contain the keys `tls.crt` and `tls.key`.
95+
Keyfactor Command certificate store using an alias pattern of
9896
</details>
9997

10098
<details><summary>K8SPKCS12 (K8SPKCS12)</summary>
@@ -206,13 +204,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
206204

207205
![K8SCert Advanced Tab](docsource/images/K8SCert-advanced-store-type-dialog.png)
208206

207+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
208+
209209
#### Custom Fields Tab
210210
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
211211

212212
| Name | Display Name | Description | Type | Default Value/Options | Required |
213213
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
214214
| KubeNamespace | KubeNamespace | | String | default | 🔲 Unchecked |
215-
| KubeSecretName | KubeSecretName | | String | None | 🔲 Unchecked |
215+
| KubeSecretName | KubeSecretName | | String | | 🔲 Unchecked |
216216
| KubeSecretType | KubeSecretType | | String | cert | ✅ Checked |
217217

218218
The Custom Fields tab should look like this:
@@ -271,6 +271,8 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
271271

272272
![K8SCluster Advanced Tab](docsource/images/K8SCluster-advanced-store-type-dialog.png)
273273

274+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
275+
274276
#### Custom Fields Tab
275277
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
276278

@@ -335,18 +337,20 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
335337

336338
![K8SJKS Advanced Tab](docsource/images/K8SJKS-advanced-store-type-dialog.png)
337339

340+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
341+
338342
#### Custom Fields Tab
339343
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
340344

341345
| Name | Display Name | Description | Type | Default Value/Options | Required |
342346
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
343347
| KubeNamespace | KubeNamespace | | String | default | 🔲 Unchecked |
344-
| KubeSecretName | KubeSecretName | | String | None | 🔲 Unchecked |
348+
| KubeSecretName | KubeSecretName | | String | | 🔲 Unchecked |
345349
| KubeSecretType | KubeSecretType | | String | jks | ✅ Checked |
346350
| CertificateDataFieldName | CertificateDataFieldName | | String | .jks | ✅ Checked |
347351
| PasswordFieldName | PasswordFieldName | | String | password | 🔲 Unchecked |
348352
| PasswordIsK8SSecret | Password Is K8S Secret | | Bool | false | 🔲 Unchecked |
349-
| StorePasswordPath | StorePasswordPath | | String | None | 🔲 Unchecked |
353+
| StorePasswordPath | StorePasswordPath | | String | | 🔲 Unchecked |
350354

351355
The Custom Fields tab should look like this:
352356

@@ -404,6 +408,8 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
404408

405409
![K8SNS Advanced Tab](docsource/images/K8SNS-advanced-store-type-dialog.png)
406410

411+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
412+
407413
#### Custom Fields Tab
408414
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
409415

@@ -469,6 +475,8 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
469475

470476
![K8SPKCS12 Advanced Tab](docsource/images/K8SPKCS12-advanced-store-type-dialog.png)
471477

478+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
479+
472480
#### Custom Fields Tab
473481
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
474482

@@ -479,8 +487,8 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
479487
| PasswordFieldName | Password Field Name | | String | password | 🔲 Unchecked |
480488
| PasswordIsK8SSecret | Password Is K8S Secret | | Bool | false | 🔲 Unchecked |
481489
| KubeNamespace | Kube Namespace | | String | default | 🔲 Unchecked |
482-
| KubeSecretName | Kube Secret Name | | String | None | 🔲 Unchecked |
483-
| StorePasswordPath | StorePasswordPath | | String | None | 🔲 Unchecked |
490+
| KubeSecretName | Kube Secret Name | | String | | 🔲 Unchecked |
491+
| StorePasswordPath | StorePasswordPath | | String | | 🔲 Unchecked |
484492

485493
The Custom Fields tab should look like this:
486494

@@ -538,13 +546,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
538546

539547
![K8SSecret Advanced Tab](docsource/images/K8SSecret-advanced-store-type-dialog.png)
540548

549+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
550+
541551
#### Custom Fields Tab
542552
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
543553

544554
| Name | Display Name | Description | Type | Default Value/Options | Required |
545555
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
546-
| KubeNamespace | KubeNamespace | | String | None | 🔲 Unchecked |
547-
| KubeSecretName | KubeSecretName | | String | None | 🔲 Unchecked |
556+
| KubeNamespace | KubeNamespace | | String | | 🔲 Unchecked |
557+
| KubeSecretName | KubeSecretName | | String | | 🔲 Unchecked |
548558
| KubeSecretType | KubeSecretType | | String | secret | ✅ Checked |
549559
| SeparateChain | Separate Certificate Chain | | Bool | false | 🔲 Unchecked |
550560
| IncludeCertChain | Include Certificate Chain | | Bool | true | 🔲 Unchecked |
@@ -605,13 +615,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
605615

606616
![K8STLSSecr Advanced Tab](docsource/images/K8STLSSecr-advanced-store-type-dialog.png)
607617

618+
> For Keyfactor **Command versions 24.4 and later**, a Certificate Format dropdown is available with PFX and PEM options. Ensure that **PFX** is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
619+
608620
#### Custom Fields Tab
609621
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
610622

611623
| Name | Display Name | Description | Type | Default Value/Options | Required |
612624
| ---- | ------------ | ---- | --------------------- | -------- | ----------- |
613-
| KubeNamespace | KubeNamespace | | String | None | 🔲 Unchecked |
614-
| KubeSecretName | KubeSecretName | | String | None | 🔲 Unchecked |
625+
| KubeNamespace | KubeNamespace | | String | | 🔲 Unchecked |
626+
| KubeSecretName | KubeSecretName | | String | | 🔲 Unchecked |
615627
| KubeSecretType | KubeSecretType | | String | tls_secret | ✅ Checked |
616628
| SeparateChain | Separate Certificate Chain | | Bool | false | 🔲 Unchecked |
617629
| IncludeCertChain | Include Certificate Chain | | Bool | true | 🔲 Unchecked |
@@ -743,7 +755,7 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
743755

744756
<details><summary>K8SCluster (K8SCluster)</summary>
745757

746-
In order for certificates of type `Opaque` and/or `kubernetes.io/tls` to be inventoried in `K8SCLUSTER` store types, they must
758+
In order for certificates of type `Opaque` and/or `kubernetes.io/tls` to be inventoried in `K8SCluster` store types, they must
747759
have specific keys in the Kubernetes secret.
748760
- Required keys: `tls.crt` or `ca.crt`
749761
- Additional keys: `tls.key`

0 commit comments

Comments
 (0)