mirror of
https://github.com/hanzoai/kms-operator.git
synced 2026-10-30 18:32:57 +00:00
zeekayandHanzo Dev
537ff78da8
A KMSSecret carries LoadedKMSToken and ReadyToSyncSecrets, and the CRD declared no printer columns, so `kubectl get kmssecrets` rendered every row as NAME and AGE. The two are different faults with different owners — the credential, and the value at the addressed path — and neither was legible from the table. KMSPushSecret gets the same treatment for its Reconcile condition. Co-authored-by: Hanzo Dev <[email protected]>
656 lines
30 KiB
YAML
656 lines
30 KiB
YAML
---
|
|
apiVersion: apiextensions.k8s.io/v1
|
|
kind: CustomResourceDefinition
|
|
metadata:
|
|
annotations:
|
|
controller-gen.kubebuilder.io/version: v0.20.1
|
|
name: kmssecrets.kms.hanzo.ai
|
|
spec:
|
|
group: kms.hanzo.ai
|
|
names:
|
|
kind: KMSSecret
|
|
listKind: KMSSecretList
|
|
plural: kmssecrets
|
|
singular: kmssecret
|
|
scope: Namespaced
|
|
versions:
|
|
- additionalPrinterColumns:
|
|
- jsonPath: .status.conditions[?(@.type=="kms.hanzo.ai/LoadedKMSToken")].status
|
|
name: Authenticated
|
|
type: string
|
|
- jsonPath: .status.conditions[?(@.type=="kms.hanzo.ai/ReadyToSyncSecrets")].status
|
|
name: Synced
|
|
type: string
|
|
- jsonPath: .metadata.creationTimestamp
|
|
name: Age
|
|
type: date
|
|
- jsonPath: .status.conditions[?(@.type=="kms.hanzo.ai/ReadyToSyncSecrets")].message
|
|
name: Message
|
|
priority: 1
|
|
type: string
|
|
name: v1
|
|
schema:
|
|
openAPIV3Schema:
|
|
description: |-
|
|
KMSSecret is the Schema for the kmssecrets API
|
|
|
|
The two conditions are printed because a CR that cannot authenticate and a CR
|
|
that authenticated and then could not read a secret are different faults with
|
|
different owners, and `kubectl get kmssecrets` used to show neither. With no
|
|
column for either, a healthy fleet and a frozen one render identically — 147
|
|
rows of NAME and AGE — and the table was read as "0 ready" while 122 were
|
|
syncing. Authenticated=False is an identity problem; Authenticated=True with
|
|
Synced=False is a missing value at the addressed path.
|
|
properties:
|
|
apiVersion:
|
|
description: |-
|
|
APIVersion defines the versioned schema of this representation of an object.
|
|
Servers should convert recognized schemas to the latest internal value, and
|
|
may reject unrecognized values.
|
|
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
|
|
type: string
|
|
kind:
|
|
description: |-
|
|
Kind is a string value representing the REST resource this object represents.
|
|
Servers may infer this from the endpoint the client submits requests to.
|
|
Cannot be updated.
|
|
In CamelCase.
|
|
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
|
|
type: string
|
|
metadata:
|
|
type: object
|
|
spec:
|
|
description: KMSSecretSpec defines the desired state of KMSSecret
|
|
properties:
|
|
authentication:
|
|
properties:
|
|
awsIamAuth:
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
description: EnvSlug is the environment scope (for example
|
|
"dev", "mainnet").
|
|
type: string
|
|
keys:
|
|
description: |-
|
|
Keys enumerates the secret names to fetch from the KMS. The
|
|
canonical surface has no list endpoint; every value MUST be
|
|
addressed by exact name. Bounded ≤ 128 entries / CR.
|
|
items:
|
|
type: string
|
|
maxItems: 128
|
|
minItems: 1
|
|
type: array
|
|
projectSlug:
|
|
description: |-
|
|
ProjectSlug names the org under the canonical luxfi/kms surface
|
|
— secrets are addressed as /v1/kms/orgs/{projectSlug}/secrets/...
|
|
type: string
|
|
secretsPath:
|
|
description: |-
|
|
SecretsPath is the path under which the listed Keys live. Empty
|
|
path means the org root. Leading and trailing "/" are stripped.
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- keys
|
|
- projectSlug
|
|
- secretsPath
|
|
type: object
|
|
required:
|
|
- identityId
|
|
- secretsScope
|
|
type: object
|
|
azureAuth:
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
resource:
|
|
type: string
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
description: EnvSlug is the environment scope (for example
|
|
"dev", "mainnet").
|
|
type: string
|
|
keys:
|
|
description: |-
|
|
Keys enumerates the secret names to fetch from the KMS. The
|
|
canonical surface has no list endpoint; every value MUST be
|
|
addressed by exact name. Bounded ≤ 128 entries / CR.
|
|
items:
|
|
type: string
|
|
maxItems: 128
|
|
minItems: 1
|
|
type: array
|
|
projectSlug:
|
|
description: |-
|
|
ProjectSlug names the org under the canonical luxfi/kms surface
|
|
— secrets are addressed as /v1/kms/orgs/{projectSlug}/secrets/...
|
|
type: string
|
|
secretsPath:
|
|
description: |-
|
|
SecretsPath is the path under which the listed Keys live. Empty
|
|
path means the org root. Leading and trailing "/" are stripped.
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- keys
|
|
- projectSlug
|
|
- secretsPath
|
|
type: object
|
|
required:
|
|
- identityId
|
|
- secretsScope
|
|
type: object
|
|
gcpIamAuth:
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
description: EnvSlug is the environment scope (for example
|
|
"dev", "mainnet").
|
|
type: string
|
|
keys:
|
|
description: |-
|
|
Keys enumerates the secret names to fetch from the KMS. The
|
|
canonical surface has no list endpoint; every value MUST be
|
|
addressed by exact name. Bounded ≤ 128 entries / CR.
|
|
items:
|
|
type: string
|
|
maxItems: 128
|
|
minItems: 1
|
|
type: array
|
|
projectSlug:
|
|
description: |-
|
|
ProjectSlug names the org under the canonical luxfi/kms surface
|
|
— secrets are addressed as /v1/kms/orgs/{projectSlug}/secrets/...
|
|
type: string
|
|
secretsPath:
|
|
description: |-
|
|
SecretsPath is the path under which the listed Keys live. Empty
|
|
path means the org root. Leading and trailing "/" are stripped.
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- keys
|
|
- projectSlug
|
|
- secretsPath
|
|
type: object
|
|
serviceAccountKeyFilePath:
|
|
type: string
|
|
required:
|
|
- identityId
|
|
- secretsScope
|
|
- serviceAccountKeyFilePath
|
|
type: object
|
|
gcpIdTokenAuth:
|
|
properties:
|
|
identityId:
|
|
type: string
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
description: EnvSlug is the environment scope (for example
|
|
"dev", "mainnet").
|
|
type: string
|
|
keys:
|
|
description: |-
|
|
Keys enumerates the secret names to fetch from the KMS. The
|
|
canonical surface has no list endpoint; every value MUST be
|
|
addressed by exact name. Bounded ≤ 128 entries / CR.
|
|
items:
|
|
type: string
|
|
maxItems: 128
|
|
minItems: 1
|
|
type: array
|
|
projectSlug:
|
|
description: |-
|
|
ProjectSlug names the org under the canonical luxfi/kms surface
|
|
— secrets are addressed as /v1/kms/orgs/{projectSlug}/secrets/...
|
|
type: string
|
|
secretsPath:
|
|
description: |-
|
|
SecretsPath is the path under which the listed Keys live. Empty
|
|
path means the org root. Leading and trailing "/" are stripped.
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- keys
|
|
- projectSlug
|
|
- secretsPath
|
|
type: object
|
|
required:
|
|
- identityId
|
|
- secretsScope
|
|
type: object
|
|
kubernetesAuth:
|
|
properties:
|
|
autoCreateServiceAccountToken:
|
|
description: |-
|
|
Optionally automatically create a service account token for the configured service account.
|
|
If this is set to `true`, the operator will automatically create a service account token for the configured service account.
|
|
type: boolean
|
|
identityId:
|
|
type: string
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
description: EnvSlug is the environment scope (for example
|
|
"dev", "mainnet").
|
|
type: string
|
|
keys:
|
|
description: |-
|
|
Keys enumerates the secret names to fetch from the KMS. The
|
|
canonical surface has no list endpoint; every value MUST be
|
|
addressed by exact name. Bounded ≤ 128 entries / CR.
|
|
items:
|
|
type: string
|
|
maxItems: 128
|
|
minItems: 1
|
|
type: array
|
|
projectSlug:
|
|
description: |-
|
|
ProjectSlug names the org under the canonical luxfi/kms surface
|
|
— secrets are addressed as /v1/kms/orgs/{projectSlug}/secrets/...
|
|
type: string
|
|
secretsPath:
|
|
description: |-
|
|
SecretsPath is the path under which the listed Keys live. Empty
|
|
path means the org root. Leading and trailing "/" are stripped.
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- keys
|
|
- projectSlug
|
|
- secretsPath
|
|
type: object
|
|
serviceAccountRef:
|
|
properties:
|
|
name:
|
|
type: string
|
|
namespace:
|
|
type: string
|
|
required:
|
|
- name
|
|
- namespace
|
|
type: object
|
|
serviceAccountTokenAudiences:
|
|
description: The audiences to use for the service account
|
|
token. This is only relevant if `autoCreateServiceAccountToken`
|
|
is true.
|
|
items:
|
|
type: string
|
|
type: array
|
|
required:
|
|
- identityId
|
|
- secretsScope
|
|
- serviceAccountRef
|
|
type: object
|
|
serviceAccount:
|
|
properties:
|
|
environmentName:
|
|
type: string
|
|
projectId:
|
|
type: string
|
|
serviceAccountSecretReference:
|
|
properties:
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret
|
|
is located
|
|
type: string
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
required:
|
|
- environmentName
|
|
- projectId
|
|
- serviceAccountSecretReference
|
|
type: object
|
|
serviceToken:
|
|
properties:
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
type: string
|
|
recursive:
|
|
type: boolean
|
|
secretsPath:
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- secretsPath
|
|
type: object
|
|
serviceTokenSecretReference:
|
|
properties:
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret
|
|
is located
|
|
type: string
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
required:
|
|
- secretsScope
|
|
- serviceTokenSecretReference
|
|
type: object
|
|
universalAuth:
|
|
properties:
|
|
credentialsRef:
|
|
properties:
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret
|
|
is located
|
|
type: string
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
secretsScope:
|
|
properties:
|
|
envSlug:
|
|
description: EnvSlug is the environment scope (for example
|
|
"dev", "mainnet").
|
|
type: string
|
|
keys:
|
|
description: |-
|
|
Keys enumerates the secret names to fetch from the KMS. The
|
|
canonical surface has no list endpoint; every value MUST be
|
|
addressed by exact name. Bounded ≤ 128 entries / CR.
|
|
items:
|
|
type: string
|
|
maxItems: 128
|
|
minItems: 1
|
|
type: array
|
|
projectSlug:
|
|
description: |-
|
|
ProjectSlug names the org under the canonical luxfi/kms surface
|
|
— secrets are addressed as /v1/kms/orgs/{projectSlug}/secrets/...
|
|
type: string
|
|
secretsPath:
|
|
description: |-
|
|
SecretsPath is the path under which the listed Keys live. Empty
|
|
path means the org root. Leading and trailing "/" are stripped.
|
|
type: string
|
|
required:
|
|
- envSlug
|
|
- keys
|
|
- projectSlug
|
|
- secretsPath
|
|
type: object
|
|
required:
|
|
- credentialsRef
|
|
- secretsScope
|
|
type: object
|
|
type: object
|
|
hostAPI:
|
|
description: KMS host to pull secrets from
|
|
type: string
|
|
managedKubeConfigMapReferences:
|
|
items:
|
|
properties:
|
|
configMapName:
|
|
description: The name of the Kubernetes ConfigMap
|
|
type: string
|
|
configMapNamespace:
|
|
description: The namespace where the Kubernetes ConfigMap is
|
|
located
|
|
type: string
|
|
creationPolicy:
|
|
default: Orphan
|
|
description: |-
|
|
The Kubernetes ConfigMap creation policy.
|
|
Enum with values: 'Owner', 'Orphan'.
|
|
Owner creates the config map and sets .metadata.ownerReferences of the KMSSecret CRD that created it.
|
|
Orphan will not set the config map owner. This will result in the config map being orphaned and not deleted when the resource is deleted.
|
|
type: string
|
|
template:
|
|
description: The template to transform the secret data
|
|
properties:
|
|
data:
|
|
additionalProperties:
|
|
type: string
|
|
description: The template key values
|
|
type: object
|
|
includeAllSecrets:
|
|
description: |-
|
|
This injects all retrieved secrets into the top level of your template.
|
|
Secrets defined in the template will take precedence over the injected ones.
|
|
type: boolean
|
|
type: object
|
|
required:
|
|
- configMapName
|
|
- configMapNamespace
|
|
type: object
|
|
type: array
|
|
managedKubeSecretReferences:
|
|
items:
|
|
properties:
|
|
creationPolicy:
|
|
default: Orphan
|
|
description: |-
|
|
The Kubernetes Secret creation policy.
|
|
Enum with values: 'Owner', 'Orphan'.
|
|
Owner creates the secret and sets .metadata.ownerReferences of the KMSSecret CRD that created it.
|
|
Orphan will not set the secret owner. This will result in the secret being orphaned and not deleted when the resource is deleted.
|
|
type: string
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret is located
|
|
type: string
|
|
secretType:
|
|
default: Opaque
|
|
description: 'The Kubernetes Secret type (experimental feature).
|
|
More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types'
|
|
type: string
|
|
template:
|
|
description: The template to transform the secret data
|
|
properties:
|
|
data:
|
|
additionalProperties:
|
|
type: string
|
|
description: The template key values
|
|
type: object
|
|
includeAllSecrets:
|
|
description: |-
|
|
This injects all retrieved secrets into the top level of your template.
|
|
Secrets defined in the template will take precedence over the injected ones.
|
|
type: boolean
|
|
type: object
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
type: array
|
|
managedSecretReference:
|
|
properties:
|
|
creationPolicy:
|
|
default: Orphan
|
|
description: |-
|
|
The Kubernetes Secret creation policy.
|
|
Enum with values: 'Owner', 'Orphan'.
|
|
Owner creates the secret and sets .metadata.ownerReferences of the KMSSecret CRD that created it.
|
|
Orphan will not set the secret owner. This will result in the secret being orphaned and not deleted when the resource is deleted.
|
|
type: string
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret is located
|
|
type: string
|
|
secretType:
|
|
default: Opaque
|
|
description: 'The Kubernetes Secret type (experimental feature).
|
|
More info: https://kubernetes.io/docs/concepts/configuration/secret/#secret-types'
|
|
type: string
|
|
template:
|
|
description: The template to transform the secret data
|
|
properties:
|
|
data:
|
|
additionalProperties:
|
|
type: string
|
|
description: The template key values
|
|
type: object
|
|
includeAllSecrets:
|
|
description: |-
|
|
This injects all retrieved secrets into the top level of your template.
|
|
Secrets defined in the template will take precedence over the injected ones.
|
|
type: boolean
|
|
type: object
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
mnemonicSecretRef:
|
|
description: |-
|
|
MnemonicSecretRef points at a Secret holding the BIP-39 mnemonic
|
|
that derives this consumer's identity. Empty → defaults to
|
|
"<crname>-mnemonic" in the same namespace as the CR. The Secret
|
|
is generated and persisted by the operator on first reconcile
|
|
when it does not exist. The mnemonic itself is NEVER written to
|
|
CR status, logs, events, or any non-Secret resource.
|
|
properties:
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret is located
|
|
type: string
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
resyncInterval:
|
|
default: 60
|
|
type: integer
|
|
servicePath:
|
|
description: |-
|
|
ServicePath is the canonical service identity path used to derive
|
|
the consumer's NodeID (see luxfi/keys.NewServiceIdentity). Empty
|
|
→ "hanzo/<crname>". Identical paths derive identical NodeIDs from
|
|
the same mnemonic, so do not reuse a path across distinct
|
|
services.
|
|
type: string
|
|
tls:
|
|
properties:
|
|
caRef:
|
|
description: Reference to secret containing CA cert
|
|
properties:
|
|
key:
|
|
description: The name of the secret property with the CA certificate
|
|
value
|
|
type: string
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The namespace where the Kubernetes Secret is
|
|
located
|
|
type: string
|
|
required:
|
|
- key
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
type: object
|
|
tokenSecretReference:
|
|
properties:
|
|
secretName:
|
|
description: The name of the Kubernetes Secret
|
|
type: string
|
|
secretNamespace:
|
|
description: The name space where the Kubernetes Secret is located
|
|
type: string
|
|
required:
|
|
- secretName
|
|
- secretNamespace
|
|
type: object
|
|
required:
|
|
- resyncInterval
|
|
type: object
|
|
status:
|
|
description: KMSSecretStatus defines the observed state of KMSSecret
|
|
properties:
|
|
conditions:
|
|
items:
|
|
description: Condition contains details for one aspect of the current
|
|
state of this API Resource.
|
|
properties:
|
|
lastTransitionTime:
|
|
description: |-
|
|
lastTransitionTime is the last time the condition transitioned from one status to another.
|
|
This should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.
|
|
format: date-time
|
|
type: string
|
|
message:
|
|
description: |-
|
|
message is a human readable message indicating details about the transition.
|
|
This may be an empty string.
|
|
maxLength: 32768
|
|
type: string
|
|
observedGeneration:
|
|
description: |-
|
|
observedGeneration represents the .metadata.generation that the condition was set based upon.
|
|
For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date
|
|
with respect to the current state of the instance.
|
|
format: int64
|
|
minimum: 0
|
|
type: integer
|
|
reason:
|
|
description: |-
|
|
reason contains a programmatic identifier indicating the reason for the condition's last transition.
|
|
Producers of specific condition types may define expected values and meanings for this field,
|
|
and whether the values are considered a guaranteed API.
|
|
The value should be a CamelCase string.
|
|
This field may not be empty.
|
|
maxLength: 1024
|
|
minLength: 1
|
|
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
|
|
type: string
|
|
status:
|
|
description: status of the condition, one of True, False, Unknown.
|
|
enum:
|
|
- "True"
|
|
- "False"
|
|
- Unknown
|
|
type: string
|
|
type:
|
|
description: type of condition in CamelCase or in foo.example.com/CamelCase.
|
|
maxLength: 316
|
|
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
|
|
type: string
|
|
required:
|
|
- lastTransitionTime
|
|
- message
|
|
- reason
|
|
- status
|
|
- type
|
|
type: object
|
|
type: array
|
|
required:
|
|
- conditions
|
|
type: object
|
|
type: object
|
|
served: true
|
|
storage: true
|
|
subresources:
|
|
status: {}
|