Files
netbird-kubernetes-operator/helm/kubernetes-operator/crds/netbird.io_setupkeys.yaml
T

173 lines
7.4 KiB
YAML
Raw Normal View History

2026-04-13 12:20:35 +02:00
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.20.1
name: setupkeys.netbird.io
spec:
group: netbird.io
names:
kind: SetupKey
listKind: SetupKeyList
plural: setupkeys
singular: setupkey
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.conditions[?(@.type=="Ready")].status
name: Ready
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
2026-04-13 12:20:35 +02:00
schema:
openAPIV3Schema:
description: SetupKey is the Schema for the setupkeys API.
2026-04-13 12:20:35 +02:00
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: SetupKeySpec defines the desired state of SetupKey.
2026-04-13 12:20:35 +02:00
properties:
2026-04-15 10:16:10 +02:00
autoGroups:
description: AutoGroups are groups that will be automatically assigned
to peers using setup key.
2026-04-15 10:16:10 +02:00
items:
properties:
id:
description: id of the resource in the Netbird API.
type: string
localRef:
description: local reference to the object in the same namespace.
properties:
name:
default: ""
description: |-
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
type: string
type: object
x-kubernetes-map-type: atomic
type: object
x-kubernetes-validations:
- message: exactly one of id or localRef must be set
rule: (has(self.id) && !has(self.localRef)) || (!has(self.id)
&& has(self.localRef))
type: array
2026-04-13 12:20:35 +02:00
duration:
description: Duration sets how long the setup key is valid for.
type: string
x-kubernetes-validations:
- message: duration is immutable
rule: self == oldSelf
ephemeral:
description: Ephemeral decides if peers added with the key are ephemeral
or not.
type: boolean
x-kubernetes-validations:
- message: ephemeral is immutable
rule: self == oldSelf
required:
- ephemeral
type: object
status:
default:
observedGeneration: -1
description: SetupKeyStatus defines the observed state of SetupKey.
2026-04-13 12:20:35 +02:00
properties:
conditions:
description: Conditions holds the conditions for the SetupKey.
2026-04-13 12:20:35 +02:00
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
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
observedGeneration:
description: ObservedGeneration is the last reconciled generation.
format: int64
type: integer
2026-04-13 12:20:35 +02:00
setupKeyID:
description: SetupKeyID is the id of the created setup key.
2026-04-13 12:20:35 +02:00
type: string
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}