examples/operator/templates/cephvolume-crd.yaml
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
name: cephvolumes.test.example.com
annotations:
cert-manager.io/inject-ca-from: '{{ .Release.Namespace }}/{{ include "operator.fullname"
. }}-serving-cert'
example-annotation: xyz
labels:
example-label: my-app
{{- include "operator.labels" . | nindent 4 }}
spec:
group: test.example.com
names:
kind: CephVolume
listKind: CephVolumeList
plural: cephvolumes
singular: cephvolume
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Ceph RBD pool name
jsonPath: .spec.pool
name: Pool
type: string
- description: Storage type
jsonPath: .status.type
name: Type
type: string
- description: Volume size
jsonPath: .spec.size
name: Size
type: string
- description: Max number of volume I/O operations per second
jsonPath: .status.limits.iops
name: IOPS
type: string
- description: true if volume contains latest type,size spec from Ceph
jsonPath: .status.conditions[?(@.type=="Provided")].status
name: Provided
type: string
- description: true if volume IOPS limits calculated. False indicates error - check
reason for details
jsonPath: .status.conditions[?(@.type=="Calculated")].status
name: Calculated
type: string
- description: true if volume IOPS limits applied to volume. False indicates error
- check reason for details
jsonPath: .status.conditions[?(@.type=="Limited")].status
name: Limited
type: string
- description: latest resource generation
jsonPath: .metadata.generation
name: gen
type: string
- description: latest observed generation of Limited condition
jsonPath: .status.conditions[?(@.type=="Limited")].observedGeneration
name: Lim-gen
type: string
name: v1alpha1
schema:
openAPIV3Schema:
description: CephVolume represents Ceph RBD volume
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: CephVolumeSpec defines the desired state of CephVolume
properties:
pool:
description: Pool - volume pool name
type: string
size:
anyOf:
- type: integer
- type: string
description: Size - volume size
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
x-kubernetes-int-or-string: true
type: object
status:
description: CephVolumeStatus defines the observed state of CephVolume
properties:
conditions:
description: 'Conditions represent the latest available observations
of an object''s state Known .status.conditions.type are: "Provided".
"Calculated", "Limited"'
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
type FooStatus struct{ // Represents the observations of a foo's
current state. // Known .status.conditions.type are: \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type //
+patchStrategy=merge // +listType=map // +listMapKey=type
\ Conditions []metav1.Condition `json:\"conditions,omitempty\"
patchStrategy:\"merge\" patchMergeKey:\"type\" protobuf:\"bytes,1,rep,name=conditions\"`
\n // other fields }"
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.
--- Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
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
limits:
description: Limits represent calculated IOPS limits
properties:
iops:
description: IOPS - desired limit of IO operations per second. See
Ceph rbd_qos_iops_limit property.
format: int64
minimum: 0
type: integer
iopsBurst:
description: IOPSBurst - desired burst limit of IO operations. See
Ceph rbd_qos_iops_burst property.
format: int64
minimum: 0
type: integer
readIOPS:
description: ReadIOPS - desired limit of read operations per second.
See Ceph rbd_qos_read_iops_limit property.
format: int64
minimum: 0
type: integer
readIOPSBurst:
description: ReadIOPSBurst - desired burst limit of read operations.
See Ceph rbd_qos_read_iops_burst property.
format: int64
minimum: 0
type: integer
writeIOPS:
description: WriteIOPS - desired limit of write operations per second.
See Ceph rbd_qos_write_iops_limit property
format: int64
minimum: 0
type: integer
writeIOPSBurst:
description: WriteIOPSBurst - desired burst limit of write operations.
See Ceph rbd_qos_write_iops_burst property.
format: int64
minimum: 0
type: integer
type: object
type:
description: Type - volume storage type. See StorageType CRD.
type: string
required:
- conditions
type: object
type: object
served: true
storage: true
subresources:
status: {}
status:
acceptedNames:
kind: ""
plural: ""
conditions: []
storedVersions: []