Support · Installation · License · Related Integrations
The Kubernetes Orchestrator allows for the remote management of certificate stores defined in a Kubernetes cluster.
The following types of Kubernetes resources are supported: kubernetes secrets of kubernetes.io/tls or Opaque and
kubernetes certificates certificates.k8s.io/v1
The certificate store types that can be managed in the current version are:
K8SCert- Kubernetes certificates of typecertificates.k8s.io/v1K8SSecret- Kubernetes secrets of typeOpaqueK8STLSSecret- Kubernetes secrets of typekubernetes.io/tlsK8SCluster- This allows for a single store to manage a k8s cluster's secrets or typeOpaqueandkubernetes.io/tls. This can be thought of as a container ofK8SSecretandK8STLSSecretstores across all k8s namespaces.K8SNS- This allows for a single store to manage a k8s namespace's secrets or typeOpaqueandkubernetes.io/tls. This can be thought of as a container ofK8SSecretandK8STLSSecretstores for a single k8s namespace.K8SJKS- Kubernetes secrets of typeOpaquethat contain one or more Java Keystore(s). These cannot be managed at the cluster or namespace level as they should all require unique credentials.K8SPKCS12- Kubernetes secrets of typeOpaquethat contain one or more PKCS12(s). These cannot be managed at the cluster or namespace level as they should all require unique credentials.
This orchestrator extension makes use of the Kubernetes API by using a service account to communicate remotely with certificate stores. The service account must have the correct permissions in order to perform the desired operations. For more information on the required permissions, see the service account setup guide.
The Kubernetes Universal Orchestrator extension implements 7 Certificate Store Types. Depending on your use case, you may elect to use one, or all of these Certificate Store Types. Descriptions of each are provided below.
This integration is compatible with Keyfactor Universal Orchestrator version 12.4 and later.
The Kubernetes Universal Orchestrator extension is supported by Keyfactor. If you require support for any issues or have feature request, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
If you want to contribute bug fixes or additional enhancements, use the Pull requests tab.
Before installing the Kubernetes Universal Orchestrator extension, we recommend that you install kfutil. Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
This orchestrator extension makes use of the Kubernetes API by using a service account to communicate remotely with certificate stores. The service account must exist and have the appropriate permissions. The service account token can be provided to the extension in one of two ways:
- As a raw JSON file that contains the service account credentials
- As a base64 encoded string that contains the service account credentials
To set up a service account user on your Kubernetes cluster to be used by the Kubernetes Orchestrator Extension. For full information on the required permissions, see the service account setup guide.
To use the Kubernetes Universal Orchestrator extension, you must create the Certificate Store Types required for your use-case. This only needs to happen once per Keyfactor Command instance.
The Kubernetes Universal Orchestrator extension implements 7 Certificate Store Types. Depending on your use case, you may elect to use one, or all of these Certificate Store Types.
Click to expand details
The K8SCert store type is used to manage Kubernetes certificates of type certificates.k8s.io/v1.
NOTE: only inventory and discovery of these resources is supported with this extension. To provision these certs use the
k8s-csr-signer.
| Operation | Is Supported |
|---|---|
| Add | 🔲 Unchecked |
| Remove | 🔲 Unchecked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | 🔲 Unchecked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8SCert kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8SCert
kfutil store-types create K8SCertIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8SCert store type manually in the Keyfactor Command Portal
Click to expand manual K8SCert details
Create a store type called K8SCert with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8SCert | Display name for the store type (may be customized) |
| Short Name | K8SCert | Short display name for the store type |
| Capability | K8SCert | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | 🔲 Unchecked | Indicates that the Store Type supports Management Add |
| Supports Remove | 🔲 Unchecked | Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Forbidden | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | âś… Checked |
| KubeNamespace | KubeNamespace | The K8S namespace to use to manage the K8S secret object. | String | default | 🔲 Unchecked |
| KubeSecretName | KubeSecretName | The name of the K8S secret object. | String | 🔲 Unchecked | |
| KubeSecretType | KubeSecretType | This defaults to and must be csr |
String | cert | âś… Checked |
The Custom Fields tab should look like this:
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The K8S namespace to use to manage the K8S secret object.
The name of the K8S secret object.
This defaults to and must be csr
Click to expand details
The K8SCluster store type allows for a single store to manage a k8s cluster's secrets or type Opaque and kubernetes.io/tls.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | 🔲 Unchecked |
| Reenrollment | 🔲 Unchecked |
| Create | âś… Checked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8SCluster kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8SCluster
kfutil store-types create K8SClusterIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8SCluster store type manually in the Keyfactor Command Portal
Click to expand manual K8SCluster details
Create a store type called K8SCluster with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8SCluster | Display name for the store type (may be customized) |
| Short Name | K8SCluster | Short display name for the store type |
| Capability | K8SCluster | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | 🔲 Unchecked | Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | âś… Checked | Check the box. Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| IncludeCertChain | Include Certificate Chain | Will default to true if not set. If set to false only the leaf cert will be deployed. |
Bool | true | 🔲 Unchecked |
| SeparateChain | Separate Chain | Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets. |
Bool | false | 🔲 Unchecked |
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | 🔲 Unchecked |
The Custom Fields tab should look like this:
Will default to true if not set. If set to false only the leaf cert will be deployed.
Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets.
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
Click to expand details
The K8SJKS store type is used to manage Kubernetes secrets of type Opaque. These secrets
must have a field that ends in .jks. The orchestrator will inventory and manage using a custom alias of the following
pattern: <k8s_secret_field_name>/<keystore_alias>. For example, if the secret has a field named mykeystore.jks and
the keystore contains a certificate with an alias of mycert, the orchestrator will manage the certificate using the
alias mykeystore.jks/mycert. NOTE This store type cannot be managed at the cluster or namespace level as they
should all require unique credentials.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | âś… Checked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8SJKS kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8SJKS
kfutil store-types create K8SJKSIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8SJKS store type manually in the Keyfactor Command Portal
Click to expand manual K8SJKS details
Create a store type called K8SJKS with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8SJKS | Display name for the store type (may be customized) |
| Short Name | K8SJKS | Short display name for the store type |
| Capability | K8SJKS | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | âś… Checked | Check the box. Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | âś… Checked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| KubeNamespace | KubeNamespace | The K8S namespace to use to manage the K8S secret object. | String | default | 🔲 Unchecked |
| KubeSecretName | KubeSecretName | The name of the K8S secret object. | String | None | 🔲 Unchecked |
| KubeSecretType | KubeSecretType | This defaults to and must be jks |
String | jks | âś… Checked |
| CertificateDataFieldName | CertificateDataFieldName | The field name to use when looking for certificate data in the K8S secret. | String | None | 🔲 Unchecked |
| PasswordFieldName | PasswordFieldName | The field name to use when looking for the JKS keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecret is set to true, the field name to look at on the secret specified in StorePasswordPath. |
String | password | 🔲 Unchecked |
| PasswordIsK8SSecret | PasswordIsK8SSecret | Indicates whether the password to the JKS keystore is stored in a separate K8S secret. | Bool | false | 🔲 Unchecked |
| IncludeCertChain | Include Certificate Chain | Will default to true if not set. If set to false only the leaf cert will be deployed. |
Bool | true | 🔲 Unchecked |
| StorePasswordPath | StorePasswordPath | The path to the K8S secret object to use as the password to the JKS keystore. Example: <namespace>/<secret_name> |
String | None | 🔲 Unchecked |
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | 🔲 Unchecked |
The Custom Fields tab should look like this:
The K8S namespace to use to manage the K8S secret object.
The name of the K8S secret object.
This defaults to and must be jks
The field name to use when looking for certificate data in the K8S secret.
The field name to use when looking for the JKS keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecret is set to true, the field name to look at on the secret specified in StorePasswordPath.
Indicates whether the password to the JKS keystore is stored in a separate K8S secret.
Will default to true if not set. If set to false only the leaf cert will be deployed.
The path to the K8S secret object to use as the password to the JKS keystore. Example: <namespace>/<secret_name>
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
Click to expand details
The K8SNS store type is used to manage Kubernetes secrets of type kubernetes.io/tls and/or type Opaque in a single
Keyfactor Command certificate store using an alias pattern of
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | âś… Checked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8SNS kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8SNS
kfutil store-types create K8SNSIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8SNS store type manually in the Keyfactor Command Portal
Click to expand manual K8SNS details
Create a store type called K8SNS with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8SNS | Display name for the store type (may be customized) |
| Short Name | K8SNS | Short display name for the store type |
| Capability | K8SNS | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | âś… Checked | Check the box. Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| KubeNamespace | Kube Namespace | The K8S namespace to use to manage the K8S secret object. | String | default | 🔲 Unchecked |
| IncludeCertChain | Include Certificate Chain | Will default to true if not set. If set to false only the leaf cert will be deployed. |
Bool | true | 🔲 Unchecked |
| SeparateChain | Separate Chain | Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets. |
Bool | false | 🔲 Unchecked |
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | 🔲 Unchecked |
The Custom Fields tab should look like this:
The K8S namespace to use to manage the K8S secret object.
Will default to true if not set. If set to false only the leaf cert will be deployed.
Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets.
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
Click to expand details
The K8SPKCS12 store type is used to manage Kubernetes secrets of type Opaque. These secrets
must have a field that ends in .pkcs12. The orchestrator will inventory and manage using a custom alias of the following
pattern: <k8s_secret_field_name>/<keystore_alias>. For example, if the secret has a field named mykeystore.pkcs12 and
the keystore contains a certificate with an alias of mycert, the orchestrator will manage the certificate using the
alias mykeystore.pkcs12/mycert. NOTE This store type cannot be managed at the cluster or namespace level as they
should all require unique credentials.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | âś… Checked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8SPKCS12 kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8SPKCS12
kfutil store-types create K8SPKCS12If required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8SPKCS12 store type manually in the Keyfactor Command Portal
Click to expand manual K8SPKCS12 details
Create a store type called K8SPKCS12 with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8SPKCS12 | Display name for the store type (may be customized) |
| Short Name | K8SPKCS12 | Short display name for the store type |
| Capability | K8SPKCS12 | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | âś… Checked | Check the box. Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | âś… Checked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| IncludeCertChain | Include Certificate Chain | Will default to true if not set. If set to false only the leaf cert will be deployed. |
Bool | true | 🔲 Unchecked |
| CertificateDataFieldName | CertificateDataFieldName | String | .p12 | âś… Checked | |
| PasswordFieldName | Password Field Name | The field name to use when looking for the PKCS12 keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecret is set to true, the field name to look at on the secret specified in StorePasswordPath. |
String | password | 🔲 Unchecked |
| PasswordIsK8SSecret | Password Is K8S Secret | Indicates whether the password to the PKCS12 keystore is stored in a separate K8S secret object. | Bool | false | 🔲 Unchecked |
| KubeNamespace | Kube Namespace | The K8S namespace to use to manage the K8S secret object. | String | default | 🔲 Unchecked |
| KubeSecretName | Kube Secret Name | The name of the K8S secret object. | String | None | 🔲 Unchecked |
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | 🔲 Unchecked |
| KubeSecretType | Kube Secret Type | This defaults to and must be pkcs12 |
String | pkcs12 | âś… Checked |
| StorePasswordPath | StorePasswordPath | The path to the K8S secret object to use as the password to the PFX/PKCS12 data. Example: <namespace>/<secret_name> |
String | None | 🔲 Unchecked |
The Custom Fields tab should look like this:
Will default to true if not set. If set to false only the leaf cert will be deployed.
The field name to use when looking for the PKCS12 keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecret is set to true, the field name to look at on the secret specified in StorePasswordPath.
Indicates whether the password to the PKCS12 keystore is stored in a separate K8S secret object.
The K8S namespace to use to manage the K8S secret object.
The name of the K8S secret object.
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
This defaults to and must be pkcs12
The path to the K8S secret object to use as the password to the PFX/PKCS12 data. Example: <namespace>/<secret_name>
Click to expand details
The K8SSecret store type is used to manage Kubernetes secrets of type Opaque.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | âś… Checked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8SSecret kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8SSecret
kfutil store-types create K8SSecretIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8SSecret store type manually in the Keyfactor Command Portal
Click to expand manual K8SSecret details
Create a store type called K8SSecret with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8SSecret | Display name for the store type (may be customized) |
| Short Name | K8SSecret | Short display name for the store type |
| Capability | K8SSecret | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | âś… Checked | Check the box. Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Forbidden | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| KubeNamespace | KubeNamespace | The K8S namespace to use to manage the K8S secret object. | String | None | 🔲 Unchecked |
| KubeSecretName | KubeSecretName | The name of the K8S secret object. | String | None | 🔲 Unchecked |
| KubeSecretType | KubeSecretType | This defaults to and must be secret |
String | secret | âś… Checked |
| IncludeCertChain | Include Certificate Chain | Will default to true if not set. If set to false only the leaf cert will be deployed. |
Bool | true | 🔲 Unchecked |
| SeparateChain | Separate Chain | Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets. |
Bool | false | 🔲 Unchecked |
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | 🔲 Unchecked |
The Custom Fields tab should look like this:
The K8S namespace to use to manage the K8S secret object.
The name of the K8S secret object.
This defaults to and must be secret
Will default to true if not set. If set to false only the leaf cert will be deployed.
Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets.
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
Click to expand details
The K8STLSSecret store type is used to manage Kubernetes secrets of type kubernetes.io/tls
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | âś… Checked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.
For more information on kfutil check out the docs
Click to expand K8STLSSecr kfutil details
This will reach out to GitHub and pull the latest store-type definition
# K8STLSSecr
kfutil store-types create K8STLSSecrIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the K8STLSSecr store type manually in the Keyfactor Command Portal
Click to expand manual K8STLSSecr details
Create a store type called K8STLSSecr with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | K8STLSSecr | Display name for the store type (may be customized) |
| Short Name | K8STLSSecr | Short display name for the store type |
| Capability | K8STLSSecr | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | âś… Checked | Check the box. Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Forbidden | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Optional | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
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.
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:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| KubeNamespace | KubeNamespace | The K8S namespace to use to manage the K8S secret object. | String | None | 🔲 Unchecked |
| KubeSecretName | KubeSecretName | The name of the K8S secret object. | String | None | 🔲 Unchecked |
| KubeSecretType | KubeSecretType | This defaults to and must be tls_secret |
String | tls_secret | âś… Checked |
| IncludeCertChain | Include Certificate Chain | Will default to true if not set. If set to false only the leaf cert will be deployed. |
Bool | true | 🔲 Unchecked |
| SeparateChain | Separate Chain | Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets. |
Bool | false | 🔲 Unchecked |
| ServerUsername | Server Username | This should be no value or kubeconfig |
Secret | None | 🔲 Unchecked |
| ServerPassword | Server Password | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Secret | None | 🔲 Unchecked |
The Custom Fields tab should look like this:
The K8S namespace to use to manage the K8S secret object.
The name of the K8S secret object.
This defaults to and must be tls_secret
Will default to true if not set. If set to false only the leaf cert will be deployed.
Will default to false if not set. Set this to true if you want to deploy certificate chain to the ca.crt field for Opaque and tls secrets.
This should be no value or kubeconfig
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
[!IMPORTANT] This field is created by the
Needs Serveron the Basic tab, do not create this field manually.
-
Download the latest Kubernetes Universal Orchestrator extension from GitHub.
Navigate to the Kubernetes Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine the asset should be downloaded. Then, click the corresponding asset to download the zip archive.
Universal Orchestrator Version Latest .NET version installed on the Universal Orchestrator server rollForwardcondition inOrchestrator.runtimeconfig.jsonk8s-orchestrator.NET version to downloadBetween 11.0.0and11.5.1(inclusive)net8.0LatestMajornet8.011.6and newernet8.0net8.0Unzip the archive containing extension assemblies to a known location.
Note If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for
net8.0. -
Locate the Universal Orchestrator extensions directory.
- Default on Windows -
C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions - Default on Linux -
/opt/keyfactor/orchestrator/extensions
- Default on Windows -
-
Create a new directory for the Kubernetes Universal Orchestrator extension inside the extensions directory.
Create a new directory called
k8s-orchestrator.The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.
-
Copy the contents of the downloaded and unzipped assemblies from step 2 to the
k8s-orchestratordirectory. -
Restart the Universal Orchestrator service.
Refer to Starting/Restarting the Universal Orchestrator service.
-
(optional) PAM Integration
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.
To configure a PAM provider, reference the Keyfactor Integration Catalog to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote).
The above installation steps can be supplemented by the official Command documentation.
The Kubernetes Universal Orchestrator extension implements 7 Certificate Store Types, each of which implements different functionality. Refer to the individual instructions below for each Certificate Store Type that you deemed necessary for your use case from the installation section.
K8SCert (K8SCert)
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8SCert" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SCertcertificates. Specifically, one with theK8SCertcapability.ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-jsonKubeNamespace The K8S namespace to use to manage the K8S secret object. KubeSecretName The name of the K8S secret object. KubeSecretType This defaults to and must be csr
Click to expand details
-
Generate a CSV template for the K8SCert certificate store
kfutil stores import generate-template --store-type-name K8SCert --outpath K8SCert.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8SCert" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SCertcertificates. Specifically, one with theK8SCertcapability.Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-jsonProperties.KubeNamespace The K8S namespace to use to manage the K8S secret object. Properties.KubeSecretName The name of the K8S secret object. Properties.KubeSecretType This defaults to and must be csr -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8SCert --file K8SCert.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
K8SCluster (K8SCluster)
In order for certificates of type Opaque and/or kubernetes.io/tls to be inventoried in K8SCluster store types, they must
have specific keys in the Kubernetes secret.
- Required keys:
tls.crtorca.crt - Additional keys:
tls.key
<cluster_name>
<namespace_name>/secrets/<tls|opaque>/<secret_name>
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8SCluster" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SClustercertificates. Specifically, one with theK8SClustercapability.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
Click to expand details
-
Generate a CSV template for the K8SCluster certificate store
kfutil stores import generate-template --store-type-name K8SCluster --outpath K8SCluster.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8SCluster" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SClustercertificates. Specifically, one with theK8SClustercapability.Properties.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.Properties.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8SCluster --file K8SCluster.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
K8SJKS (K8SJKS)
In order for certificates of type Opaque to be inventoried as K8SJKS store types, they must have specific keys in
the Kubernetes secret.
- Valid Keys:
*.jks
<namespace_name>/<secret_name><namespace_name>/secrets/<secret_name><cluster_name>/<namespace_name>/secrets/<secret_name>
<k8s_secret_field_name>/<keystore_alias>
Example: test.jks/load_balancer where test.jks is the field name on the Opaque secret and load_balancer is
the certificate alias in the jks data store.
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8SJKS" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Store Password Password to use when reading/writing to store Orchestrator Select an approved orchestrator capable of managing K8SJKScertificates. Specifically, one with theK8SJKScapability.KubeNamespace The K8S namespace to use to manage the K8S secret object. KubeSecretName The name of the K8S secret object. KubeSecretType This defaults to and must be jksCertificateDataFieldName The field name to use when looking for certificate data in the K8S secret. PasswordFieldName The field name to use when looking for the JKS keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecretis set totrue, the field name to look at on the secret specified inStorePasswordPath.PasswordIsK8SSecret Indicates whether the password to the JKS keystore is stored in a separate K8S secret. IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.StorePasswordPath The path to the K8S secret object to use as the password to the JKS keystore. Example: <namespace>/<secret_name>ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
Click to expand details
-
Generate a CSV template for the K8SJKS certificate store
kfutil stores import generate-template --store-type-name K8SJKS --outpath K8SJKS.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8SJKS" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Store Password Password to use when reading/writing to store Orchestrator Select an approved orchestrator capable of managing K8SJKScertificates. Specifically, one with theK8SJKScapability.Properties.KubeNamespace The K8S namespace to use to manage the K8S secret object. Properties.KubeSecretName The name of the K8S secret object. Properties.KubeSecretType This defaults to and must be jksProperties.CertificateDataFieldName The field name to use when looking for certificate data in the K8S secret. Properties.PasswordFieldName The field name to use when looking for the JKS keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecretis set totrue, the field name to look at on the secret specified inStorePasswordPath.Properties.PasswordIsK8SSecret Indicates whether the password to the JKS keystore is stored in a separate K8S secret. Properties.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.Properties.StorePasswordPath The path to the K8S secret object to use as the password to the JKS keystore. Example: <namespace>/<secret_name>Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8SJKS --file K8SJKS.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
| StorePassword | Password to use when reading/writing to store |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
K8SNS (K8SNS)
In order for certificates of type Opaque and/or kubernetes.io/tls to be inventoried in K8SNS store types, they must
have specific keys in the Kubernetes secret.
- Required keys:
tls.crtorca.crt - Additional keys:
tls.key
<namespace_name><cluster_name>/<namespace_name>
secrets/<tls|opaque>/<secret_name>
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8SNS" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SNScertificates. Specifically, one with theK8SNScapability.KubeNamespace The K8S namespace to use to manage the K8S secret object. IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
Click to expand details
-
Generate a CSV template for the K8SNS certificate store
kfutil stores import generate-template --store-type-name K8SNS --outpath K8SNS.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8SNS" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SNScertificates. Specifically, one with theK8SNScapability.Properties.KubeNamespace The K8S namespace to use to manage the K8S secret object. Properties.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.Properties.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8SNS --file K8SNS.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
K8SPKCS12 (K8SPKCS12)
In order for certificates of type Opaque to be inventoried as K8SPKCS12 store types, they must have specific keys in
the Kubernetes secret.
- Valid Keys:
*.pfx,*.pkcs12,*.p12
<namespace_name>/<secret_name><namespace_name>/secrets/<secret_name><cluster_name>/<namespace_name>/secrets/<secret_name>
<k8s_secret_field_name>/<keystore_alias>
Example: test.pkcs12/load_balancer where test.pkcs12 is the field name on the Opaque secret and load_balancer is
the certificate alias in the pkcs12 data store.
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8SPKCS12" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Store Password Password to use when reading/writing to store Orchestrator Select an approved orchestrator capable of managing K8SPKCS12certificates. Specifically, one with theK8SPKCS12capability.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.CertificateDataFieldName PasswordFieldName The field name to use when looking for the PKCS12 keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecretis set totrue, the field name to look at on the secret specified inStorePasswordPath.PasswordIsK8SSecret Indicates whether the password to the PKCS12 keystore is stored in a separate K8S secret object. KubeNamespace The K8S namespace to use to manage the K8S secret object. KubeSecretName The name of the K8S secret object. ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-jsonKubeSecretType This defaults to and must be pkcs12StorePasswordPath The path to the K8S secret object to use as the password to the PFX/PKCS12 data. Example: <namespace>/<secret_name>
Click to expand details
-
Generate a CSV template for the K8SPKCS12 certificate store
kfutil stores import generate-template --store-type-name K8SPKCS12 --outpath K8SPKCS12.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8SPKCS12" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Store Password Password to use when reading/writing to store Orchestrator Select an approved orchestrator capable of managing K8SPKCS12certificates. Specifically, one with theK8SPKCS12capability.Properties.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.Properties.CertificateDataFieldName Properties.PasswordFieldName The field name to use when looking for the PKCS12 keystore password in the K8S secret. This is either the field name to look at on the same secret, or if PasswordIsK8SSecretis set totrue, the field name to look at on the secret specified inStorePasswordPath.Properties.PasswordIsK8SSecret Indicates whether the password to the PKCS12 keystore is stored in a separate K8S secret object. Properties.KubeNamespace The K8S namespace to use to manage the K8S secret object. Properties.KubeSecretName The name of the K8S secret object. Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-jsonProperties.KubeSecretType This defaults to and must be pkcs12Properties.StorePasswordPath The path to the K8S secret object to use as the password to the PFX/PKCS12 data. Example: <namespace>/<secret_name> -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8SPKCS12 --file K8SPKCS12.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
| StorePassword | Password to use when reading/writing to store |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
K8SSecret (K8SSecret)
In order for certificates of type Opaque to be inventoried as K8SSecret store types, they must have specific keys in
the Kubernetes secret.
- Required keys:
tls.crtorca.crt - Additional keys:
tls.key
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8SSecret" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SSecretcertificates. Specifically, one with theK8SSecretcapability.KubeNamespace The K8S namespace to use to manage the K8S secret object. KubeSecretName The name of the K8S secret object. KubeSecretType This defaults to and must be secretIncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
Click to expand details
-
Generate a CSV template for the K8SSecret certificate store
kfutil stores import generate-template --store-type-name K8SSecret --outpath K8SSecret.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8SSecret" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8SSecretcertificates. Specifically, one with theK8SSecretcapability.Properties.KubeNamespace The K8S namespace to use to manage the K8S secret object. Properties.KubeSecretName The name of the K8S secret object. Properties.KubeSecretType This defaults to and must be secretProperties.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.Properties.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8SSecret --file K8SSecret.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
K8STLSSecr (K8STLSSecr)
In order for certificates of type kubernetes.io/tls to be inventoried, they must have specific keys in
the Kubernetes secret.
- Required keys:
tls.crtandtls.key - Optional keys:
ca.crt
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "K8STLSSecr" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8STLSSecrcertificates. Specifically, one with theK8STLSSecrcapability.KubeNamespace The K8S namespace to use to manage the K8S secret object. KubeSecretName The name of the K8S secret object. KubeSecretType This defaults to and must be tls_secretIncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.ServerUsername This should be no value or kubeconfigServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json
Click to expand details
-
Generate a CSV template for the K8STLSSecr certificate store
kfutil stores import generate-template --store-type-name K8STLSSecr --outpath K8STLSSecr.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "K8STLSSecr" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine This can be anything useful, recommend using the k8s cluster name or identifier. Store Path Orchestrator Select an approved orchestrator capable of managing K8STLSSecrcertificates. Specifically, one with theK8STLSSecrcapability.Properties.KubeNamespace The K8S namespace to use to manage the K8S secret object. Properties.KubeSecretName The name of the K8S secret object. Properties.KubeSecretType This defaults to and must be tls_secretProperties.IncludeCertChain Will default to trueif not set. If set tofalseonly the leaf cert will be deployed.Properties.SeparateChain Will default to falseif not set. Set this totrueif you want to deploy certificate chain to theca.crtfield for Opaque and tls secrets.Properties.ServerUsername This should be no value or kubeconfigProperties.ServerPassword The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfigformat. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name K8STLSSecr --file K8STLSSecr.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | This should be no value or kubeconfig |
| ServerPassword | The credentials to use to connect to the K8S cluster API. This needs to be in kubeconfig format. Example: https://github.com/Keyfactor/k8s-orchestrator/tree/main/scripts/kubernetes#example-service-account-json |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
NOTE: To use discovery jobs, you must have the store type created in Keyfactor Command and the needs_server
checkbox MUST be checked, if you do not select needs_server you will not be able to provide credentials to the
discovery job and it will fail.
The Kubernetes Orchestrator Extension supports certificate discovery jobs. This allows you to populate the certificate stores with existing certificates. To run a discovery job, follow these steps:
- Click on the "Locations > Certificate Stores" menu item.
- Click the "Discover" tab.
- Click the "Schedule" button.
- Configure the job based on storetype. Note the "Server Username" field must be set to
kubeconfigand the "Server Password" field is thekubeconfigformatted JSON file containing the service account credentials. See the "Service Account Setup" section earlier in this README for more information on setting up a service account.

- Click the "Save" button and wait for the Orchestrator to run the job. This may take some time depending on the number of certificates in the store and the Orchestrator's check-in schedule.
K8SJKS
For discovery of K8SJKS stores toy can use the following params to filter the certificates that will be discovered:
Directories to search- comma separated list of namespaces to search for certificates ORallto search all namespaces. This cannot be left blank.File name patterns to match- comma separated list of K8S secret keys to search for PKCS12 or JKS data. Will use the following keys by default:tls.pfx,tls.pkcs12,pfx,pkcs12,tls.jks,jks.
K8SNS
For discovery of K8SNS stores you can use the following params to filter the certificates that will be discovered:
Directories to search- comma separated list of namespaces to search for certificates ORallto search all namespaces. This cannot be left blank.
K8SPKCS12
For discovery of K8SPKCS12 stores you can use the following params to filter the certificates that will be discovered:
Directories to search- comma separated list of namespaces to search for certificates ORallto search all namespaces. This cannot be left blank.File name patterns to match- comma separated list of K8S secret keys to search for PKCS12 or PKCS12 data. Will use the following keys by default:tls.pfx,tls.pkcs12,pfx,pkcs12,tls.pkcs12,pkcs12.
K8SSecret
For discovery of K8SNS stores you can use the following params to filter the certificates that will be discovered:
Directories to search- comma separated list of namespaces to search for certificates ORallto search all namespaces. This cannot be left blank.
K8STLSSecr
For discovery of K8SNS stores you can use the following params to filter the certificates that will be discovered:
Directories to search- comma separated list of namespaces to search for certificates ORallto search all namespaces. This cannot be left blank.
Apache License 2.0, see LICENSE.
























































































