Skip to content

Commit

Permalink
Update generated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Keyfactor committed Feb 20, 2024
1 parent 7b2f74c commit 6c1477b
Showing 1 changed file with 31 additions and 31 deletions.
62 changes: 31 additions & 31 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -470,9 +470,9 @@ kfutil store-types create --name K8SSecret
##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value | Description |
|------------------|---------------------------|--------|----------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | `default` | The K8S namespace the `Opaque` secret lives. This will override any value inferred in the `Store Path` |
| KubeSecretName | Kube Secret Name | String | ✓ | | The name of the K8S `Opaque` secret. This will override any value inferred in the `Store Path` |
| KubeSecretType | Kube Secret Type | String | ✓ | `secret` | |
| KubeNamespace | Kube Namespace | String | | | The K8S namespace the `Opaque` secret lives. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeSecretName`. |
| KubeSecretName | Kube Secret Name | String | | | The name of the K8S `Opaque` secret. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeNamespace`. |
| KubeSecretType | Kube Secret Type | String | ✓ | `secret` | This is required and must be `secret`. |
| IncludeCertChain | Include Certificate Chain | Bool | | `true` | Will default to `true` if not set. If set to `false` only leaf cert will be deployed. |
| SeparateChain | SeparateChain | Bool | | `false` | Will default to `false` if not set. `true` will deploy leaf cert to `tls.crt` and the rest of the cert chain to `ca.crt`. If set to `false` the full chain is deployed to `tls.crt` |

Expand Down Expand Up @@ -520,13 +520,13 @@ kfutil store-types create --name K8STLSSecr
![k8sstlssecr_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fk8sstlssecr_advanced.png)

##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value | Description |
|------------------|----------------------------|--------|----------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | The K8S namespace the `tls` secret lives. This will override any value inferred in the `Store Path` |
| KubeSecretName | Kube Secret Name | String | | | The name of the K8S `tls` secret. This will override any value inferred in the `Store Path` |
| KubeSecretType | Kube Secret Type | String | ✓ | `tls_secret` | |
| IncludeCertChain | Include Certificate Chain | Bool | | `true` | If set to `false` only leaf cert will be deployed. |
| SeparateChain | SeparateChain | Bool | | `true` | `true` will deploy leaf cert to `tls.crt` and the rest of the cert chain to `ca.crt`. If set to `false` the full chain is deployed to `tls.crt` |
| Name | Display Name | Type | Required | Default Value | Description |
|------------------|----------------------------|--------|----------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | The K8S namespace the `tls` secret lives. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeSecretName`. |
| KubeSecretName | Kube Secret Name | String | | | The name of the K8S `tls` secret. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeNamespace`. |
| KubeSecretType | Kube Secret Type | String | ✓ | `tls_secret` | This is required and must be `tls_secret`. |
| IncludeCertChain | Include Certificate Chain | Bool | | `true` | If set to `false` only leaf cert will be deployed. |
| SeparateChain | SeparateChain | Bool | | `true` | `true` will deploy leaf cert to `tls.crt` and the rest of the cert chain to `ca.crt`. If set to `false` the full chain is deployed to `tls.crt` |


![k8sstlssecr_custom_fields.png](docs%2Fscreenshots%2Fstore_types%2Fk8sstlssecr_custom_fields.png)
Expand Down Expand Up @@ -573,16 +573,16 @@ kfutil store-types create --name K8SPKCS12
![k8spkcs12_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fk8spkcs12_advanced.png)

##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value | Description |
|--------------------------|-----------------------------|--------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | K8S namespace the PKCS12 secret lives. This will override any value inferred in the `Store Path` |
| KubeSecretName | Kube Secret Name | String | | | The K8S secret name that contains PKCS12 data. This will override any value inferred in the `Store Path` |
| KubeSecretType | Kube Secret Type | String | ✓ | `pkcs12` | This must be set to `pkcs12`. |
| CertificateDataFieldName | Certificate Data Field Name | String | ✓ | `.p12` | The K8S secret field name to source the PKCS12 data from. You can provide an extension `.p12` or `.pfx` for a secret with a key `example.p12` |
| PasswordFieldName | Password Field Name | String | | `password` | If sourcing the PKCS12 password from a K8S secret this is the field it will look for the password in. |
| PasswordIsK8SSecret | Password Is K8S Secret | Bool | ✓ | `false` | If you want to use the PKCS12 secret or a separate secret specific in `KubeSecretPasswordPath` set this to `true` |
| StorePassword | Kube Secret Password | Secret | | | If you want to specify the PKCS12 password on the store in Command use this. |
| StorePasswordPath | Kube Secret Password Path | String | | | Source PKCS12 password from a separate K8S secret. Pattern: `namespace_name/secret_name` |
| Name | Display Name | Type | Required | Default Value | Description |
|--------------------------|-----------------------------|--------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | K8S namespace the PKCS12 secret lives. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeSecretName`. |
| KubeSecretName | Kube Secret Name | String | | | The K8S secret name that contains PKCS12 data. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeNamespace`. |
| KubeSecretType | Kube Secret Type | String | ✓ | `pkcs12` | This is required and must be set to `pkcs12`. |
| CertificateDataFieldName | Certificate Data Field Name | String | ✓ | `.p12` | The K8S secret field name to source the PKCS12 data from. You can provide an extension `.p12` or `.pfx` for a secret with a key `example.p12` |
| PasswordFieldName | Password Field Name | String | | `password` | If sourcing the PKCS12 password from the PKCS12 K8S secret, or a separate K8S secret, this is the field it will look for the password in. |
| PasswordIsK8SSecret | Password Is K8S Secret | Bool | | `false` | If sourcing the PKCS12 password from the PKCS12 K8S secret, or a separate K8S secret specified in `StorePasswordPath` set this to `true` |
| StorePassword | Store Password | Secret | | | If sourcing the PKCS12 password from Command use this. *Note* this will take precedence over `PasswordIsK8SSecret` |
| StorePasswordPath | Kube Secret Password Path | String | | | If sourcing the PKCS12 password from a separate K8S secret. Pattern: `namespace_name/secret_name` |


![k8spkcs12_custom_fields.png](docs%2Fscreenshots%2Fstore_types%2Fk8spkcs12_custom_fields.png)
Expand Down Expand Up @@ -637,16 +637,16 @@ kfutil store-types create --name K8SJKS
![k8sjks_advanced.png](docs%2Fscreenshots%2Fstore_types%2Fk8sjks_advanced.png)

##### UI Custom Fields Tab
| Name | Display Name | Type | Required | Default Value | Description |
|--------------------------|-----------------------------|--------|----------|---------------|--------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | K8S namespace the JKS secret lives. This will override any value inferred in the `Store Path`. |
| KubeSecretName | Kube Secret Name | String | | | The K8S secret name that contains JKS data. This will override any value inferred in the `Store Path`. |
| KubeSecretType | Kube Secret Type | String | ✓ | `jks` | |
| CertificateDataFieldName | Certificate Data Field Name | String | ✓ | `.jks` | The K8S secret field name to source the JKS data from |
| PasswordFieldName | Password Field Name | String | ✓ | `password` | If sourcing the JKS password from a K8S secret this is the field it will look for the password in. |
| PasswordIsK8SSecret | Password Is K8S Secret | Bool | ✓ | `false` | If you want to use the JKS secret or a separate secret specific in `` set this to `true` |
| StorePassword | Kube Secret Password | Secret | | | If you want to specify the JKS password on the store in Command use this. |
| StorePasswordPath | Kube Secret Password Path | String | | | Source JKS password from a separate K8S secret. Pattern: `namespace_name/secret_name` |
| Name | Display Name | Type | Required | Default Value | Description |
|--------------------------|-----------------------------|--------|----------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | K8S namespace the K8S secret containing the JKS data lives. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeSecretName`. |
| KubeSecretName | Kube Secret Name | String | | | The name of the K8S secret that contains the JKS data. This will override any value inferred in the `Store Path`. To be used in conjunction with `KubeNamespace`. |
| KubeSecretType | Kube Secret Type | String | ✓ | `jks` | This is required and must be `jks`. |
| CertificateDataFieldName | Certificate Data Field Name | String | ✓ | `.jks` | The K8S secret field name to source the JKS data from. |
| PasswordFieldName | Password Field Name | String | | `password` | If sourcing the JKS password from a another field on the K8S JKS secret or the separate K8S secret, this is the secret field name it will look for the password in. |
| PasswordIsK8SSecret | Password Is K8S Secret | Bool | | `false` | If sourcing the JKS password from the K8S JKS secret or a separate K8S secret set this to `true` |
| StorePassword | Store Password | Secret | | | If sourcing the JKS password from Command use this. *Note* this will take precedence over `PasswordIsK8SSecret` |
| StorePasswordPath | Kube Secret Password Path | String | | | Source the JKS password from a separate K8S secret. Pattern: `namespace_name/secret_name`. *Note* the Orchestrator K8S service account must have read access to the secret. |


![k8sjks_custom_fields.png](docs%2Fscreenshots%2Fstore_types%2Fk8sjks_custom_fields.png)
Expand Down Expand Up @@ -809,7 +809,7 @@ kfutil store-types create --name K8SCert
|--------------------|---------------------------|--------|----------|---------------|--------------------------------------------------------------------------------------------------------|
| KubeNamespace | Kube Namespace | String | | | The K8S namespace the `cert` resource lives. This will override any value inferred in the `Store Path` |
| KubeSecretName | Kube Secret Name | String | | | The K8S `cert` name. This will override any value inferred in the `Store Path`. |
| KubeSecretType | Kube Secret Type | String | ✓ | `cert` | |
| KubeSecretType | Kube Secret Type | String | ✓ | `cert` | This is required and must be `cert`. |


![k8scert_custom_fields.png](docs%2Fscreenshots%2Fstore_types%2Fk8scert_custom_fields.png)
Expand Down

0 comments on commit 6c1477b

Please sign in to comment.