You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -130,8 +131,8 @@ The `K8STLSSecret` store type is used to manage Kubernetes secrets of type `kube
130
131
This integration is compatible with Keyfactor Universal Orchestrator version 12.4 and later.
131
132
132
133
## 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
+
135
136
> 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.
136
137
137
138
## Requirements & Prerequisites
@@ -204,8 +205,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
209
208
#### Custom Fields Tab
210
209
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:
211
210
@@ -271,8 +270,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
276
273
#### Custom Fields Tab
277
274
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:
278
275
@@ -337,8 +334,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
342
337
#### Custom Fields Tab
343
338
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:
344
339
@@ -408,8 +403,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
413
406
#### Custom Fields Tab
414
407
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:
415
408
@@ -475,8 +468,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
480
471
#### Custom Fields Tab
481
472
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:
482
473
@@ -546,8 +537,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
551
540
#### Custom Fields Tab
552
541
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:
553
542
@@ -615,8 +604,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
> 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
-
620
607
#### Custom Fields Tab
621
608
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:
622
609
@@ -640,15 +627,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
640
627
641
628
## Installation
642
629
643
-
1. **Download the latest Kubernetes Universal Orchestrator extension from GitHub.**
630
+
1. **Download the latest Kubernetes Universal Orchestrator extension from GitHub.**
644
631
645
632
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.
646
633
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server |`rollForward` condition in`Orchestrator.runtimeconfig.json`|`k8s-orchestrator` .NET version to download |
| 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`|
652
639
|`11.6` _and_ newer |`net8.0`||`net8.0`|
653
640
654
641
Unzip the archive containing extension assemblies to a known location.
@@ -659,9 +646,9 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
659
646
660
647
* **Default on Windows** - `C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions`
661
648
* **Default on Linux** - `/opt/keyfactor/orchestrator/extensions`
662
-
649
+
663
650
3. **Create a new directory for the Kubernetes Universal Orchestrator extension inside the extensions directory.**
664
-
651
+
665
652
Create a new directory called `k8s-orchestrator`.
666
653
> The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.
667
654
@@ -672,13 +659,15 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
672
659
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
673
660
674
661
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.
675
665
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).
677
667
678
668
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).
680
670
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
682
671
683
672
684
673
## Defining Certificate Stores
@@ -687,7 +676,6 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
687
676
688
677
<details><summary>K8SCert (K8SCert)</summary>
689
678
690
-
691
679
* **Manually with the Command UI**
692
680
693
681
<details><summary>Create Certificate Stores manually in the UI</summary>
@@ -707,18 +695,21 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
707
695
| Store Path | |
708
696
| Orchestrator | Select an approved orchestrator capable of managing `K8SCert` certificates. Specifically, one with the `K8SCert` capability. |
709
697
| KubeNamespace | |
698
+
699
+
710
700
| KubeSecretName | |
701
+
702
+
711
703
| KubeSecretType | |
712
704
713
705
714
-
715
706
716
707
</details>
717
708
718
709
* **Using kfutil**
719
-
710
+
720
711
<details><summary>Create Certificate Stores with kfutil</summary>
721
-
712
+
722
713
1. **Generate a CSV template for the K8SCert certificate store**
723
714
724
715
```shell
@@ -739,16 +730,14 @@ The Kubernetes Universal Orchestrator extension implements 7 Certificate Store T
739
730
| KubeSecretType | |
740
731
741
732
742
-
743
-
744
733
3. **Import the CSV file to create the certificate stores**
> 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).
752
741
753
742
754
743
</details>
@@ -768,7 +757,7 @@ have specific keys in the Kubernetes secret.
768
757
769
758
770
759
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).
772
761
773
762
774
763
</details>
@@ -792,7 +781,7 @@ the certificate alias in the `jks` data store.
792
781
793
782
794
783
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).
796
785
797
786
798
787
</details>
@@ -813,7 +802,7 @@ have specific keys in the Kubernetes secret.
813
802
814
803
815
804
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).
817
806
818
807
819
808
</details>
@@ -837,7 +826,7 @@ the certificate alias in the `pkcs12` data store.
837
826
838
827
839
828
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).
841
830
842
831
843
832
</details>
@@ -851,7 +840,7 @@ the Kubernetes secret.
851
840
852
841
853
842
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).
855
844
856
845
857
846
</details>
@@ -865,7 +854,7 @@ the Kubernetes secret.
865
854
866
855
867
856
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).
Copy file name to clipboardExpand all lines: docsource/content.md
-4Lines changed: 0 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,10 +35,6 @@ The service account token can be provided to the extension in one of two ways:
35
35
To set up a service account user on your Kubernetes cluster to be used by the Kubernetes Orchestrator Extension. For full
36
36
information on the required permissions, see the [service account setup guide](./scripts/kubernetes/README.md).
37
37
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
-
42
38
## Discovery
43
39
44
40
**NOTE:** To use discovery jobs, you must have the story type created in Keyfactor Command and the `needs_server`
0 commit comments