github.com/openebs/api@v1.12.0/config/crds/bases/cstor.openebs.io_cstorvolumereplicas.yaml (about)

     1  
     2  ---
     3  apiVersion: apiextensions.k8s.io/v1beta1
     4  kind: CustomResourceDefinition
     5  metadata:
     6    annotations:
     7      controller-gen.kubebuilder.io/version: v0.2.9
     8    creationTimestamp: null
     9    name: cstorvolumereplicas.cstor.openebs.io
    10  spec:
    11    group: cstor.openebs.io
    12    names:
    13      kind: CStorVolumeReplica
    14      listKind: CStorVolumeReplicaList
    15      plural: cstorvolumereplicas
    16      singular: cstorvolumereplica
    17    scope: Namespaced
    18    validation:
    19      openAPIV3Schema:
    20        description: CStorVolumeReplica describes a cstor volume resource created as
    21          custom resource
    22        properties:
    23          apiVersion:
    24            description: 'APIVersion defines the versioned schema of this representation
    25              of an object. Servers should convert recognized schemas to the latest
    26              internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
    27            type: string
    28          kind:
    29            description: 'Kind is a string value representing the REST resource this
    30              object represents. Servers may infer this from the endpoint the client
    31              submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    32            type: string
    33          metadata:
    34            type: object
    35          spec:
    36            description: CStorVolumeReplicaSpec is the spec for a CStorVolumeReplica
    37              resource
    38            properties:
    39              blockSize:
    40                description: BlockSize is the logical block size in multiple of 512
    41                  bytes BlockSize specifies the block size of the volume. The blocksize
    42                  cannot be changed once the volume has been written, so it should be
    43                  set at volume creation time. The default blocksize for volumes is
    44                  4 Kbytes. Any power of 2 from 512 bytes to 128 Kbytes is valid.
    45                format: int32
    46                type: integer
    47              capacity:
    48                description: Represents the actual capacity of the underlying volume
    49                type: string
    50              compression:
    51                description: 'Controls the compression algorithm used for this volumes
    52                  examples: on|off|gzip|gzip-N|lz4|lzjb|zle'
    53                type: string
    54              replicaid:
    55                description: ReplicaID is unique number to identify the replica
    56                type: string
    57              targetIP:
    58                description: TargetIP represents iscsi target IP through which replica
    59                  cummunicates IO workloads and other volume operations like snapshot
    60                  and resize requests
    61                type: string
    62              zvolWorkers:
    63                description: ZvolWorkers represents number of threads that executes
    64                  client IOs
    65                type: string
    66            required:
    67            - blockSize
    68            - capacity
    69            - compression
    70            - replicaid
    71            - targetIP
    72            - zvolWorkers
    73            type: object
    74          status:
    75            description: CStorVolumeReplicaStatus is for handling status of cvr.
    76            properties:
    77              capacity:
    78                description: CStorVolumeCapacityDetails represents capacity info of
    79                  replica
    80                properties:
    81                  total:
    82                    description: The amount of space consumed by this volume replica
    83                      and all its descendents
    84                    type: string
    85                  used:
    86                    description: The amount of space that is "logically" accessible
    87                      by this dataset. The logical space ignores the effect of the compression
    88                      and copies properties, giving a quantity closer to the amount
    89                      of data that applications see.  However, it does include space
    90                      consumed by metadata
    91                    type: string
    92                required:
    93                - total
    94                - used
    95                type: object
    96              lastTransitionTime:
    97                description: LastTransitionTime refers to the time when the phase changes
    98                format: date-time
    99                type: string
   100              lastUpdateTime:
   101                description: The last updated time
   102                format: date-time
   103                type: string
   104              message:
   105                description: A human readable message indicating details about the transition.
   106                type: string
   107              pendingSnapshots:
   108                additionalProperties:
   109                  description: CStorSnapshotInfo represents the snapshot information
   110                    related to particular snapshot
   111                  properties:
   112                    logicalReferenced:
   113                      description: LogicalReferenced describes the amount of space that
   114                        is "logically" accessable by this snapshot. This logical space
   115                        ignores the effect of the compression and copies properties,
   116                        giving a quantity closer to the amount of data that application
   117                        see. It also includes space consumed by metadata.
   118                      format: int64
   119                      type: integer
   120                    used:
   121                      description: Used is the used bytes for given snapshot
   122                      format: int64
   123                      type: integer
   124                  required:
   125                  - logicalReferenced
   126                  - used
   127                  type: object
   128                description: PendingSnapshots contains list of pending snapshots that
   129                  are not yet available on this replica
   130                type: object
   131              phase:
   132                description: CStorVolumeReplicaPhase is to holds different phases of
   133                  replica
   134                type: string
   135              snapshots:
   136                additionalProperties:
   137                  description: CStorSnapshotInfo represents the snapshot information
   138                    related to particular snapshot
   139                  properties:
   140                    logicalReferenced:
   141                      description: LogicalReferenced describes the amount of space that
   142                        is "logically" accessable by this snapshot. This logical space
   143                        ignores the effect of the compression and copies properties,
   144                        giving a quantity closer to the amount of data that application
   145                        see. It also includes space consumed by metadata.
   146                      format: int64
   147                      type: integer
   148                    used:
   149                      description: Used is the used bytes for given snapshot
   150                      format: int64
   151                      type: integer
   152                  required:
   153                  - logicalReferenced
   154                  - used
   155                  type: object
   156                description: Snapshots contains list of snapshots, and their properties,
   157                  created on CVR
   158                type: object
   159            required:
   160            - capacity
   161            - phase
   162            type: object
   163          versionDetails:
   164            description: VersionDetails provides the details for upgrade
   165            properties:
   166              autoUpgrade:
   167                description: If AutoUpgrade is set to true then the resource is upgraded
   168                  automatically without any manual steps
   169                type: boolean
   170              desired:
   171                description: Desired is the version that we want to upgrade or the control
   172                  plane version
   173                type: string
   174              status:
   175                description: Status gives the status of reconciliation triggered when
   176                  the desired and current version are not same
   177                properties:
   178                  current:
   179                    description: Current is the version of resource
   180                    type: string
   181                  dependentsUpgraded:
   182                    description: DependentsUpgraded gives the details whether all children
   183                      of a resource are upgraded to desired version or not
   184                    type: boolean
   185                  lastUpdateTime:
   186                    description: LastUpdateTime is the time the status was last  updated
   187                    format: date-time
   188                    type: string
   189                  message:
   190                    description: Message is a human readable message if some error occurs
   191                    type: string
   192                  reason:
   193                    description: Reason is the actual reason for the error state
   194                    type: string
   195                  state:
   196                    description: State is the state of reconciliation
   197                    type: string
   198                required:
   199                - current
   200                - dependentsUpgraded
   201                - state
   202                type: object
   203            required:
   204            - autoUpgrade
   205            - desired
   206            - status
   207            type: object
   208        required:
   209        - spec
   210        - status
   211        - versionDetails
   212        type: object
   213    version: v1
   214    versions:
   215    - name: v1
   216      served: true
   217      storage: true
   218  status:
   219    acceptedNames:
   220      kind: ""
   221      plural: ""
   222    conditions: []
   223    storedVersions: []