Skip to content

Commit c420c75

Browse files
committed
chore(docs): Update docs
1 parent 105a7e9 commit c420c75

File tree

3 files changed

+32
-46
lines changed

3 files changed

+32
-46
lines changed

README.md

Lines changed: 29 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,9 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
6060

6161
### K8SCert
6262

63-
The `K8SCert` store type is used to manage Kubernetes certificates of type `certificates.k8s.io/v1`. *NOTE* only
64-
`inventory` of these resources is supported with this extension. To provision these certs use the
63+
The `K8SCert` store type is used to manage Kubernetes certificates of type `certificates.k8s.io/v1`.
64+
65+
**NOTE**: only `inventory` and `discovery` of these resources is supported with this extension. To provision these certs use the
6566
[k8s-csr-signer](https://github.com/Keyfactor/k8s-csr-signer).
6667
</details>
6768

@@ -130,8 +131,8 @@ The `K8STLSSecret` store type is used to manage Kubernetes secrets of type `kube
130131
This integration is compatible with Keyfactor Universal Orchestrator version 12.4 and later.
131132

132133
## Support
133-
The Kubernetes Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
134-
134+
The Kubernetes Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
135+
135136
> To report a problem or suggest a new feature, use the **[Issues](../../issues)** tab. If you want to contribute actual bug fixes or proposed enhancements, use the **[Pull requests](../../pulls)** tab.
136137
137138
## Requirements & Prerequisites
@@ -204,8 +205,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
204205

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

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-
209208
#### Custom Fields Tab
210209
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:
211210

@@ -271,8 +270,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
271270

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

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-
276273
#### Custom Fields Tab
277274
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:
278275

@@ -337,8 +334,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
337334

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

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-
342337
#### Custom Fields Tab
343338
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:
344339

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

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

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-
413406
#### Custom Fields Tab
414407
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:
415408

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

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

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-
480471
#### Custom Fields Tab
481472
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:
482473

@@ -546,8 +537,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
546537

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

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-
551540
#### Custom Fields Tab
552541
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:
553542

@@ -615,8 +604,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
615604

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

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-
620607
#### Custom Fields Tab
621608
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:
622609

@@ -640,15 +627,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
640627

641628
## Installation
642629

643-
1. **Download the latest Kubernetes Universal Orchestrator extension from GitHub.**
630+
1. **Download the latest Kubernetes Universal Orchestrator extension from GitHub.**
644631

645632
Navigate to the [Kubernetes Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/k8s-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive.
646633
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `k8s-orchestrator` .NET version to download |
647634
| --------- | ----------- | ----------- | ----------- |
648635
| Older than `11.0.0` | | | `net6.0` |
649-
| Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` |
650-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` |
651-
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
636+
| Between `11.0.0` and `11.5.1` (inclusive) | `net6.0` | | `net6.0` |
637+
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `Disable` | `net6.0` |
638+
| Between `11.0.0` and `11.5.1` (inclusive) | `net8.0` | `LatestMajor` | `net8.0` |
652639
| `11.6` _and_ newer | `net8.0` | | `net8.0` |
653640

654641
Unzip the archive containing extension assemblies to a known location.
@@ -659,9 +646,9 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
659646
660647
* **Default on Windows** - `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions`
661648
* **Default on Linux** - `/opt/keyfactor/orchestrator/extensions`
662-
649+
663650
3. **Create a new directory for the Kubernetes Universal Orchestrator extension inside the extensions directory.**
664-
651+
665652
Create a new directory called `k8s-orchestrator`.
666653
> The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.
667654
@@ -672,13 +659,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
672659
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
673660
674661
662+
6. **(optional) PAM Integration**
663+
664+
The Kubernetes Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.
675665
676-
> The above installation steps can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
666+
To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension, and follow the associated instructions to install it on the Universal Orchestrator (remote).
677667
678668
679-
## Post Installation
669+
> The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
680670
681-
TODO Post Installation is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
682671
683672
684673
## Defining Certificate Stores
@@ -687,7 +676,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
687676
688677
<details><summary>K8SCert (K8SCert)</summary>
689678
690-
691679
* **Manually with the Command UI**
692680
693681
<details><summary>Create Certificate Stores manually in the UI</summary>
@@ -707,18 +695,21 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
707695
| Store Path | |
708696
| Orchestrator | Select an approved orchestrator capable of managing `K8SCert` certificates. Specifically, one with the `K8SCert` capability. |
709697
| KubeNamespace | |
698+
699+
710700
| KubeSecretName | |
701+
702+
711703
| KubeSecretType | |
712704
713705
714-
715706
716707
</details>
717708
718709
* **Using kfutil**
719-
710+
720711
<details><summary>Create Certificate Stores with kfutil</summary>
721-
712+
722713
1. **Generate a CSV template for the K8SCert certificate store**
723714
724715
```shell
@@ -739,16 +730,14 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
739730
| KubeSecretType | |
740731
741732
742-
743-
744733
3. **Import the CSV file to create the certificate stores**
745734
746735
```shell
747736
kfutil stores import csv --store-type-name K8SCert --file K8SCert.csv
748737
```
749738
</details>
750739
751-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
740+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
752741
753742
754743
</details>
@@ -768,7 +757,7 @@ have specific keys in the Kubernetes secret.
768757
769758
770759
771-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
760+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
772761
773762
774763
</details>
@@ -792,7 +781,7 @@ the certificate alias in the `jks` data store.
792781
793782
794783
795-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
784+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
796785
797786
798787
</details>
@@ -813,7 +802,7 @@ have specific keys in the Kubernetes secret.
813802
814803
815804
816-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
805+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
817806
818807
819808
</details>
@@ -837,7 +826,7 @@ the certificate alias in the `pkcs12` data store.
837826
838827
839828
840-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
829+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
841830
842831
843832
</details>
@@ -851,7 +840,7 @@ the Kubernetes secret.
851840
852841
853842
854-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
843+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
855844
856845
857846
</details>
@@ -865,7 +854,7 @@ the Kubernetes secret.
865854
866855
867856
868-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
857+
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
869858
870859
871860
</details>

docsource/content.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,6 @@ The service account token can be provided to the extension in one of two ways:
3535
To set up a service account user on your Kubernetes cluster to be used by the Kubernetes Orchestrator Extension. For full
3636
information on the required permissions, see the [service account setup guide](./scripts/kubernetes/README.md).
3737

38-
## Post Installation
39-
40-
TODO Post Installation is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
41-
4238
## Discovery
4339

4440
**NOTE:** To use discovery jobs, you must have the story type created in Keyfactor Command and the `needs_server`

docsource/k8scert.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
## Overview
22

3-
The `K8SCert` store type is used to manage Kubernetes certificates of type `certificates.k8s.io/v1`. *NOTE* only
4-
`inventory` of these resources is supported with this extension. To provision these certs use the
3+
The `K8SCert` store type is used to manage Kubernetes certificates of type `certificates.k8s.io/v1`.
4+
5+
**NOTE**: only `inventory` and `discovery` of these resources is supported with this extension. To provision these certs use the
56
[k8s-csr-signer](https://github.com/Keyfactor/k8s-csr-signer).
67

0 commit comments

Comments
 (0)