From 279624d345bbdd3364d60be5408c445588a1209f Mon Sep 17 00:00:00 2001 From: Abhinandan Purkait Date: Mon, 22 Jul 2024 15:49:17 +0000 Subject: [PATCH] chore: cleanup unused scripts, update make manifets Signed-off-by: Abhinandan Purkait --- Makefile.buildx.mk | 15 - buildscripts/build.sh | 16 +- buildscripts/generate-manifests.sh | 146 +- buildscripts/push | 35 +- buildscripts/test-cov.sh | 13 - buildscripts/travis-build.sh | 44 - .../charts/crds/templates/zfsbackup.yaml | 11 +- .../charts/charts/crds/templates/zfsnode.yaml | 9 - .../charts/crds/templates/zfsrestore.yaml | 11 +- .../charts/crds/templates/zfssnapshot.yaml | 11 +- .../charts/crds/templates/zfsvolume.yaml | 11 +- deploy/yamls/kustomization.yaml | 11 - deploy/yamls/namespace.yaml | 14 - deploy/yamls/zfs-driver.yaml | 1325 ------ deploy/yamls/zfsbackup-crd.yaml | 11 - deploy/yamls/zfsnode-crd.yaml | 10 - deploy/yamls/zfsrestore-crd.yaml | 11 - deploy/yamls/zfssnapshot-crd.yaml | 11 - deploy/yamls/zfsvolume-crd.yaml | 11 - deploy/zfs-operator.yaml | 3735 +++++++---------- 20 files changed, 1607 insertions(+), 3854 deletions(-) mode change 100755 => 100644 buildscripts/build.sh mode change 100755 => 100644 buildscripts/push delete mode 100755 buildscripts/travis-build.sh delete mode 100644 deploy/yamls/kustomization.yaml delete mode 100644 deploy/yamls/namespace.yaml delete mode 100644 deploy/yamls/zfs-driver.yaml diff --git a/Makefile.buildx.mk b/Makefile.buildx.mk index 94907eb6a..6ca41ffda 100644 --- a/Makefile.buildx.mk +++ b/Makefile.buildx.mk @@ -1,18 +1,3 @@ - -# Copyright 2018-2020 The OpenEBS Authors. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - # Build zfs-driver docker images with buildx # Experimental docker feature to build cross platform multi-architecture docker images # https://docs.docker.com/buildx/working-with-buildx/ diff --git a/buildscripts/build.sh b/buildscripts/build.sh old mode 100755 new mode 100644 index f6ec3f425..cf4669deb --- a/buildscripts/build.sh +++ b/buildscripts/build.sh @@ -1,19 +1,5 @@ #!/usr/bin/env bash -# Copyright © 2020 The OpenEBS Authors -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# This script builds the application from source for multiple platforms. set -e # Get the parent directory of where this script is. @@ -130,4 +116,4 @@ done # Done! echo echo "==> Results:" -ls -hl bin/"${PNAME}"/ +ls -hl bin/"${PNAME}"/ \ No newline at end of file diff --git a/buildscripts/generate-manifests.sh b/buildscripts/generate-manifests.sh index 3894a1332..492d79647 100755 --- a/buildscripts/generate-manifests.sh +++ b/buildscripts/generate-manifests.sh @@ -1,141 +1,35 @@ -#!/bin/bash - -# Copyright 2019 The Kubernetes Authors. -# Copyright 2020 The OpenEBS Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. +#!/usr/bin/env bash set -o errexit set -o nounset set -o pipefail -## find or download controller-gen +SCRIPT_DIR="$(dirname "$(realpath "${BASH_SOURCE[0]:-"$0"}")")" +ROOT_DIR="$SCRIPT_DIR/.." +DEPLOY_YAML_DIR="$ROOT_DIR/deploy/yamls" +HELM_CHART_DIR="$ROOT_DIR/deploy/helm/charts/" +CRD_CHART_TEMPLATE_DIR="$HELM_CHART_DIR/charts/crds/templates" CONTROLLER_GEN=$(which controller-gen) +RELEASE_NAME="openebs" +RELEASE_NAMESPACE="openebs" -if [ "$CONTROLLER_GEN" = "" ] -then +if [ "$CONTROLLER_GEN" = "" ]; then echo "ERROR: failed to get controller-gen, Please run make bootstrap to install it"; exit 1; fi -$CONTROLLER_GEN crd:trivialVersions=false,preserveUnknownFields=false paths=./pkg/apis/... output:crd:artifacts:config=deploy/yamls - -## create the the crd yamls - -echo ' - -############################################## -########### ############ -########### ZFSVolume CRD ############ -########### ############ -############################################## - -# ZFSVolume CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition' > deploy/yamls/zfsvolume-crd.yaml - -cat deploy/yamls/zfs.openebs.io_zfsvolumes.yaml >> deploy/yamls/zfsvolume-crd.yaml -rm deploy/yamls/zfs.openebs.io_zfsvolumes.yaml - -echo ' - -############################################## -########### ############ -########### ZFSSnapshot CRD ############ -########### ############ -############################################## - -# ZFSSnapshot CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition' > deploy/yamls/zfssnapshot-crd.yaml - -cat deploy/yamls/zfs.openebs.io_zfssnapshots.yaml >> deploy/yamls/zfssnapshot-crd.yaml -rm deploy/yamls/zfs.openebs.io_zfssnapshots.yaml - -echo ' - -############################################## -########### ############ -########### ZFSBackup CRD ############ -########### ############ -############################################## - -# ZFSBackups CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition' > deploy/yamls/zfsbackup-crd.yaml - -cat deploy/yamls/zfs.openebs.io_zfsbackups.yaml >> deploy/yamls/zfsbackup-crd.yaml -rm deploy/yamls/zfs.openebs.io_zfsbackups.yaml - -echo ' - -############################################## -########### ############ -########### ZFSRestore CRD ############ -########### ############ -############################################## - -# ZFSRestores CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition' > deploy/yamls/zfsrestore-crd.yaml - -cat deploy/yamls/zfs.openebs.io_zfsrestores.yaml >> deploy/yamls/zfsrestore-crd.yaml -rm deploy/yamls/zfs.openebs.io_zfsrestores.yaml - -echo ' -############################################## -########### ############ -########### ZFSNode CRD ############ -########### ############ -############################################## - -# ZFSNode CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition' > deploy/yamls/zfsnode-crd.yaml - -cat deploy/yamls/zfs.openebs.io_zfsnodes.yaml >> deploy/yamls/zfsnode-crd.yaml -rm deploy/yamls/zfs.openebs.io_zfsnodes.yaml - -## create the operator file using all the yamls - -echo '# This manifest is autogenerated via `make manifests` command -# Do the modification to the zfs-driver.yaml in directory deploy/yamls/ -# and then run `make manifests` command - -# This manifest deploys the OpenEBS ZFS control plane components, -# with associated CRs & RBAC rules. -' > deploy/zfs-operator.yaml - -# Add namespace creation to the Operator yaml -cat deploy/yamls/namespace.yaml >> deploy/zfs-operator.yaml - -# Add ZFSVolume v1alpha1 and v1 CRDs to the Operator yaml -cat deploy/yamls/zfsvolume-crd.yaml >> deploy/zfs-operator.yaml - -# Add ZFSSnapshot v1alpha1 and v1 CRDs to the Operator yaml -cat deploy/yamls/zfssnapshot-crd.yaml >> deploy/zfs-operator.yaml - -# Add ZFSBackup v1 CRDs to the Operator yaml -cat deploy/yamls/zfsbackup-crd.yaml >> deploy/zfs-operator.yaml +$CONTROLLER_GEN crd:trivialVersions=false,preserveUnknownFields=false paths=./pkg/apis/... output:crd:artifacts:config=$DEPLOY_YAML_DIR -# Add ZFSRestore v1 CRDs to the Operator yaml -cat deploy/yamls/zfsrestore-crd.yaml >> deploy/zfs-operator.yaml +for FILE in "$DEPLOY_YAML_DIR"/zfs.openebs.io_*; do + BASE_NAME=$(basename "$FILE" | sed -e 's/^zfs.openebs.io_//' -e 's/s\.yaml$/.yaml/') + NEW_FILE="$DEPLOY_YAML_DIR/${BASE_NAME%.yaml}-crd.yaml" + mv "$FILE" "$NEW_FILE" -# Add ZFSNode v1alpha1 CRDs to the Operator yaml -cat deploy/yamls/zfsnode-crd.yaml >> deploy/zfs-operator.yaml + TARGET_FILE="$CRD_CHART_TEMPLATE_DIR/${BASE_NAME%.yaml}.yaml" + cp "$NEW_FILE" "$TARGET_FILE" -# Add the driver deployment to the Operator yaml -cat deploy/yamls/zfs-driver.yaml >> deploy/zfs-operator.yaml + awk '/controller-gen.kubebuilder.io\/version:/ { print; print " {{- include \"crds.extraAnnotations\" .Values.zfsLocalPv | nindent 4 }}"; next }1' "$TARGET_FILE" > "$TARGET_FILE.tmp" && mv "$TARGET_FILE.tmp" "$TARGET_FILE" + awk 'BEGIN { print "{{- if .Values.zfsLocalPv.enabled -}}" } { print } END { if (NR > 0) print "{{- end -}}" }' "$TARGET_FILE" > "$TARGET_FILE.tmp" && mv "$TARGET_FILE.tmp" "$TARGET_FILE" +done -# To use your own boilerplate text use: -# --go-header-file ${SCRIPT_ROOT}/hack/custom-boilerplate.go.txt +helm template $RELEASE_NAME $HELM_CHART_DIR -n $RELEASE_NAME > $DEPLOY_YAML_DIR/../zfs-operator.yaml \ No newline at end of file diff --git a/buildscripts/push b/buildscripts/push old mode 100755 new mode 100644 index f2f1427da..01c2f6e95 --- a/buildscripts/push +++ b/buildscripts/push @@ -1,18 +1,4 @@ -#!/bin/bash - -# Copyright 2019-2020 The OpenEBS Authors. All rights reserved. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. +#!/usr/bin/env bash set -e @@ -109,15 +95,6 @@ then # Push unique tagged image - :develop- or :branch- # This unique/build image will be pushed to corresponding ci repo. TagAndPushImage "${DIMAGE}-ci" "${BUILD_TAG}" - - if [ ! -z "${TRAVIS_TAG}" ] ; - then - # Push with different tags if tagged as a release - # When github is tagged with a release, then Travis will - # set the release tag in env TRAVIS_TAG - TagAndPushImage "${DIMAGE}" "${TRAVIS_TAG}" - TagAndPushImage "${DIMAGE}" "latest" - fi; else echo "No docker credentials provided. Skip uploading ${DIMAGE} to docker hub"; fi; @@ -129,15 +106,6 @@ then # Push CI tagged image - :ci or :branch-ci TagAndPushImage "quay.io/${DIMAGE}" "${CI_TAG}" - - if [ ! -z "${TRAVIS_TAG}" ] ; - then - # Push with different tags if tagged as a release - # When github is tagged with a release, then Travis will - # set the release tag in env TRAVIS_TAG - TagAndPushImage "quay.io/${DIMAGE}" "${TRAVIS_TAG}" - TagAndPushImage "quay.io/${DIMAGE}" "latest" - fi; else echo "No docker credentials provided. Skip uploading ${DIMAGE} to quay"; fi; @@ -150,3 +118,4 @@ then # Push COMMIT tagged image - :COMMIT TagAndPushImage "${DIMAGE}" "${COMMIT}" fi; + \ No newline at end of file diff --git a/buildscripts/test-cov.sh b/buildscripts/test-cov.sh index 5ee9e5b1c..5b7392a48 100755 --- a/buildscripts/test-cov.sh +++ b/buildscripts/test-cov.sh @@ -1,17 +1,4 @@ #!/usr/bin/env bash -# Copyright © 2020 The OpenEBS Authors -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. set -e echo "" > coverage.txt diff --git a/buildscripts/travis-build.sh b/buildscripts/travis-build.sh deleted file mode 100755 index 98530e767..000000000 --- a/buildscripts/travis-build.sh +++ /dev/null @@ -1,44 +0,0 @@ -#!/bin/bash -set -e -# Copyright 2019 The OpenEBS Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -DST_REPO="$GOPATH/src/github.com/openebs/zfs-localpv" - -function checkGitDiff() { - if [[ `git diff --shortstat | wc -l` != 0 ]]; then echo "Some files got changed after $1";printf "\n";git diff;printf "\n"; exit 1; fi -} - -#make golint-travis -#rc=$?; if [[ $rc != 0 ]]; then exit $rc; fi - -make verify-deps - -echo "Running : make kubegen" -make kubegen -rc=$?; if [[ $rc != 0 ]]; then echo "make kubegen failed"; exit $rc; fi -checkGitDiff "make kubegen" -printf "\n" - -echo "Running : make manifests" -make manifests -rc=$?; if [[ $rc != 0 ]]; then echo "make manifests failed"; exit $rc; fi -checkGitDiff "make manifests" -printf "\n" - -./buildscripts/test-cov.sh -rc=$?; if [[ $rc != 0 ]]; then exit $rc; fi - -make all -rc=$?; if [[ $rc != 0 ]]; then exit $rc; fi diff --git a/deploy/helm/charts/charts/crds/templates/zfsbackup.yaml b/deploy/helm/charts/charts/crds/templates/zfsbackup.yaml index 6b3a032a9..b0070c80c 100644 --- a/deploy/helm/charts/charts/crds/templates/zfsbackup.yaml +++ b/deploy/helm/charts/charts/crds/templates/zfsbackup.yaml @@ -1,13 +1,4 @@ {{- if .Values.zfsLocalPv.enabled -}} -############################################## -########### ############ -########### ZFSBackup CRD ############ -########### ############ -############################################## - -# ZFSBackups CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition --- apiVersion: apiextensions.k8s.io/v1 @@ -114,4 +105,4 @@ status: plural: "" conditions: [] storedVersions: [] -{{- end -}} \ No newline at end of file +{{- end -}} diff --git a/deploy/helm/charts/charts/crds/templates/zfsnode.yaml b/deploy/helm/charts/charts/crds/templates/zfsnode.yaml index a7eaf8d95..4ab0cc0e3 100644 --- a/deploy/helm/charts/charts/crds/templates/zfsnode.yaml +++ b/deploy/helm/charts/charts/crds/templates/zfsnode.yaml @@ -1,13 +1,4 @@ {{- if .Values.zfsLocalPv.enabled -}} -############################################## -########### ############ -########### ZFSNode CRD ############ -########### ############ -############################################## - -# ZFSNode CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition --- apiVersion: apiextensions.k8s.io/v1 diff --git a/deploy/helm/charts/charts/crds/templates/zfsrestore.yaml b/deploy/helm/charts/charts/crds/templates/zfsrestore.yaml index f43f1f69b..6f712eca0 100644 --- a/deploy/helm/charts/charts/crds/templates/zfsrestore.yaml +++ b/deploy/helm/charts/charts/crds/templates/zfsrestore.yaml @@ -1,13 +1,4 @@ {{- if .Values.zfsLocalPv.enabled -}} -############################################## -########### ############ -########### ZFSRestore CRD ############ -########### ############ -############################################## - -# ZFSRestores CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition --- apiVersion: apiextensions.k8s.io/v1 @@ -236,4 +227,4 @@ status: plural: "" conditions: [] storedVersions: [] -{{- end -}} \ No newline at end of file +{{- end -}} diff --git a/deploy/helm/charts/charts/crds/templates/zfssnapshot.yaml b/deploy/helm/charts/charts/crds/templates/zfssnapshot.yaml index 38cf98f84..538afbf03 100644 --- a/deploy/helm/charts/charts/crds/templates/zfssnapshot.yaml +++ b/deploy/helm/charts/charts/crds/templates/zfssnapshot.yaml @@ -1,13 +1,4 @@ {{- if .Values.zfsLocalPv.enabled -}} -############################################## -########### ############ -########### ZFSSnapshot CRD ############ -########### ############ -############################################## - -# ZFSSnapshot CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition --- apiVersion: apiextensions.k8s.io/v1 @@ -381,4 +372,4 @@ status: plural: "" conditions: [] storedVersions: [] -{{- end -}} \ No newline at end of file +{{- end -}} diff --git a/deploy/helm/charts/charts/crds/templates/zfsvolume.yaml b/deploy/helm/charts/charts/crds/templates/zfsvolume.yaml index cfb1aad86..b45d4f570 100644 --- a/deploy/helm/charts/charts/crds/templates/zfsvolume.yaml +++ b/deploy/helm/charts/charts/crds/templates/zfsvolume.yaml @@ -1,13 +1,4 @@ {{- if .Values.zfsLocalPv.enabled -}} -############################################## -########### ############ -########### ZFSVolume CRD ############ -########### ############ -############################################## - -# ZFSVolume CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition --- apiVersion: apiextensions.k8s.io/v1 @@ -447,4 +438,4 @@ status: plural: "" conditions: [] storedVersions: [] -{{- end -}} \ No newline at end of file +{{- end -}} diff --git a/deploy/yamls/kustomization.yaml b/deploy/yamls/kustomization.yaml deleted file mode 100644 index 187606613..000000000 --- a/deploy/yamls/kustomization.yaml +++ /dev/null @@ -1,11 +0,0 @@ -images: - - name: openebs/zfs-driver - newTag: ci -resources: -- namespace.yaml -- zfsvolume-crd.yaml -- zfssnapshot-crd.yaml -- zfsbackup-crd.yaml -- zfsrestore-crd.yaml -- zfs-driver.yaml -- zfsnode-crd.yaml diff --git a/deploy/yamls/namespace.yaml b/deploy/yamls/namespace.yaml deleted file mode 100644 index 95af54868..000000000 --- a/deploy/yamls/namespace.yaml +++ /dev/null @@ -1,14 +0,0 @@ -# Create the OpenEBS namespace -# This is the default namespace where the ZFS driver will create all -# its resources. If we want to change it to use a different namespace -# modify this to create the new namespace and also modify the OPENEBS_NAMESPACE -# env for the ZFS Driver's controller and agent deployments. -# please note that this should be changed while initial setup, once ZFS Driver -# is deployed with a namespace, we should never modify it as old resources will -# not be available under the new namespace and ZFS Driver looks for all the resources -# in the OPENEBS_NAMESPACE namespace passed as an env. - -apiVersion: v1 -kind: Namespace -metadata: - name: openebs diff --git a/deploy/yamls/zfs-driver.yaml b/deploy/yamls/zfs-driver.yaml deleted file mode 100644 index 5d17ef80b..000000000 --- a/deploy/yamls/zfs-driver.yaml +++ /dev/null @@ -1,1325 +0,0 @@ - ---- - -# Create the CSI Driver object -apiVersion: storage.k8s.io/v1 -kind: CSIDriver -metadata: - name: zfs.csi.openebs.io -spec: - # do not require volumeattachment - attachRequired: false - podInfoOnMount: false - storageCapacity: true ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.11.3 - api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/814" - creationTimestamp: null - name: volumesnapshotclasses.snapshot.storage.k8s.io -spec: - group: snapshot.storage.k8s.io - names: - kind: VolumeSnapshotClass - listKind: VolumeSnapshotClassList - plural: volumesnapshotclasses - shortNames: - - vsclass - - vsclasses - singular: volumesnapshotclass - scope: Cluster - versions: - - additionalPrinterColumns: - - jsonPath: .driver - name: Driver - type: string - - description: Determines whether a VolumeSnapshotContent created through the - VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. - jsonPath: .deletionPolicy - name: DeletionPolicy - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1 - schema: - openAPIV3Schema: - description: VolumeSnapshotClass specifies parameters that a underlying storage - system uses when creating a volume snapshot. A specific VolumeSnapshotClass - is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses - are non-namespaced - 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 - deletionPolicy: - description: deletionPolicy determines whether a VolumeSnapshotContent - created through the VolumeSnapshotClass should be deleted when its bound - VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". - "Retain" means that the VolumeSnapshotContent and its physical snapshot - on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent - and its physical snapshot on underlying storage system are deleted. - Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the storage driver that handles this - VolumeSnapshotClass. Required. - 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 - parameters: - additionalProperties: - type: string - description: parameters is a key-value map with storage driver specific - parameters for creating snapshots. These values are opaque to Kubernetes. - type: object - required: - - deletionPolicy - - driver - type: object - served: true - storage: true - subresources: {} - - additionalPrinterColumns: - - jsonPath: .driver - name: Driver - type: string - - description: Determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. - jsonPath: .deletionPolicy - name: DeletionPolicy - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta1 - # This indicates the v1beta1 version of the custom resource is deprecated. - # API requests to this version receive a warning in the server response. - deprecated: true - # This overrides the default warning returned to clients making v1beta1 API requests. - deprecationWarning: "snapshot.storage.k8s.io/v1beta1 VolumeSnapshotClass is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshotClass" - schema: - openAPIV3Schema: - description: VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced - 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 - deletionPolicy: - description: deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the storage driver that handles this VolumeSnapshotClass. Required. - 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 - parameters: - additionalProperties: - type: string - description: parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes. - type: object - required: - - deletionPolicy - - driver - type: object - served: false - storage: false - subresources: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.11.3 - api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/814" - creationTimestamp: null - name: volumesnapshotcontents.snapshot.storage.k8s.io -spec: - group: snapshot.storage.k8s.io - names: - kind: VolumeSnapshotContent - listKind: VolumeSnapshotContentList - plural: volumesnapshotcontents - shortNames: - - vsc - - vscs - singular: volumesnapshotcontent - scope: Cluster - versions: - - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: Represents the complete size of the snapshot in bytes - jsonPath: .status.restoreSize - name: RestoreSize - type: integer - - description: Determines whether this VolumeSnapshotContent and its physical - snapshot on the underlying storage system should be deleted when its bound - VolumeSnapshot is deleted. - jsonPath: .spec.deletionPolicy - name: DeletionPolicy - type: string - - description: Name of the CSI driver used to create the physical snapshot on - the underlying storage system. - jsonPath: .spec.driver - name: Driver - type: string - - description: Name of the VolumeSnapshotClass to which this snapshot belongs. - jsonPath: .spec.volumeSnapshotClassName - name: VolumeSnapshotClass - type: string - - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent - object is bound. - jsonPath: .spec.volumeSnapshotRef.name - name: VolumeSnapshot - type: string - - description: Namespace of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. - jsonPath: .spec.volumeSnapshotRef.namespace - name: VolumeSnapshotNamespace - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1 - schema: - openAPIV3Schema: - description: VolumeSnapshotContent represents the actual "on-disk" snapshot - object in the underlying storage system - 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 - spec: - description: spec defines properties of a VolumeSnapshotContent created - by the underlying storage system. Required. - properties: - deletionPolicy: - description: deletionPolicy determines whether this VolumeSnapshotContent - and its physical snapshot on the underlying storage system should - be deleted when its bound VolumeSnapshot is deleted. Supported values - are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent - and its physical snapshot on underlying storage system are kept. - "Delete" means that the VolumeSnapshotContent and its physical snapshot - on underlying storage system are deleted. For dynamically provisioned - snapshots, this field will automatically be filled in by the CSI - snapshotter sidecar with the "DeletionPolicy" field defined in the - corresponding VolumeSnapshotClass. For pre-existing snapshots, users - MUST specify this field when creating the VolumeSnapshotContent - object. Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the CSI driver used to create the - physical snapshot on the underlying storage system. This MUST be - the same as the name returned by the CSI GetPluginName() call for - that driver. Required. - type: string - source: - description: source specifies whether the snapshot is (or should be) - dynamically provisioned or already exists, and just requires a Kubernetes - object representation. This field is immutable after creation. Required. - properties: - snapshotHandle: - description: snapshotHandle specifies the CSI "snapshot_id" of - a pre-existing snapshot on the underlying storage system for - which a Kubernetes object representation was (or should be) - created. This field is immutable. - type: string - volumeHandle: - description: volumeHandle specifies the CSI "volume_id" of the - volume from which a snapshot should be dynamically taken from. - This field is immutable. - type: string - type: object - oneOf: - - required: ["snapshotHandle"] - - required: ["volumeHandle"] - sourceVolumeMode: - description: SourceVolumeMode is the mode of the volume whose snapshot - is taken. Can be either “Filesystem” or “Block”. If not specified, - it indicates the source volume's mode is unknown. This field is - immutable. This field is an alpha field. - type: string - volumeSnapshotClassName: - description: name of the VolumeSnapshotClass from which this snapshot - was (or will be) created. Note that after provisioning, the VolumeSnapshotClass - may be deleted or recreated with different set of values, and as - such, should not be referenced post-snapshot creation. - type: string - volumeSnapshotRef: - description: volumeSnapshotRef specifies the VolumeSnapshot object - to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName - field must reference to this VolumeSnapshotContent's name for the - bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent - object, name and namespace of the VolumeSnapshot object MUST be - provided for binding to happen. This field is immutable after creation. - Required. - properties: - apiVersion: - description: API version of the referent. - type: string - fieldPath: - description: 'If referring to a piece of an object instead of - an entire object, this string should contain a valid JSON/Go - field access statement, such as desiredState.manifest.containers[2]. - For example, if the object reference is to a container within - a pod, this would take on a value like: "spec.containers{name}" - (where "name" refers to the name of the container that triggered - the event) or if no container name is specified "spec.containers[2]" - (container with index 2 in this pod). This syntax is chosen - only to have some well-defined way of referencing a part of - an object. TODO: this design is not final and this field is - subject to change in the future.' - type: string - kind: - description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' - type: string - namespace: - description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' - type: string - resourceVersion: - description: 'Specific resourceVersion to which this reference - is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' - type: string - uid: - description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' - type: string - type: object - x-kubernetes-map-type: atomic - required: - - deletionPolicy - - driver - - source - - volumeSnapshotRef - type: object - status: - description: status represents the current information of a snapshot. - properties: - creationTime: - description: creationTime is the timestamp when the point-in-time - snapshot is taken by the underlying storage system. In dynamic snapshot - creation case, this field will be filled in by the CSI snapshotter - sidecar with the "creation_time" value returned from CSI "CreateSnapshot" - gRPC call. For a pre-existing snapshot, this field will be filled - with the "creation_time" value returned from the CSI "ListSnapshots" - gRPC call if the driver supports it. If not specified, it indicates - the creation time is unknown. The format of this field is a Unix - nanoseconds time encoded as an int64. On Unix, the command `date - +%s%N` returns the current time in nanoseconds since 1970-01-01 - 00:00:00 UTC. - format: int64 - type: integer - error: - description: error is the last observed error during snapshot creation, - if any. Upon success after retry, this error field will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error - during snapshot creation if specified. NOTE: message may be - logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if a snapshot is ready to be used - to restore a volume. In dynamic snapshot creation case, this field - will be filled in by the CSI snapshotter sidecar with the "ready_to_use" - value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing - snapshot, this field will be filled with the "ready_to_use" value - returned from the CSI "ListSnapshots" gRPC call if the driver supports - it, otherwise, this field will be set to "True". If not specified, - it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - description: restoreSize represents the complete size of the snapshot - in bytes. In dynamic snapshot creation case, this field will be - filled in by the CSI snapshotter sidecar with the "size_bytes" value - returned from CSI "CreateSnapshot" gRPC call. For a pre-existing - snapshot, this field will be filled with the "size_bytes" value - returned from the CSI "ListSnapshots" gRPC call if the driver supports - it. When restoring a volume from this snapshot, the size of the - volume MUST NOT be smaller than the restoreSize if it is specified, - otherwise the restoration will fail. If not specified, it indicates - that the size is unknown. - format: int64 - minimum: 0 - type: integer - snapshotHandle: - description: snapshotHandle is the CSI "snapshot_id" of a snapshot - on the underlying storage system. If not specified, it indicates - that dynamic snapshot creation has either failed or it is still - in progress. - type: string - volumeGroupSnapshotContentName: - description: VolumeGroupSnapshotContentName is the name of the VolumeGroupSnapshotContent - of which this VolumeSnapshotContent is a part of. - type: string - type: object - required: - - spec - type: object - served: true - storage: true - subresources: - status: {} - - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: Represents the complete size of the snapshot in bytes - jsonPath: .status.restoreSize - name: RestoreSize - type: integer - - description: Determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. - jsonPath: .spec.deletionPolicy - name: DeletionPolicy - type: string - - description: Name of the CSI driver used to create the physical snapshot on the underlying storage system. - jsonPath: .spec.driver - name: Driver - type: string - - description: Name of the VolumeSnapshotClass to which this snapshot belongs. - jsonPath: .spec.volumeSnapshotClassName - name: VolumeSnapshotClass - type: string - - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. - jsonPath: .spec.volumeSnapshotRef.name - name: VolumeSnapshot - type: string - - description: Namespace of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. - jsonPath: .spec.volumeSnapshotRef.namespace - name: VolumeSnapshotNamespace - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta1 - # This indicates the v1beta1 version of the custom resource is deprecated. - # API requests to this version receive a warning in the server response. - deprecated: true - # This overrides the default warning returned to clients making v1beta1 API requests. - deprecationWarning: "snapshot.storage.k8s.io/v1beta1 VolumeSnapshotContent is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshotContent" - schema: - openAPIV3Schema: - description: VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system - 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 - spec: - description: spec defines properties of a VolumeSnapshotContent created by the underlying storage system. Required. - properties: - deletionPolicy: - description: deletionPolicy determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. For dynamically provisioned snapshots, this field will automatically be filled in by the CSI snapshotter sidecar with the "DeletionPolicy" field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users MUST specify this field when creating the VolumeSnapshotContent object. Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the CSI driver used to create the physical snapshot on the underlying storage system. This MUST be the same as the name returned by the CSI GetPluginName() call for that driver. Required. - type: string - source: - description: source specifies whether the snapshot is (or should be) dynamically provisioned or already exists, and just requires a Kubernetes object representation. This field is immutable after creation. Required. - properties: - snapshotHandle: - description: snapshotHandle specifies the CSI "snapshot_id" of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. This field is immutable. - type: string - volumeHandle: - description: volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. - type: string - type: object - volumeSnapshotClassName: - description: name of the VolumeSnapshotClass from which this snapshot was (or will be) created. Note that after provisioning, the VolumeSnapshotClass may be deleted or recreated with different set of values, and as such, should not be referenced post-snapshot creation. - type: string - volumeSnapshotRef: - description: volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. - properties: - apiVersion: - description: API version of the referent. - type: string - fieldPath: - description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.' - type: string - kind: - description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' - type: string - namespace: - description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' - type: string - resourceVersion: - description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' - type: string - uid: - description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' - type: string - type: object - required: - - deletionPolicy - - driver - - source - - volumeSnapshotRef - type: object - status: - description: status represents the current information of a snapshot. - properties: - creationTime: - description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it indicates the creation time is unknown. The format of this field is a Unix nanoseconds time encoded as an int64. On Unix, the command `date +%s%N` returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC. - format: int64 - type: integer - error: - description: error is the last observed error during snapshot creation, if any. Upon success after retry, this error field will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if a snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - description: restoreSize represents the complete size of the snapshot in bytes. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. - format: int64 - minimum: 0 - type: integer - snapshotHandle: - description: snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. - type: string - type: object - required: - - spec - type: object - served: false - storage: false - subresources: - status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.11.3 - api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/814" - creationTimestamp: null - name: volumesnapshots.snapshot.storage.k8s.io -spec: - group: snapshot.storage.k8s.io - names: - kind: VolumeSnapshot - listKind: VolumeSnapshotList - plural: volumesnapshots - shortNames: - - vs - singular: volumesnapshot - scope: Namespaced - versions: - - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: If a new snapshot needs to be created, this contains the name of - the source PVC from which this snapshot was (or will be) created. - jsonPath: .spec.source.persistentVolumeClaimName - name: SourcePVC - type: string - - description: If a snapshot already exists, this contains the name of the existing - VolumeSnapshotContent object representing the existing snapshot. - jsonPath: .spec.source.volumeSnapshotContentName - name: SourceSnapshotContent - type: string - - description: Represents the minimum size of volume required to rehydrate from - this snapshot. - jsonPath: .status.restoreSize - name: RestoreSize - type: string - - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. - jsonPath: .spec.volumeSnapshotClassName - name: SnapshotClass - type: string - - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot - object intends to bind to. Please note that verification of binding actually - requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure - both are pointing at each other. Binding MUST be verified prior to usage of - this object. - jsonPath: .status.boundVolumeSnapshotContentName - name: SnapshotContent - type: string - - description: Timestamp when the point-in-time snapshot was taken by the underlying - storage system. - jsonPath: .status.creationTime - name: CreationTime - type: date - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1 - schema: - openAPIV3Schema: - description: VolumeSnapshot is a user's request for either creating a point-in-time - snapshot of a persistent volume, or binding to a pre-existing snapshot. - 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 - spec: - description: 'spec defines the desired characteristics of a snapshot requested - by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots - Required.' - properties: - source: - description: source specifies where a snapshot will be created from. - This field is immutable after creation. Required. - properties: - persistentVolumeClaimName: - description: persistentVolumeClaimName specifies the name of the - PersistentVolumeClaim object representing the volume from which - a snapshot should be created. This PVC is assumed to be in the - same namespace as the VolumeSnapshot object. This field should - be set if the snapshot does not exists, and needs to be created. - This field is immutable. - type: string - volumeSnapshotContentName: - description: volumeSnapshotContentName specifies the name of a - pre-existing VolumeSnapshotContent object representing an existing - volume snapshot. This field should be set if the snapshot already - exists and only needs a representation in Kubernetes. This field - is immutable. - type: string - type: object - oneOf: - - required: ["persistentVolumeClaimName"] - - required: ["volumeSnapshotContentName"] - volumeSnapshotClassName: - description: 'VolumeSnapshotClassName is the name of the VolumeSnapshotClass - requested by the VolumeSnapshot. VolumeSnapshotClassName may be - left nil to indicate that the default SnapshotClass should be used. - A given cluster may have multiple default Volume SnapshotClasses: - one default per CSI Driver. If a VolumeSnapshot does not specify - a SnapshotClass, VolumeSnapshotSource will be checked to figure - out what the associated CSI Driver is, and the default VolumeSnapshotClass - associated with that CSI Driver will be used. If more than one VolumeSnapshotClass - exist for a given CSI Driver and more than one have been marked - as default, CreateSnapshot will fail and generate an event. Empty - string is not allowed for this field.' - type: string - required: - - source - type: object - status: - description: status represents the current information of a snapshot. - Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent - objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent - point at each other) before using this object. - properties: - boundVolumeSnapshotContentName: - description: 'boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent - object to which this VolumeSnapshot object intends to bind to. If - not specified, it indicates that the VolumeSnapshot object has not - been successfully bound to a VolumeSnapshotContent object yet. NOTE: - To avoid possible security issues, consumers must verify binding - between VolumeSnapshot and VolumeSnapshotContent objects is successful - (by validating that both VolumeSnapshot and VolumeSnapshotContent - point at each other) before using this object.' - type: string - creationTime: - description: creationTime is the timestamp when the point-in-time - snapshot is taken by the underlying storage system. In dynamic snapshot - creation case, this field will be filled in by the snapshot controller - with the "creation_time" value returned from CSI "CreateSnapshot" - gRPC call. For a pre-existing snapshot, this field will be filled - with the "creation_time" value returned from the CSI "ListSnapshots" - gRPC call if the driver supports it. If not specified, it may indicate - that the creation time of the snapshot is unknown. - format: date-time - type: string - error: - description: error is the last observed error during snapshot creation, - if any. This field could be helpful to upper level controllers(i.e., - application controller) to decide whether they should continue on - waiting for the snapshot to be created based on the type of error - reported. The snapshot controller will keep retrying when an error - occurs during the snapshot creation. Upon success, this error field - will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error - during snapshot creation if specified. NOTE: message may be - logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if the snapshot is ready to be used - to restore a volume. In dynamic snapshot creation case, this field - will be filled in by the snapshot controller with the "ready_to_use" - value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing - snapshot, this field will be filled with the "ready_to_use" value - returned from the CSI "ListSnapshots" gRPC call if the driver supports - it, otherwise, this field will be set to "True". If not specified, - it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - type: string - description: restoreSize represents the minimum size of volume required - to create a volume from this snapshot. In dynamic snapshot creation - case, this field will be filled in by the snapshot controller with - the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. - For a pre-existing snapshot, this field will be filled with the - "size_bytes" value returned from the CSI "ListSnapshots" gRPC call - if the driver supports it. When restoring a volume from this snapshot, - the size of the volume MUST NOT be smaller than the restoreSize - if it is specified, otherwise the restoration will fail. If not - specified, it indicates that the size is unknown. - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - volumeGroupSnapshotName: - description: VolumeGroupSnapshotName is the name of the VolumeGroupSnapshot - of which this VolumeSnapshot is a part of. - type: string - type: object - required: - - spec - type: object - served: true - storage: true - subresources: - status: {} - - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: If a new snapshot needs to be created, this contains the name of the source PVC from which this snapshot was (or will be) created. - jsonPath: .spec.source.persistentVolumeClaimName - name: SourcePVC - type: string - - description: If a snapshot already exists, this contains the name of the existing VolumeSnapshotContent object representing the existing snapshot. - jsonPath: .spec.source.volumeSnapshotContentName - name: SourceSnapshotContent - type: string - - description: Represents the minimum size of volume required to rehydrate from this snapshot. - jsonPath: .status.restoreSize - name: RestoreSize - type: string - - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. - jsonPath: .spec.volumeSnapshotClassName - name: SnapshotClass - type: string - - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot object intends to bind to. Please note that verification of binding actually requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure both are pointing at each other. Binding MUST be verified prior to usage of this object. - jsonPath: .status.boundVolumeSnapshotContentName - name: SnapshotContent - type: string - - description: Timestamp when the point-in-time snapshot was taken by the underlying storage system. - jsonPath: .status.creationTime - name: CreationTime - type: date - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta1 - # This indicates the v1beta1 version of the custom resource is deprecated. - # API requests to this version receive a warning in the server response. - deprecated: true - # This overrides the default warning returned to clients making v1beta1 API requests. - deprecationWarning: "snapshot.storage.k8s.io/v1beta1 VolumeSnapshot is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshot" - schema: - openAPIV3Schema: - description: VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot. - 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 - spec: - description: 'spec defines the desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots Required.' - properties: - source: - description: source specifies where a snapshot will be created from. This field is immutable after creation. Required. - properties: - persistentVolumeClaimName: - description: persistentVolumeClaimName specifies the name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. This PVC is assumed to be in the same namespace as the VolumeSnapshot object. This field should be set if the snapshot does not exists, and needs to be created. This field is immutable. - type: string - volumeSnapshotContentName: - description: volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable. - type: string - type: object - volumeSnapshotClassName: - description: 'VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field.' - type: string - required: - - source - type: object - status: - description: status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object. - properties: - boundVolumeSnapshotContentName: - description: 'boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent object to which this VolumeSnapshot object intends to bind to. If not specified, it indicates that the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. NOTE: To avoid possible security issues, consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.' - type: string - creationTime: - description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it may indicate that the creation time of the snapshot is unknown. - format: date-time - type: string - error: - description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if the snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - type: string - description: restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. - 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 - required: - - spec - type: object - served: false - storage: false - subresources: - status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -############################################## -########### ############ -########### Controller plugin ############ -########### ############ -############################################## - -kind: ServiceAccount -apiVersion: v1 -metadata: - name: openebs-zfs-controller-sa - namespace: kube-system - ---- -kind: ClusterRole -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-provisioner-role -rules: - - apiGroups: [""] - resources: ["secrets"] - verbs: ["get", "list"] - - apiGroups: [""] - resources: ["namespaces"] - verbs: ["*"] - - apiGroups: [""] - resources: ["persistentvolumes", "services"] - verbs: ["get", "list", "watch", "create", "delete", "update", "patch"] - - apiGroups: [""] - resources: ["persistentvolumeclaims"] - verbs: ["get", "list", "watch", "update"] - - apiGroups: [""] - resources: ["persistentvolumeclaims/status"] - verbs: ["update", "patch"] - - apiGroups: ["storage.k8s.io"] - resources: ["storageclasses", "csinodes"] - verbs: ["get", "list", "watch"] - - apiGroups: [ "storage.k8s.io" ] - resources: [ "csistoragecapacities"] - verbs: ["*"] - - apiGroups: [""] - resources: ["events"] - verbs: ["list", "watch", "create", "update", "patch"] - - apiGroups: ["coordination.k8s.io"] - resources: ["leases"] - verbs: ["get", "watch", "list", "delete", "update", "create"] - - apiGroups: [""] - resources: ["nodes"] - verbs: ["get", "list", "watch"] - - apiGroups: [""] - resources: ["pods"] - verbs: ["get", "list", "watch", "update", "patch"] - - apiGroups: ["*"] - resources: ["zfsvolumes", "zfssnapshots", "zfsbackups", "zfsrestores", "zfsnodes"] - verbs: ["*"] ---- - -kind: ClusterRoleBinding -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-provisioner-binding -subjects: - - kind: ServiceAccount - name: openebs-zfs-controller-sa - namespace: kube-system -roleRef: - kind: ClusterRole - name: openebs-zfs-provisioner-role - apiGroup: rbac.authorization.k8s.io - ---- - -apiVersion: scheduling.k8s.io/v1 -kind: PriorityClass -metadata: - name: openebs-zfs-csi-controller-critical -# A PriorityClass object can have any 32-bit integer value smaller than or equal -# to 1 billion. Larger numbers are reserved for critical system Pods that should -# not normally be preempted or evicted. The higher the value, the higher the priority. -value: 900000000 -globalDefault: false -description: "This priority class should be used for the OpenEBS ZFS localPV CSI driver controller deployment only." - ---- - -kind: Deployment -apiVersion: apps/v1 -metadata: - name: openebs-zfs-controller - namespace: kube-system - labels: - openebs.io/component-name: openebs-zfs-controller - openebs.io/version: ci -spec: - selector: - matchLabels: - app: openebs-zfs-controller - role: openebs-zfs - replicas: 1 - template: - metadata: - labels: - app: openebs-zfs-controller - role: openebs-zfs - openebs.io/component-name: openebs-zfs-controller - openebs.io/version: ci - spec: - affinity: - podAntiAffinity: - requiredDuringSchedulingIgnoredDuringExecution: - - labelSelector: - matchExpressions: - - key: app - operator: In - values: - - openebs-zfs-controller - topologyKey: "kubernetes.io/hostname" - priorityClassName: openebs-zfs-csi-controller-critical - serviceAccountName: openebs-zfs-controller-sa - containers: - - name: csi-resizer - image: registry.k8s.io/sig-storage/csi-resizer:v1.8.0 - args: - - "--v=5" - - "--csi-address=$(ADDRESS)" - - "--leader-election" - env: - - name: ADDRESS - value: /var/lib/csi/sockets/pluginproxy/csi.sock - imagePullPolicy: IfNotPresent - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - - name: csi-snapshotter - image: registry.k8s.io/sig-storage/csi-snapshotter:v6.2.2 - imagePullPolicy: IfNotPresent - args: - - "--csi-address=$(ADDRESS)" - - "--leader-election" - env: - - name: ADDRESS - value: /var/lib/csi/sockets/pluginproxy/csi.sock - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - - name: snapshot-controller - image: registry.k8s.io/sig-storage/snapshot-controller:v6.2.2 - args: - - "--v=5" - - "--leader-election=true" - imagePullPolicy: IfNotPresent - - name: csi-provisioner - image: registry.k8s.io/sig-storage/csi-provisioner:v3.5.0 - imagePullPolicy: IfNotPresent - args: - - "--csi-address=$(ADDRESS)" - - "--v=5" - - "--feature-gates=Topology=true" - - "--strict-topology" - - "--leader-election" - - "--extra-create-metadata=true" - - "--enable-capacity=true" - - "--default-fstype=ext4" - env: - - name: ADDRESS - value: /var/lib/csi/sockets/pluginproxy/csi.sock - - name: NAMESPACE - valueFrom: - fieldRef: - fieldPath: metadata.namespace - - name: POD_NAME - valueFrom: - fieldRef: - fieldPath: metadata.name - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - - name: openebs-zfs-plugin - image: openebs/zfs-driver:ci - imagePullPolicy: IfNotPresent - env: - - name: OPENEBS_CONTROLLER_DRIVER - value: controller - - name: OPENEBS_CSI_ENDPOINT - value: unix:///var/lib/csi/sockets/pluginproxy/csi.sock - - name: OPENEBS_NAMESPACE - value: openebs - - name: OPENEBS_IO_INSTALLER_TYPE - value: "zfs-operator" - - name: OPENEBS_IO_ENABLE_ANALYTICS - value: "true" - args : - - "--endpoint=$(OPENEBS_CSI_ENDPOINT)" - - "--plugin=$(OPENEBS_CONTROLLER_DRIVER)" - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - volumes: - - name: socket-dir - emptyDir: {} ---- - -kind: ClusterRole -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-snapshotter-role -rules: - - apiGroups: [""] - resources: ["persistentvolumes"] - verbs: ["get", "list", "watch"] - - apiGroups: [""] - resources: ["persistentvolumeclaims"] - verbs: ["get", "list", "watch"] - - apiGroups: ["storage.k8s.io"] - resources: ["storageclasses"] - verbs: ["get", "list", "watch"] - - apiGroups: [""] - resources: ["events"] - verbs: ["list", "watch", "create", "update", "patch"] - - apiGroups: [""] - resources: ["secrets"] - verbs: ["get", "list"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshotclasses"] - verbs: ["get", "list", "watch"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshotcontents"] - verbs: ["create", "get", "list", "watch", "update", "delete", "patch"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshots"] - verbs: ["get", "list", "watch", "update", "patch"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshotcontents/status"] - verbs: ["update"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshots/status"] - verbs: ["update"] - - apiGroups: ["apiextensions.k8s.io"] - resources: ["customresourcedefinitions"] - verbs: ["create", "list", "watch", "delete"] - ---- -kind: ClusterRoleBinding -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-snapshotter-binding -subjects: - - kind: ServiceAccount - name: openebs-zfs-controller-sa - namespace: kube-system -roleRef: - kind: ClusterRole - name: openebs-zfs-snapshotter-role - apiGroup: rbac.authorization.k8s.io - ---- - -######################################## -########### ############ -########### Node plugin ############ -########### ############ -######################################## - -apiVersion: v1 -kind: ServiceAccount -metadata: - name: openebs-zfs-node-sa - namespace: kube-system - ---- - -kind: ClusterRole -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-driver-registrar-role -rules: - - apiGroups: [""] - resources: ["events"] - verbs: ["get", "list", "watch", "create", "update", "patch"] - - apiGroups: [""] - resources: ["persistentvolumes", "nodes", "services"] - verbs: ["get", "list"] - - apiGroups: ["*"] - resources: ["zfsvolumes", "zfssnapshots", "zfsbackups", "zfsrestores", "zfsnodes"] - verbs: ["get", "list", "watch", "create", "update", "patch"] - ---- - -kind: ClusterRoleBinding -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-driver-registrar-binding -subjects: - - kind: ServiceAccount - name: openebs-zfs-node-sa - namespace: kube-system -roleRef: - kind: ClusterRole - name: openebs-zfs-driver-registrar-role - apiGroup: rbac.authorization.k8s.io - ---- - -kind: ConfigMap -apiVersion: v1 -metadata: - name: openebs-zfspv-bin - namespace: kube-system # should be the same namespace where it is getting mounted -data: - zfs: | - #!/bin/sh - if [ -x /host/sbin/zfs ]; then - chroot /host /sbin/zfs "$@" - elif [ -x /host/usr/sbin/zfs ]; then - chroot /host /usr/sbin/zfs "$@" - else - chroot /host zfs "$@" - fi - ---- - -apiVersion: scheduling.k8s.io/v1 -kind: PriorityClass -metadata: - name: openebs-zfs-csi-node-critical -# A PriorityClass object can have any 32-bit integer value smaller than or equal -# to 1 billion. Larger numbers are reserved for critical system Pods that should -# not normally be preempted or evicted. The higher the value, the higher the priority. -value: 900001000 -globalDefault: false -description: "This priority class should be used for the OpenEBS ZFS localPV CSI driver node deployment only." - ---- - -kind: DaemonSet -apiVersion: apps/v1 -metadata: - name: openebs-zfs-node - namespace: kube-system - labels: - openebs.io/component-name: openebs-zfs-node - openebs.io/version: ci -spec: - selector: - matchLabels: - app: openebs-zfs-node - updateStrategy: - rollingUpdate: - maxUnavailable: 100% - type: RollingUpdate - template: - metadata: - labels: - app: openebs-zfs-node - role: openebs-zfs - openebs.io/component-name: openebs-zfs-node - openebs.io/version: ci - spec: - priorityClassName: openebs-zfs-csi-node-critical - serviceAccountName: openebs-zfs-node-sa - hostNetwork: true - containers: - - name: csi-node-driver-registrar - image: registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.8.0 - imagePullPolicy: IfNotPresent - args: - - "--v=5" - - "--csi-address=$(ADDRESS)" - - "--kubelet-registration-path=$(DRIVER_REG_SOCK_PATH)" - lifecycle: - preStop: - exec: - command: ["/bin/sh", "-c", "rm -rf /registration/zfs-localpv /registration/zfs-localpv-reg.sock"] - env: - - name: ADDRESS - value: /plugin/csi.sock - - name: DRIVER_REG_SOCK_PATH - value: /var/lib/kubelet/plugins/zfs-localpv/csi.sock - - name: KUBE_NODE_NAME - valueFrom: - fieldRef: - fieldPath: spec.nodeName - - name: NODE_DRIVER - value: openebs-zfs - volumeMounts: - - name: plugin-dir - mountPath: /plugin - - name: registration-dir - mountPath: /registration - - name: openebs-zfs-plugin - securityContext: - privileged: true - allowPrivilegeEscalation: true - image: openebs/zfs-driver:ci - imagePullPolicy: IfNotPresent - args: - - "--nodename=$(OPENEBS_NODE_NAME)" - - "--endpoint=$(OPENEBS_CSI_ENDPOINT)" - - "--plugin=$(OPENEBS_NODE_DRIVER)" - env: - - name: OPENEBS_NODE_NAME - valueFrom: - fieldRef: - fieldPath: spec.nodeName - - name: OPENEBS_CSI_ENDPOINT - value: unix:///plugin/csi.sock - - name: OPENEBS_NODE_DRIVER - value: agent - - name: OPENEBS_NAMESPACE - value: openebs - - name: ALLOWED_TOPOLOGIES - # The desired comma separated keys can be added here, - # by default all the node label keys are allowed. - # For example: - # value: "kubernetes.io/hostname,openebs.io/rack" - value: "All" - volumeMounts: - - name: plugin-dir - mountPath: /plugin - - name: device-dir - mountPath: /dev - - name: encr-keys - mountPath: /home/keys - - name: chroot-zfs - mountPath: /sbin/zfs - subPath: zfs - - name: host-root - mountPath: /host - mountPropagation: "HostToContainer" - readOnly: true - - name: pods-mount-dir - mountPath: /var/lib/kubelet/ - # needed so that any mounts setup inside this container are - # propagated back to the host machine. - mountPropagation: "Bidirectional" - volumes: - - name: device-dir - hostPath: - path: /dev - type: Directory - - name: encr-keys - hostPath: - path: /home/keys - type: DirectoryOrCreate - - name: chroot-zfs - configMap: - defaultMode: 0555 - name: openebs-zfspv-bin - - name: host-root - hostPath: - path: / - type: Directory - - name: registration-dir - hostPath: - path: /var/lib/kubelet/plugins_registry/ - type: DirectoryOrCreate - - name: plugin-dir - hostPath: - path: /var/lib/kubelet/plugins/zfs-localpv/ - type: DirectoryOrCreate - - name: pods-mount-dir - hostPath: - path: /var/lib/kubelet/ - type: Directory ---- diff --git a/deploy/yamls/zfsbackup-crd.yaml b/deploy/yamls/zfsbackup-crd.yaml index 492e5d4b9..fa6d665eb 100644 --- a/deploy/yamls/zfsbackup-crd.yaml +++ b/deploy/yamls/zfsbackup-crd.yaml @@ -1,15 +1,4 @@ - -############################################## -########### ############ -########### ZFSBackup CRD ############ -########### ############ -############################################## - -# ZFSBackups CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition diff --git a/deploy/yamls/zfsnode-crd.yaml b/deploy/yamls/zfsnode-crd.yaml index 9dd98708e..f137ab088 100644 --- a/deploy/yamls/zfsnode-crd.yaml +++ b/deploy/yamls/zfsnode-crd.yaml @@ -1,14 +1,4 @@ -############################################## -########### ############ -########### ZFSNode CRD ############ -########### ############ -############################################## - -# ZFSNode CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition diff --git a/deploy/yamls/zfsrestore-crd.yaml b/deploy/yamls/zfsrestore-crd.yaml index ffffb711b..29c12faac 100644 --- a/deploy/yamls/zfsrestore-crd.yaml +++ b/deploy/yamls/zfsrestore-crd.yaml @@ -1,15 +1,4 @@ - -############################################## -########### ############ -########### ZFSRestore CRD ############ -########### ############ -############################################## - -# ZFSRestores CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition diff --git a/deploy/yamls/zfssnapshot-crd.yaml b/deploy/yamls/zfssnapshot-crd.yaml index fb6a9af9e..dd1911255 100644 --- a/deploy/yamls/zfssnapshot-crd.yaml +++ b/deploy/yamls/zfssnapshot-crd.yaml @@ -1,15 +1,4 @@ - -############################################## -########### ############ -########### ZFSSnapshot CRD ############ -########### ############ -############################################## - -# ZFSSnapshot CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition diff --git a/deploy/yamls/zfsvolume-crd.yaml b/deploy/yamls/zfsvolume-crd.yaml index aeb00f5ac..2a93b636b 100644 --- a/deploy/yamls/zfsvolume-crd.yaml +++ b/deploy/yamls/zfsvolume-crd.yaml @@ -1,15 +1,4 @@ - -############################################## -########### ############ -########### ZFSVolume CRD ############ -########### ############ -############################################## - -# ZFSVolume CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition diff --git a/deploy/zfs-operator.yaml b/deploy/zfs-operator.yaml index 8c42495cc..2846ea49c 100644 --- a/deploy/zfs-operator.yaml +++ b/deploy/zfs-operator.yaml @@ -1,465 +1,186 @@ -# This manifest is autogenerated via `make manifests` command -# Do the modification to the zfs-driver.yaml in directory deploy/yamls/ -# and then run `make manifests` command - -# This manifest deploys the OpenEBS ZFS control plane components, -# with associated CRs & RBAC rules. - -# Create the OpenEBS namespace -# This is the default namespace where the ZFS driver will create all -# its resources. If we want to change it to use a different namespace -# modify this to create the new namespace and also modify the OPENEBS_NAMESPACE -# env for the ZFS Driver's controller and agent deployments. -# please note that this should be changed while initial setup, once ZFS Driver -# is deployed with a namespace, we should never modify it as old resources will -# not be available under the new namespace and ZFS Driver looks for all the resources -# in the OPENEBS_NAMESPACE namespace passed as an env. - +# Source: zfs-localpv/templates/priority-class.yaml +apiVersion: scheduling.k8s.io/v1 +kind: PriorityClass +metadata: + name: openebs-zfs-csi-controller-critical +value: 900000000 +globalDefault: false +description: "This priority class should be used for the CStor CSI driver controller deployment only." +--- +# Source: zfs-localpv/templates/priority-class.yaml +apiVersion: scheduling.k8s.io/v1 +kind: PriorityClass +metadata: + name: openebs-zfs-csi-node-critical +value: 900001000 +globalDefault: false +description: "This priority class should be used for the CStor CSI driver node deployment only." +--- +# Source: zfs-localpv/templates/rbac.yaml +kind: ServiceAccount apiVersion: v1 -kind: Namespace metadata: - name: openebs - - -############################################## -########### ############ -########### ZFSVolume CRD ############ -########### ############ -############################################## - -# ZFSVolume CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - + name: openebs-zfs-controller-sa + namespace: openebs + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" +--- +# Source: zfs-localpv/templates/rbac.yaml +apiVersion: v1 +kind: ServiceAccount +metadata: + name: openebs-zfs-node-sa + namespace: openebs + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + name: "openebs-zfs-node" + release: openebs + openebs.io/component-name: "openebs-zfs-node" +--- +# Source: zfs-localpv/templates/configmap.yaml +kind: ConfigMap +apiVersion: v1 +metadata: + name: openebs-zfspv-bin + namespace: openebs # should be the same namespace where it is getting mounted + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + name: "openebs-zfs-node" + release: openebs + openebs.io/component-name: "openebs-zfs-node" +data: + zfs: | + #!/bin/sh + if [ -x /host/sbin/zfs ]; then + chroot /host /sbin/zfs "$@" + elif [ -x /host/usr/sbin/zfs ]; then + chroot /host /usr/sbin/zfs "$@" + else + chroot /host "zfs" "$@" + fi --- +# Source: zfs-localpv/charts/crds/templates/csi-volume-snapshot-class.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.4.0 + api-approved.kubernetes.io: https://github.com/kubernetes-csi/external-snapshotter/pull/814 + controller-gen.kubebuilder.io/version: v0.11.3 + helm.sh/resource-policy: keep + creationTimestamp: null - name: zfsvolumes.zfs.openebs.io + name: volumesnapshotclasses.snapshot.storage.k8s.io spec: - group: zfs.openebs.io + group: snapshot.storage.k8s.io names: - kind: ZFSVolume - listKind: ZFSVolumeList - plural: zfsvolumes + kind: VolumeSnapshotClass + listKind: VolumeSnapshotClassList + plural: volumesnapshotclasses shortNames: - - zfsvol - - zv - singular: zfsvolume - scope: Namespaced + - vsclass + - vsclasses + singular: volumesnapshotclass + scope: Cluster versions: - additionalPrinterColumns: - - description: ZFS Pool where the volume is created - jsonPath: .spec.poolName - name: ZPool - type: string - - description: Node where the volume is created - jsonPath: .spec.ownerNodeID - name: NodeID - type: string - - description: Size of the volume - jsonPath: .spec.capacity - name: Size - type: string - - description: Status of the volume - jsonPath: .status.state - name: Status + - jsonPath: .driver + name: Driver type: string - - description: filesystem created on the volume - jsonPath: .spec.fsType - name: Filesystem + - description: Determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .deletionPolicy + name: DeletionPolicy type: string - - description: Age of the volume - jsonPath: .metadata.creationTimestamp + - jsonPath: .metadata.creationTimestamp name: Age type: date name: v1 schema: openAPIV3Schema: - description: ZFSVolume represents a ZFS based volume + description: VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced 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' + 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 + deletionPolicy: + description: deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required. + enum: + - Delete + - Retain + type: string + driver: + description: driver is the name of the storage driver that handles this VolumeSnapshotClass. Required. 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' + 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: VolumeInfo defines ZFS volume parameters for all modes in - which ZFS volumes can be created like - ZFS volume with filesystem, - ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. - Some of the parameters can be only set during creation time (as specified - in the details of the parameter), and a few are editable. In case of - Cloned volumes, the parameters are assigned the same values as the source - volume. - properties: - capacity: - description: Capacity of the volume - minLength: 1 - type: string - compression: - description: 'Compression specifies the block-level compression algorithm - to be applied to the ZFS Volume. The value "on" indicates ZFS to - use the default compression algorithm. The default compression algorithm - used by ZFS will be either lzjb or, if the lz4_compress feature - is enabled, lz4. Compression property can be edited after the volume - has been created. The change will only be applied to the newly-written - data. For instance, if the Volume was created with "off" and the - next day the compression was modified to "on", the data written - prior to setting "on" will not be compressed. Default Value: off.' - pattern: ^(on|off|lzjb|zstd|zstd-[1-9]|zstd-1[0-9]|gzip|gzip-[1-9]|zle|lz4)$ - type: string - dedup: - description: 'Deduplication is the process for removing redundant - data at the block level, reducing the total amount of data stored. - If a file system has the dedup property enabled, duplicate data - blocks are removed synchronously. The result is that only unique - data is stored and common components are shared among files. Deduplication - can consume significant processing power (CPU) and memory as well - as generate additional disk IO. Before creating a pool with deduplication - enabled, ensure that you have planned your hardware requirements - appropriately and implemented appropriate recovery practices, such - as regular backups. As an alternative to deduplication consider - using compression=lz4, as a less resource-intensive alternative. - should be enabled on the zvol. Dedup property can be edited after - the volume has been created. Default Value: off.' - enum: - - "on" - - "off" - type: string - encryption: - description: 'Enabling the encryption feature allows for the creation - of encrypted filesystems and volumes. ZFS will encrypt file and - zvol data, file attributes, ACLs, permission bits, directory listings, - FUID mappings, and userused / groupused data. ZFS will not encrypt - metadata related to the pool structure, including dataset and snapshot - names, dataset hierarchy, properties, file size, file holes, and - deduplication tables (though the deduplicated data itself is encrypted). - Default Value: off.' - pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ - type: string - fsType: - description: 'FsType specifies filesystem type for the zfs volume/dataset. - If FsType is provided as "zfs", then the driver will create a ZFS - dataset, formatting is not required as underlying filesystem is - ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver - will create a ZVOL and format the volume accordingly. FsType can - not be modified once volume has been provisioned. Default Value: - ext4.' - type: string - keyformat: - description: KeyFormat specifies format of the encryption key The - supported KeyFormats are passphrase, raw, hex. - enum: - - passphrase - - raw - - hex - type: string - keylocation: - description: KeyLocation is the location of key for the encryption - type: string - ownerNodeID: - description: OwnerNodeID is the Node ID where the ZPOOL is running - which is where the volume has been provisioned. OwnerNodeID can - not be edited after the volume has been provisioned. - minLength: 1 - type: string - poolName: - description: poolName specifies the name of the pool where the volume - has been created. PoolName can not be edited after the volume has - been provisioned. - minLength: 1 - type: string - recordsize: - description: 'Specifies a suggested block size for files in the file - system. The size specified must be a power of two greater than or - equal to 512 and less than or equal to 128 Kbytes. RecordSize property - can be edited after the volume has been created. Changing the file - system''s recordsize affects only files created afterward; existing - files are unaffected. Default Value: 128k.' - minLength: 1 - type: string - shared: - description: Shared specifies whether the volume can be shared among - multiple pods. If it is not set to "yes", then the ZFS-LocalPV Driver - will not allow the volumes to be mounted by more than one pods. - enum: - - "yes" - - "no" - type: string - snapname: - description: SnapName specifies the name of the snapshot where the - volume has been cloned from. Snapname can not be edited after the - volume has been provisioned. - type: string - thinProvision: - description: 'ThinProvision describes whether space reservation for - the source volume is required or not. The value "yes" indicates - that volume should be thin provisioned and "no" means thick provisioning - of the volume. If thinProvision is set to "yes" then volume can - be provisioned even if the ZPOOL does not have the enough capacity. - If thinProvision is set to "no" then volume can be provisioned only - if the ZPOOL has enough capacity and capacity required by volume - can be reserved. ThinProvision can not be modified once volume has - been provisioned. Default Value: no.' - enum: - - "yes" - - "no" - type: string - volblocksize: - description: 'VolBlockSize specifies the block size for the zvol. - The volsize can only be set to a multiple of volblocksize, and cannot - be zero. VolBlockSize can not be edited after the volume has been - provisioned. Default Value: 8k.' - minLength: 1 - type: string - volumeType: - description: volumeType determines whether the volume is of type "DATASET" - or "ZVOL". If fstype provided in the storageclass is "zfs", a volume - of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" - is mentioned as fstype in the storageclass, then a volume of type - zvol will be created, which will be further formatted as the fstype - provided in the storageclass. VolumeType can not be modified once - volume has been provisioned. - enum: - - ZVOL - - DATASET - type: string - required: - - capacity - - ownerNodeID - - poolName - - volumeType - type: object - status: - description: VolStatus string that specifies the current state of the - volume provisioning request. - properties: - state: - description: State specifies the current state of the volume provisioning - request. The state "Pending" means that the volume creation request - has not processed yet. The state "Ready" means that the volume has - been created and it is ready for the use. - enum: - - Pending - - Ready - - Failed - type: string + parameters: + additionalProperties: + type: string + description: parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes. type: object required: - - spec + - deletionPolicy + - driver type: object served: true storage: true subresources: {} - additionalPrinterColumns: - - description: ZFS Pool where the volume is created - jsonPath: .spec.poolName - name: ZPool - type: string - - description: Node where the volume is created - jsonPath: .spec.ownerNodeID - name: Node - type: string - - description: Size of the volume - jsonPath: .spec.capacity - name: Size - type: string - - description: Status of the volume - jsonPath: .status.state - name: Status + - jsonPath: .driver + name: Driver type: string - - description: filesystem created on the volume - jsonPath: .spec.fsType - name: Filesystem + - description: Determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .deletionPolicy + name: DeletionPolicy type: string - - description: Age of the volume - jsonPath: .metadata.creationTimestamp + - jsonPath: .metadata.creationTimestamp name: Age type: date - name: v1alpha1 + deprecated: true + deprecationWarning: snapshot.storage.k8s.io/v1beta1 VolumeSnapshotClass is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshotClass + name: v1beta1 schema: openAPIV3Schema: - description: ZFSVolume represents a ZFS based volume + description: VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced 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' + 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 + deletionPolicy: + description: deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required. + enum: + - Delete + - Retain + type: string + driver: + description: driver is the name of the storage driver that handles this VolumeSnapshotClass. Required. 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' + 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: VolumeInfo defines ZFS volume parameters for all modes in - which ZFS volumes can be created like - ZFS volume with filesystem, - ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. - Some of the parameters can be only set during creation time (as specified - in the details of the parameter), and a few are editable. In case of - Cloned volumes, the parameters are assigned the same values as the source - volume. - properties: - capacity: - description: Capacity of the volume - minLength: 1 - type: string - compression: - description: 'Compression specifies the block-level compression algorithm - to be applied to the ZFS Volume. The value "on" indicates ZFS to - use the default compression algorithm. The default compression algorithm - used by ZFS will be either lzjb or, if the lz4_compress feature - is enabled, lz4. Compression property can be edited after the volume - has been created. The change will only be applied to the newly-written - data. For instance, if the Volume was created with "off" and the - next day the compression was modified to "on", the data written - prior to setting "on" will not be compressed. Default Value: off.' - pattern: ^(on|off|lzjb|gzip|gzip-[1-9]|zle|lz4)$ - type: string - dedup: - description: 'Deduplication is the process for removing redundant - data at the block level, reducing the total amount of data stored. - If a file system has the dedup property enabled, duplicate data - blocks are removed synchronously. The result is that only unique - data is stored and common components are shared among files. Deduplication - can consume significant processing power (CPU) and memory as well - as generate additional disk IO. Before creating a pool with deduplication - enabled, ensure that you have planned your hardware requirements - appropriately and implemented appropriate recovery practices, such - as regular backups. As an alternative to deduplication consider - using compression=lz4, as a less resource-intensive alternative. - should be enabled on the zvol. Dedup property can be edited after - the volume has been created. Default Value: off.' - enum: - - "on" - - "off" - type: string - encryption: - description: 'Enabling the encryption feature allows for the creation - of encrypted filesystems and volumes. ZFS will encrypt file and - zvol data, file attributes, ACLs, permission bits, directory listings, - FUID mappings, and userused / groupused data. ZFS will not encrypt - metadata related to the pool structure, including dataset and snapshot - names, dataset hierarchy, properties, file size, file holes, and - deduplication tables (though the deduplicated data itself is encrypted). - Default Value: off.' - pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ - type: string - fsType: - description: 'FsType specifies filesystem type for the zfs volume/dataset. - If FsType is provided as "zfs", then the driver will create a ZFS - dataset, formatting is not required as underlying filesystem is - ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver - will create a ZVOL and format the volume accordingly. FsType can - not be modified once volume has been provisioned. Default Value: - ext4.' - type: string - keyformat: - description: KeyFormat specifies format of the encryption key The - supported KeyFormats are passphrase, raw, hex. - enum: - - passphrase - - raw - - hex - type: string - keylocation: - description: KeyLocation is the location of key for the encryption - type: string - ownerNodeID: - description: OwnerNodeID is the Node ID where the ZPOOL is running - which is where the volume has been provisioned. OwnerNodeID can - not be edited after the volume has been provisioned. - minLength: 1 - type: string - poolName: - description: poolName specifies the name of the pool where the volume - has been created. PoolName can not be edited after the volume has - been provisioned. - minLength: 1 - type: string - recordsize: - description: 'Specifies a suggested block size for files in the file - system. The size specified must be a power of two greater than or - equal to 512 and less than or equal to 128 Kbytes. RecordSize property - can be edited after the volume has been created. Changing the file - system''s recordsize affects only files created afterward; existing - files are unaffected. Default Value: 128k.' - minLength: 1 - type: string - snapname: - description: SnapName specifies the name of the snapshot where the - volume has been cloned from. Snapname can not be edited after the - volume has been provisioned. - type: string - thinProvision: - description: 'ThinProvision describes whether space reservation for - the source volume is required or not. The value "yes" indicates - that volume should be thin provisioned and "no" means thick provisioning - of the volume. If thinProvision is set to "yes" then volume can - be provisioned even if the ZPOOL does not have the enough capacity. - If thinProvision is set to "no" then volume can be provisioned only - if the ZPOOL has enough capacity and capacity required by volume - can be reserved. ThinProvision can not be modified once volume has - been provisioned. Default Value: no.' - enum: - - "yes" - - "no" - type: string - volblocksize: - description: 'VolBlockSize specifies the block size for the zvol. - The volsize can only be set to a multiple of volblocksize, and cannot - be zero. VolBlockSize can not be edited after the volume has been - provisioned. Default Value: 8k.' - minLength: 1 - type: string - volumeType: - description: volumeType determines whether the volume is of type "DATASET" - or "ZVOL". If fstype provided in the storageclass is "zfs", a volume - of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" - is mentioned as fstype in the storageclass, then a volume of type - zvol will be created, which will be further formatted as the fstype - provided in the storageclass. VolumeType can not be modified once - volume has been provisioned. - enum: - - ZVOL - - DATASET - type: string - required: - - capacity - - ownerNodeID - - poolName - - volumeType - type: object - status: - description: VolStatus string that specifies the current state of the - volume provisioning request. - properties: - state: - description: State specifies the current state of the volume provisioning - request. The state "Pending" means that the volume creation request - has not processed yet. The state "Ready" means that the volume has - been created and it is ready for the use. - enum: - - Pending - - Ready - type: string + parameters: + additionalProperties: + type: string + description: parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes. type: object required: - - spec + - deletionPolicy + - driver type: object - served: true + served: false storage: false subresources: {} status: @@ -468,475 +189,628 @@ status: plural: "" conditions: [] storedVersions: [] - - -############################################## -########### ############ -########### ZFSSnapshot CRD ############ -########### ############ -############################################## - -# ZFSSnapshot CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- +# Source: zfs-localpv/charts/crds/templates/csi-volume-snapshot-content.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.4.0 + api-approved.kubernetes.io: https://github.com/kubernetes-csi/external-snapshotter/pull/814 + controller-gen.kubebuilder.io/version: v0.11.3 + helm.sh/resource-policy: keep + creationTimestamp: null - name: zfssnapshots.zfs.openebs.io + name: volumesnapshotcontents.snapshot.storage.k8s.io spec: - group: zfs.openebs.io + group: snapshot.storage.k8s.io names: - kind: ZFSSnapshot - listKind: ZFSSnapshotList - plural: zfssnapshots + kind: VolumeSnapshotContent + listKind: VolumeSnapshotContentList + plural: volumesnapshotcontents shortNames: - - zfssnap - singular: zfssnapshot - scope: Namespaced + - vsc + - vscs + singular: volumesnapshotcontent + scope: Cluster versions: - - name: v1 + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: Represents the complete size of the snapshot in bytes + jsonPath: .status.restoreSize + name: RestoreSize + type: integer + - description: Determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .spec.deletionPolicy + name: DeletionPolicy + type: string + - description: Name of the CSI driver used to create the physical snapshot on the underlying storage system. + jsonPath: .spec.driver + name: Driver + type: string + - description: Name of the VolumeSnapshotClass to which this snapshot belongs. + jsonPath: .spec.volumeSnapshotClassName + name: VolumeSnapshotClass + type: string + - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. + jsonPath: .spec.volumeSnapshotRef.name + name: VolumeSnapshot + type: string + - description: Namespace of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. + jsonPath: .spec.volumeSnapshotRef.namespace + name: VolumeSnapshotNamespace + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1 schema: openAPIV3Schema: - description: ZFSSnapshot represents a ZFS Snapshot of the zfsvolume + description: VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system 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' + 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' + 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: VolumeInfo defines ZFS volume parameters for all modes in - which ZFS volumes can be created like - ZFS volume with filesystem, - ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. - Some of the parameters can be only set during creation time (as specified - in the details of the parameter), and a few are editable. In case of - Cloned volumes, the parameters are assigned the same values as the source - volume. + description: spec defines properties of a VolumeSnapshotContent created by the underlying storage system. Required. properties: - capacity: - description: Capacity of the volume - minLength: 1 - type: string - compression: - description: 'Compression specifies the block-level compression algorithm - to be applied to the ZFS Volume. The value "on" indicates ZFS to - use the default compression algorithm. The default compression algorithm - used by ZFS will be either lzjb or, if the lz4_compress feature - is enabled, lz4. Compression property can be edited after the volume - has been created. The change will only be applied to the newly-written - data. For instance, if the Volume was created with "off" and the - next day the compression was modified to "on", the data written - prior to setting "on" will not be compressed. Default Value: off.' - pattern: ^(on|off|lzjb|zstd|zstd-[1-9]|zstd-1[0-9]|gzip|gzip-[1-9]|zle|lz4)$ - type: string - dedup: - description: 'Deduplication is the process for removing redundant - data at the block level, reducing the total amount of data stored. - If a file system has the dedup property enabled, duplicate data - blocks are removed synchronously. The result is that only unique - data is stored and common components are shared among files. Deduplication - can consume significant processing power (CPU) and memory as well - as generate additional disk IO. Before creating a pool with deduplication - enabled, ensure that you have planned your hardware requirements - appropriately and implemented appropriate recovery practices, such - as regular backups. As an alternative to deduplication consider - using compression=lz4, as a less resource-intensive alternative. - should be enabled on the zvol. Dedup property can be edited after - the volume has been created. Default Value: off.' - enum: - - "on" - - "off" - type: string - encryption: - description: 'Enabling the encryption feature allows for the creation - of encrypted filesystems and volumes. ZFS will encrypt file and - zvol data, file attributes, ACLs, permission bits, directory listings, - FUID mappings, and userused / groupused data. ZFS will not encrypt - metadata related to the pool structure, including dataset and snapshot - names, dataset hierarchy, properties, file size, file holes, and - deduplication tables (though the deduplicated data itself is encrypted). - Default Value: off.' - pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ - type: string - fsType: - description: 'FsType specifies filesystem type for the zfs volume/dataset. - If FsType is provided as "zfs", then the driver will create a ZFS - dataset, formatting is not required as underlying filesystem is - ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver - will create a ZVOL and format the volume accordingly. FsType can - not be modified once volume has been provisioned. Default Value: - ext4.' - type: string - keyformat: - description: KeyFormat specifies format of the encryption key The - supported KeyFormats are passphrase, raw, hex. - enum: - - passphrase - - raw - - hex - type: string - keylocation: - description: KeyLocation is the location of key for the encryption - type: string - ownerNodeID: - description: OwnerNodeID is the Node ID where the ZPOOL is running - which is where the volume has been provisioned. OwnerNodeID can - not be edited after the volume has been provisioned. - minLength: 1 - type: string - poolName: - description: poolName specifies the name of the pool where the volume - has been created. PoolName can not be edited after the volume has - been provisioned. - minLength: 1 - type: string - recordsize: - description: 'Specifies a suggested block size for files in the file - system. The size specified must be a power of two greater than or - equal to 512 and less than or equal to 128 Kbytes. RecordSize property - can be edited after the volume has been created. Changing the file - system''s recordsize affects only files created afterward; existing - files are unaffected. Default Value: 128k.' - minLength: 1 - type: string - shared: - description: Shared specifies whether the volume can be shared among - multiple pods. If it is not set to "yes", then the ZFS-LocalPV Driver - will not allow the volumes to be mounted by more than one pods. + deletionPolicy: + description: deletionPolicy determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. For dynamically provisioned snapshots, this field will automatically be filled in by the CSI snapshotter sidecar with the "DeletionPolicy" field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users MUST specify this field when creating the VolumeSnapshotContent object. Required. enum: - - "yes" - - "no" - type: string - snapname: - description: SnapName specifies the name of the snapshot where the - volume has been cloned from. Snapname can not be edited after the - volume has been provisioned. + - Delete + - Retain type: string - thinProvision: - description: 'ThinProvision describes whether space reservation for - the source volume is required or not. The value "yes" indicates - that volume should be thin provisioned and "no" means thick provisioning - of the volume. If thinProvision is set to "yes" then volume can - be provisioned even if the ZPOOL does not have the enough capacity. - If thinProvision is set to "no" then volume can be provisioned only - if the ZPOOL has enough capacity and capacity required by volume - can be reserved. ThinProvision can not be modified once volume has - been provisioned. Default Value: no.' - enum: - - "yes" - - "no" + driver: + description: driver is the name of the CSI driver used to create the physical snapshot on the underlying storage system. This MUST be the same as the name returned by the CSI GetPluginName() call for that driver. Required. type: string - volblocksize: - description: 'VolBlockSize specifies the block size for the zvol. - The volsize can only be set to a multiple of volblocksize, and cannot - be zero. VolBlockSize can not be edited after the volume has been - provisioned. Default Value: 8k.' - minLength: 1 + source: + description: source specifies whether the snapshot is (or should be) dynamically provisioned or already exists, and just requires a Kubernetes object representation. This field is immutable after creation. Required. + oneOf: + - required: + - snapshotHandle + - required: + - volumeHandle + properties: + snapshotHandle: + description: snapshotHandle specifies the CSI "snapshot_id" of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. This field is immutable. + type: string + volumeHandle: + description: volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. + type: string + type: object + sourceVolumeMode: + description: SourceVolumeMode is the mode of the volume whose snapshot is taken. Can be either “Filesystem” or “Block”. If not specified, it indicates the source volume's mode is unknown. This field is immutable. This field is an alpha field. type: string - volumeType: - description: volumeType determines whether the volume is of type "DATASET" - or "ZVOL". If fstype provided in the storageclass is "zfs", a volume - of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" - is mentioned as fstype in the storageclass, then a volume of type - zvol will be created, which will be further formatted as the fstype - provided in the storageclass. VolumeType can not be modified once - volume has been provisioned. - enum: - - ZVOL - - DATASET + volumeSnapshotClassName: + description: name of the VolumeSnapshotClass from which this snapshot was (or will be) created. Note that after provisioning, the VolumeSnapshotClass may be deleted or recreated with different set of values, and as such, should not be referenced post-snapshot creation. type: string + volumeSnapshotRef: + description: volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. + properties: + apiVersion: + description: API version of the referent. + type: string + fieldPath: + description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.' + type: string + kind: + description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + namespace: + description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' + type: string + resourceVersion: + description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' + type: string + uid: + description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' + type: string + type: object + x-kubernetes-map-type: atomic required: - - capacity - - ownerNodeID - - poolName - - volumeType + - deletionPolicy + - driver + - source + - volumeSnapshotRef type: object status: - description: SnapStatus string that reflects if the snapshot was created - successfully + description: status represents the current information of a snapshot. properties: - state: + creationTime: + description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it indicates the creation time is unknown. The format of this field is a Unix nanoseconds time encoded as an int64. On Unix, the command `date +%s%N` returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC. + format: int64 + type: integer + error: + description: error is the last observed error during snapshot creation, if any. Upon success after retry, this error field will be cleared. + properties: + message: + description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' + type: string + time: + description: time is the timestamp when the error was encountered. + format: date-time + type: string + type: object + readyToUse: + description: readyToUse indicates if a snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. + type: boolean + restoreSize: + description: restoreSize represents the complete size of the snapshot in bytes. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. + format: int64 + minimum: 0 + type: integer + snapshotHandle: + description: snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. + type: string + volumeGroupSnapshotContentName: + description: VolumeGroupSnapshotContentName is the name of the VolumeGroupSnapshotContent of which this VolumeSnapshotContent is a part of. type: string type: object required: - spec - - status type: object served: true storage: true - - name: v1alpha1 - schema: - openAPIV3Schema: - description: ZFSSnapshot represents a ZFS Snapshot of the zfsvolume - 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 + subresources: + status: {} + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: Represents the complete size of the snapshot in bytes + jsonPath: .status.restoreSize + name: RestoreSize + type: integer + - description: Determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. + jsonPath: .spec.deletionPolicy + name: DeletionPolicy + type: string + - description: Name of the CSI driver used to create the physical snapshot on the underlying storage system. + jsonPath: .spec.driver + name: Driver + type: string + - description: Name of the VolumeSnapshotClass to which this snapshot belongs. + jsonPath: .spec.volumeSnapshotClassName + name: VolumeSnapshotClass + type: string + - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. + jsonPath: .spec.volumeSnapshotRef.name + name: VolumeSnapshot + type: string + - description: Namespace of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. + jsonPath: .spec.volumeSnapshotRef.namespace + name: VolumeSnapshotNamespace + type: string + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + deprecated: true + deprecationWarning: snapshot.storage.k8s.io/v1beta1 VolumeSnapshotContent is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshotContent + name: v1beta1 + schema: + openAPIV3Schema: + description: VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system + 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 spec: - description: VolumeInfo defines ZFS volume parameters for all modes in - which ZFS volumes can be created like - ZFS volume with filesystem, - ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. - Some of the parameters can be only set during creation time (as specified - in the details of the parameter), and a few are editable. In case of - Cloned volumes, the parameters are assigned the same values as the source - volume. + description: spec defines properties of a VolumeSnapshotContent created by the underlying storage system. Required. properties: - capacity: - description: Capacity of the volume - minLength: 1 - type: string - compression: - description: 'Compression specifies the block-level compression algorithm - to be applied to the ZFS Volume. The value "on" indicates ZFS to - use the default compression algorithm. The default compression algorithm - used by ZFS will be either lzjb or, if the lz4_compress feature - is enabled, lz4. Compression property can be edited after the volume - has been created. The change will only be applied to the newly-written - data. For instance, if the Volume was created with "off" and the - next day the compression was modified to "on", the data written - prior to setting "on" will not be compressed. Default Value: off.' - pattern: ^(on|off|lzjb|gzip|gzip-[1-9]|zle|lz4)$ - type: string - dedup: - description: 'Deduplication is the process for removing redundant - data at the block level, reducing the total amount of data stored. - If a file system has the dedup property enabled, duplicate data - blocks are removed synchronously. The result is that only unique - data is stored and common components are shared among files. Deduplication - can consume significant processing power (CPU) and memory as well - as generate additional disk IO. Before creating a pool with deduplication - enabled, ensure that you have planned your hardware requirements - appropriately and implemented appropriate recovery practices, such - as regular backups. As an alternative to deduplication consider - using compression=lz4, as a less resource-intensive alternative. - should be enabled on the zvol. Dedup property can be edited after - the volume has been created. Default Value: off.' - enum: - - "on" - - "off" - type: string - encryption: - description: 'Enabling the encryption feature allows for the creation - of encrypted filesystems and volumes. ZFS will encrypt file and - zvol data, file attributes, ACLs, permission bits, directory listings, - FUID mappings, and userused / groupused data. ZFS will not encrypt - metadata related to the pool structure, including dataset and snapshot - names, dataset hierarchy, properties, file size, file holes, and - deduplication tables (though the deduplicated data itself is encrypted). - Default Value: off.' - pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ - type: string - fsType: - description: 'FsType specifies filesystem type for the zfs volume/dataset. - If FsType is provided as "zfs", then the driver will create a ZFS - dataset, formatting is not required as underlying filesystem is - ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver - will create a ZVOL and format the volume accordingly. FsType can - not be modified once volume has been provisioned. Default Value: - ext4.' - type: string - keyformat: - description: KeyFormat specifies format of the encryption key The - supported KeyFormats are passphrase, raw, hex. - enum: - - passphrase - - raw - - hex - type: string - keylocation: - description: KeyLocation is the location of key for the encryption - type: string - ownerNodeID: - description: OwnerNodeID is the Node ID where the ZPOOL is running - which is where the volume has been provisioned. OwnerNodeID can - not be edited after the volume has been provisioned. - minLength: 1 - type: string - poolName: - description: poolName specifies the name of the pool where the volume - has been created. PoolName can not be edited after the volume has - been provisioned. - minLength: 1 - type: string - recordsize: - description: 'Specifies a suggested block size for files in the file - system. The size specified must be a power of two greater than or - equal to 512 and less than or equal to 128 Kbytes. RecordSize property - can be edited after the volume has been created. Changing the file - system''s recordsize affects only files created afterward; existing - files are unaffected. Default Value: 128k.' - minLength: 1 - type: string - snapname: - description: SnapName specifies the name of the snapshot where the - volume has been cloned from. Snapname can not be edited after the - volume has been provisioned. - type: string - thinProvision: - description: 'ThinProvision describes whether space reservation for - the source volume is required or not. The value "yes" indicates - that volume should be thin provisioned and "no" means thick provisioning - of the volume. If thinProvision is set to "yes" then volume can - be provisioned even if the ZPOOL does not have the enough capacity. - If thinProvision is set to "no" then volume can be provisioned only - if the ZPOOL has enough capacity and capacity required by volume - can be reserved. ThinProvision can not be modified once volume has - been provisioned. Default Value: no.' + deletionPolicy: + description: deletionPolicy determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. For dynamically provisioned snapshots, this field will automatically be filled in by the CSI snapshotter sidecar with the "DeletionPolicy" field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users MUST specify this field when creating the VolumeSnapshotContent object. Required. enum: - - "yes" - - "no" + - Delete + - Retain type: string - volblocksize: - description: 'VolBlockSize specifies the block size for the zvol. - The volsize can only be set to a multiple of volblocksize, and cannot - be zero. VolBlockSize can not be edited after the volume has been - provisioned. Default Value: 8k.' - minLength: 1 + driver: + description: driver is the name of the CSI driver used to create the physical snapshot on the underlying storage system. This MUST be the same as the name returned by the CSI GetPluginName() call for that driver. Required. type: string - volumeType: - description: volumeType determines whether the volume is of type "DATASET" - or "ZVOL". If fstype provided in the storageclass is "zfs", a volume - of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" - is mentioned as fstype in the storageclass, then a volume of type - zvol will be created, which will be further formatted as the fstype - provided in the storageclass. VolumeType can not be modified once - volume has been provisioned. - enum: - - ZVOL - - DATASET + source: + description: source specifies whether the snapshot is (or should be) dynamically provisioned or already exists, and just requires a Kubernetes object representation. This field is immutable after creation. Required. + properties: + snapshotHandle: + description: snapshotHandle specifies the CSI "snapshot_id" of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. This field is immutable. + type: string + volumeHandle: + description: volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. + type: string + type: object + volumeSnapshotClassName: + description: name of the VolumeSnapshotClass from which this snapshot was (or will be) created. Note that after provisioning, the VolumeSnapshotClass may be deleted or recreated with different set of values, and as such, should not be referenced post-snapshot creation. type: string + volumeSnapshotRef: + description: volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. + properties: + apiVersion: + description: API version of the referent. + type: string + fieldPath: + description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.' + type: string + kind: + description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' + type: string + name: + description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' + type: string + namespace: + description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' + type: string + resourceVersion: + description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' + type: string + uid: + description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' + type: string + type: object required: - - capacity - - ownerNodeID - - poolName - - volumeType + - deletionPolicy + - driver + - source + - volumeSnapshotRef type: object status: - description: SnapStatus string that reflects if the snapshot was created - successfully + description: status represents the current information of a snapshot. properties: - state: + creationTime: + description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it indicates the creation time is unknown. The format of this field is a Unix nanoseconds time encoded as an int64. On Unix, the command `date +%s%N` returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC. + format: int64 + type: integer + error: + description: error is the last observed error during snapshot creation, if any. Upon success after retry, this error field will be cleared. + properties: + message: + description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' + type: string + time: + description: time is the timestamp when the error was encountered. + format: date-time + type: string + type: object + readyToUse: + description: readyToUse indicates if a snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. + type: boolean + restoreSize: + description: restoreSize represents the complete size of the snapshot in bytes. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. + format: int64 + minimum: 0 + type: integer + snapshotHandle: + description: snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. type: string type: object required: - spec - - status type: object - served: true + served: false storage: false + subresources: + status: {} status: acceptedNames: kind: "" plural: "" conditions: [] storedVersions: [] - - -############################################## -########### ############ -########### ZFSBackup CRD ############ -########### ############ -############################################## - -# ZFSBackups CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- +# Source: zfs-localpv/charts/crds/templates/csi-volume-snapshot.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.4.0 + api-approved.kubernetes.io: https://github.com/kubernetes-csi/external-snapshotter/pull/814 + controller-gen.kubebuilder.io/version: v0.11.3 + helm.sh/resource-policy: keep + creationTimestamp: null - name: zfsbackups.zfs.openebs.io + name: volumesnapshots.snapshot.storage.k8s.io spec: - group: zfs.openebs.io + group: snapshot.storage.k8s.io names: - kind: ZFSBackup - listKind: ZFSBackupList - plural: zfsbackups + kind: VolumeSnapshot + listKind: VolumeSnapshotList + plural: volumesnapshots shortNames: - - zb - singular: zfsbackup + - vs + singular: volumesnapshot scope: Namespaced versions: - additionalPrinterColumns: - - description: Previous snapshot for backup - jsonPath: .spec.prevSnapName - name: PrevSnap + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: If a new snapshot needs to be created, this contains the name of the source PVC from which this snapshot was (or will be) created. + jsonPath: .spec.source.persistentVolumeClaimName + name: SourcePVC type: string - - description: Backup status - jsonPath: .status - name: Status + - description: If a snapshot already exists, this contains the name of the existing VolumeSnapshotContent object representing the existing snapshot. + jsonPath: .spec.source.volumeSnapshotContentName + name: SourceSnapshotContent type: string - - description: Age of the volume - jsonPath: .metadata.creationTimestamp + - description: Represents the minimum size of volume required to rehydrate from this snapshot. + jsonPath: .status.restoreSize + name: RestoreSize + type: string + - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. + jsonPath: .spec.volumeSnapshotClassName + name: SnapshotClass + type: string + - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot object intends to bind to. Please note that verification of binding actually requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure both are pointing at each other. Binding MUST be verified prior to usage of this object. + jsonPath: .status.boundVolumeSnapshotContentName + name: SnapshotContent + type: string + - description: Timestamp when the point-in-time snapshot was taken by the underlying storage system. + jsonPath: .status.creationTime + name: CreationTime + type: date + - jsonPath: .metadata.creationTimestamp name: Age type: date name: v1 schema: openAPIV3Schema: - description: ZFSBackup describes a zfs backup resource created as a custom - resource + description: VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot. 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' + 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' + 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: ZFSBackupSpec is the spec for a ZFSBackup resource + description: 'spec defines the desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots Required.' properties: - backupDest: - description: BackupDest is the remote address for backup transfer - minLength: 1 - pattern: ^([0-9]+.[0-9]+.[0-9]+.[0-9]+:[0-9]+)$ + source: + description: source specifies where a snapshot will be created from. This field is immutable after creation. Required. + oneOf: + - required: + - persistentVolumeClaimName + - required: + - volumeSnapshotContentName + properties: + persistentVolumeClaimName: + description: persistentVolumeClaimName specifies the name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. This PVC is assumed to be in the same namespace as the VolumeSnapshot object. This field should be set if the snapshot does not exists, and needs to be created. This field is immutable. + type: string + volumeSnapshotContentName: + description: volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable. + type: string + type: object + volumeSnapshotClassName: + description: 'VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field.' + type: string + required: + - source + type: object + status: + description: status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object. + properties: + boundVolumeSnapshotContentName: + description: 'boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent object to which this VolumeSnapshot object intends to bind to. If not specified, it indicates that the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. NOTE: To avoid possible security issues, consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.' + type: string + creationTime: + description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it may indicate that the creation time of the snapshot is unknown. + format: date-time + type: string + error: + description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. + properties: + message: + description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' + type: string + time: + description: time is the timestamp when the error was encountered. + format: date-time + type: string + type: object + readyToUse: + description: readyToUse indicates if the snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. + type: boolean + restoreSize: + description: restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + type: string + x-kubernetes-int-or-string: true + volumeGroupSnapshotName: + description: VolumeGroupSnapshotName is the name of the VolumeGroupSnapshot of which this VolumeSnapshot is a part of. + type: string + type: object + required: + - spec + type: object + served: true + storage: true + subresources: + status: {} + - additionalPrinterColumns: + - description: Indicates if the snapshot is ready to be used to restore a volume. + jsonPath: .status.readyToUse + name: ReadyToUse + type: boolean + - description: If a new snapshot needs to be created, this contains the name of the source PVC from which this snapshot was (or will be) created. + jsonPath: .spec.source.persistentVolumeClaimName + name: SourcePVC + type: string + - description: If a snapshot already exists, this contains the name of the existing VolumeSnapshotContent object representing the existing snapshot. + jsonPath: .spec.source.volumeSnapshotContentName + name: SourceSnapshotContent + type: string + - description: Represents the minimum size of volume required to rehydrate from this snapshot. + jsonPath: .status.restoreSize + name: RestoreSize + type: string + - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. + jsonPath: .spec.volumeSnapshotClassName + name: SnapshotClass + type: string + - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot object intends to bind to. Please note that verification of binding actually requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure both are pointing at each other. Binding MUST be verified prior to usage of this object. + jsonPath: .status.boundVolumeSnapshotContentName + name: SnapshotContent + type: string + - description: Timestamp when the point-in-time snapshot was taken by the underlying storage system. + jsonPath: .status.creationTime + name: CreationTime + type: date + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + deprecated: true + deprecationWarning: snapshot.storage.k8s.io/v1beta1 VolumeSnapshot is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshot + name: v1beta1 + schema: + openAPIV3Schema: + description: VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot. + 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 + spec: + description: 'spec defines the desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots Required.' + properties: + source: + description: source specifies where a snapshot will be created from. This field is immutable after creation. Required. + properties: + persistentVolumeClaimName: + description: persistentVolumeClaimName specifies the name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. This PVC is assumed to be in the same namespace as the VolumeSnapshot object. This field should be set if the snapshot does not exists, and needs to be created. This field is immutable. + type: string + volumeSnapshotContentName: + description: volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable. + type: string + type: object + volumeSnapshotClassName: + description: 'VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field.' + type: string + required: + - source + type: object + status: + description: status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object. + properties: + boundVolumeSnapshotContentName: + description: 'boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent object to which this VolumeSnapshot object intends to bind to. If not specified, it indicates that the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. NOTE: To avoid possible security issues, consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.' + type: string + creationTime: + description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it may indicate that the creation time of the snapshot is unknown. + format: date-time + type: string + error: + description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. + properties: + message: + description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' + type: string + time: + description: time is the timestamp when the error was encountered. + format: date-time + type: string + type: object + readyToUse: + description: readyToUse indicates if the snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. + type: boolean + restoreSize: + description: restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + type: string + x-kubernetes-int-or-string: true + type: object + required: + - spec + type: object + served: false + storage: false + subresources: + status: {} +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] +--- +# Source: zfs-localpv/charts/crds/templates/zfsbackup.yaml +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.4.0 + helm.sh/resource-policy: keep + + creationTimestamp: null + name: zfsbackups.zfs.openebs.io +spec: + group: zfs.openebs.io + names: + kind: ZFSBackup + listKind: ZFSBackupList + plural: zfsbackups + shortNames: + - zb + singular: zfsbackup + scope: Namespaced + versions: + - additionalPrinterColumns: + - description: Previous snapshot for backup + jsonPath: .spec.prevSnapName + name: PrevSnap + type: string + - description: Backup status + jsonPath: .status + name: Status + type: string + - description: Age of the volume + jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1 + schema: + openAPIV3Schema: + description: ZFSBackup describes a zfs backup resource created as a custom resource + 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: ZFSBackupSpec is the spec for a ZFSBackup resource + properties: + backupDest: + description: BackupDest is the remote address for backup transfer + minLength: 1 + pattern: ^([0-9]+.[0-9]+.[0-9]+.[0-9]+:[0-9]+)$ type: string ownerNodeID: - description: OwnerNodeID is a name of the nodes where the source volume - is + description: OwnerNodeID is a name of the nodes where the source volume is minLength: 1 type: string prevSnapName: - description: PrevSnapName is the last completed-backup's snapshot - name + description: PrevSnapName is the last completed-backup's snapshot name type: string snapName: description: SnapName is the snapshot name for backup minLength: 1 type: string volumeName: - description: VolumeName is a name of the volume for which this backup - is destined + description: VolumeName is a name of the volume for which this backup is destined minLength: 1 type: string required: @@ -967,151 +841,175 @@ status: plural: "" conditions: [] storedVersions: [] - - -############################################## -########### ############ -########### ZFSRestore CRD ############ -########### ############ -############################################## - -# ZFSRestores CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- +# Source: zfs-localpv/charts/crds/templates/zfsnode.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.4.0 + helm.sh/resource-policy: keep + creationTimestamp: null - name: zfsrestores.zfs.openebs.io + name: zfsnodes.zfs.openebs.io spec: group: zfs.openebs.io names: - kind: ZFSRestore - listKind: ZFSRestoreList - plural: zfsrestores - singular: zfsrestore + kind: ZFSNode + listKind: ZFSNodeList + plural: zfsnodes + shortNames: + - zfsnode + singular: zfsnode scope: Namespaced versions: - name: v1 schema: openAPIV3Schema: - description: ZFSRestore describes a cstor restore resource created as a custom - resource + description: ZFSNode records information about all zfs pools available in a node. In general, the openebs node-agent creates the ZFSNode object & periodically synchronizing the zfs pools available in the node. ZFSNode has an owner reference pointing to the corresponding node object. 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' + 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' + 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: ZFSRestoreSpec is the spec for a ZFSRestore resource - properties: - ownerNodeID: - description: owner node name where restore volume is present - minLength: 1 - type: string - restoreSrc: - description: it can be ip:port in case of restore from remote or volumeName - in case of local restore - minLength: 1 - pattern: ^([0-9]+.[0-9]+.[0-9]+.[0-9]+:[0-9]+)$ - type: string - volumeName: - description: volume name to where restore has to be performed - minLength: 1 - type: string - required: - - ownerNodeID - - restoreSrc - - volumeName - type: object - status: - description: ZFSRestoreStatus is to hold result of action. - enum: - - Init - - Done - - Failed - - Pending - - InProgress - - Invalid - type: string - volSpec: - description: VolumeInfo defines ZFS volume parameters for all modes in - which ZFS volumes can be created like - ZFS volume with filesystem, - ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. - Some of the parameters can be only set during creation time (as specified - in the details of the parameter), and a few are editable. In case of - Cloned volumes, the parameters are assigned the same values as the source - volume. - properties: - capacity: - description: Capacity of the volume - minLength: 1 - type: string + pools: + items: + description: Pool specifies attributes of a given zfs pool that exists on the node. + properties: + free: + anyOf: + - type: integer + - type: string + description: Free specifies the available capacity of zfs pool. + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + name: + description: Name of the zfs pool. + minLength: 1 + type: string + used: + anyOf: + - type: integer + - type: string + description: Used specifies the used capacity of zfs pool. + pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ + x-kubernetes-int-or-string: true + uuid: + description: UUID denotes a unique identity of a zfs pool. + minLength: 1 + type: string + required: + - free + - name + - used + - uuid + type: object + type: array + required: + - pools + type: object + served: true + storage: true +status: + acceptedNames: + kind: "" + plural: "" + conditions: [] + storedVersions: [] +--- +# Source: zfs-localpv/charts/crds/templates/zfsrestore.yaml +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.4.0 + helm.sh/resource-policy: keep + + creationTimestamp: null + name: zfsrestores.zfs.openebs.io +spec: + group: zfs.openebs.io + names: + kind: ZFSRestore + listKind: ZFSRestoreList + plural: zfsrestores + singular: zfsrestore + scope: Namespaced + versions: + - name: v1 + schema: + openAPIV3Schema: + description: ZFSRestore describes a cstor restore resource created as a custom resource + 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: ZFSRestoreSpec is the spec for a ZFSRestore resource + properties: + ownerNodeID: + description: owner node name where restore volume is present + minLength: 1 + type: string + restoreSrc: + description: it can be ip:port in case of restore from remote or volumeName in case of local restore + minLength: 1 + pattern: ^([0-9]+.[0-9]+.[0-9]+.[0-9]+:[0-9]+)$ + type: string + volumeName: + description: volume name to where restore has to be performed + minLength: 1 + type: string + required: + - ownerNodeID + - restoreSrc + - volumeName + type: object + status: + description: ZFSRestoreStatus is to hold result of action. + enum: + - Init + - Done + - Failed + - Pending + - InProgress + - Invalid + type: string + volSpec: + description: VolumeInfo defines ZFS volume parameters for all modes in which ZFS volumes can be created like - ZFS volume with filesystem, ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. Some of the parameters can be only set during creation time (as specified in the details of the parameter), and a few are editable. In case of Cloned volumes, the parameters are assigned the same values as the source volume. + properties: + capacity: + description: Capacity of the volume + minLength: 1 + type: string compression: - description: 'Compression specifies the block-level compression algorithm - to be applied to the ZFS Volume. The value "on" indicates ZFS to - use the default compression algorithm. The default compression algorithm - used by ZFS will be either lzjb or, if the lz4_compress feature - is enabled, lz4. Compression property can be edited after the volume - has been created. The change will only be applied to the newly-written - data. For instance, if the Volume was created with "off" and the - next day the compression was modified to "on", the data written - prior to setting "on" will not be compressed. Default Value: off.' + description: 'Compression specifies the block-level compression algorithm to be applied to the ZFS Volume. The value "on" indicates ZFS to use the default compression algorithm. The default compression algorithm used by ZFS will be either lzjb or, if the lz4_compress feature is enabled, lz4. Compression property can be edited after the volume has been created. The change will only be applied to the newly-written data. For instance, if the Volume was created with "off" and the next day the compression was modified to "on", the data written prior to setting "on" will not be compressed. Default Value: off.' pattern: ^(on|off|lzjb|zstd|zstd-[1-9]|zstd-1[0-9]|gzip|gzip-[1-9]|zle|lz4)$ type: string dedup: - description: 'Deduplication is the process for removing redundant - data at the block level, reducing the total amount of data stored. - If a file system has the dedup property enabled, duplicate data - blocks are removed synchronously. The result is that only unique - data is stored and common components are shared among files. Deduplication - can consume significant processing power (CPU) and memory as well - as generate additional disk IO. Before creating a pool with deduplication - enabled, ensure that you have planned your hardware requirements - appropriately and implemented appropriate recovery practices, such - as regular backups. As an alternative to deduplication consider - using compression=lz4, as a less resource-intensive alternative. - should be enabled on the zvol. Dedup property can be edited after - the volume has been created. Default Value: off.' + description: 'Deduplication is the process for removing redundant data at the block level, reducing the total amount of data stored. If a file system has the dedup property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files. Deduplication can consume significant processing power (CPU) and memory as well as generate additional disk IO. Before creating a pool with deduplication enabled, ensure that you have planned your hardware requirements appropriately and implemented appropriate recovery practices, such as regular backups. As an alternative to deduplication consider using compression=lz4, as a less resource-intensive alternative. should be enabled on the zvol. Dedup property can be edited after the volume has been created. Default Value: off.' enum: - "on" - "off" type: string encryption: - description: 'Enabling the encryption feature allows for the creation - of encrypted filesystems and volumes. ZFS will encrypt file and - zvol data, file attributes, ACLs, permission bits, directory listings, - FUID mappings, and userused / groupused data. ZFS will not encrypt - metadata related to the pool structure, including dataset and snapshot - names, dataset hierarchy, properties, file size, file holes, and - deduplication tables (though the deduplicated data itself is encrypted). - Default Value: off.' + description: 'Enabling the encryption feature allows for the creation of encrypted filesystems and volumes. ZFS will encrypt file and zvol data, file attributes, ACLs, permission bits, directory listings, FUID mappings, and userused / groupused data. ZFS will not encrypt metadata related to the pool structure, including dataset and snapshot names, dataset hierarchy, properties, file size, file holes, and deduplication tables (though the deduplicated data itself is encrypted). Default Value: off.' pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ type: string fsType: - description: 'FsType specifies filesystem type for the zfs volume/dataset. - If FsType is provided as "zfs", then the driver will create a ZFS - dataset, formatting is not required as underlying filesystem is - ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver - will create a ZVOL and format the volume accordingly. FsType can - not be modified once volume has been provisioned. Default Value: - ext4.' + description: 'FsType specifies filesystem type for the zfs volume/dataset. If FsType is provided as "zfs", then the driver will create a ZFS dataset, formatting is not required as underlying filesystem is ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver will create a ZVOL and format the volume accordingly. FsType can not be modified once volume has been provisioned. Default Value: ext4.' type: string keyformat: - description: KeyFormat specifies format of the encryption key The - supported KeyFormats are passphrase, raw, hex. + description: KeyFormat specifies format of the encryption key The supported KeyFormats are passphrase, raw, hex. enum: - passphrase - raw @@ -1121,68 +1019,38 @@ spec: description: KeyLocation is the location of key for the encryption type: string ownerNodeID: - description: OwnerNodeID is the Node ID where the ZPOOL is running - which is where the volume has been provisioned. OwnerNodeID can - not be edited after the volume has been provisioned. + description: OwnerNodeID is the Node ID where the ZPOOL is running which is where the volume has been provisioned. OwnerNodeID can not be edited after the volume has been provisioned. minLength: 1 type: string poolName: - description: poolName specifies the name of the pool where the volume - has been created. PoolName can not be edited after the volume has - been provisioned. + description: poolName specifies the name of the pool where the volume has been created. PoolName can not be edited after the volume has been provisioned. minLength: 1 type: string recordsize: - description: 'Specifies a suggested block size for files in the file - system. The size specified must be a power of two greater than or - equal to 512 and less than or equal to 128 Kbytes. RecordSize property - can be edited after the volume has been created. Changing the file - system''s recordsize affects only files created afterward; existing - files are unaffected. Default Value: 128k.' + description: 'Specifies a suggested block size for files in the file system. The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes. RecordSize property can be edited after the volume has been created. Changing the file system''s recordsize affects only files created afterward; existing files are unaffected. Default Value: 128k.' minLength: 1 type: string shared: - description: Shared specifies whether the volume can be shared among - multiple pods. If it is not set to "yes", then the ZFS-LocalPV Driver - will not allow the volumes to be mounted by more than one pods. + description: Shared specifies whether the volume can be shared among multiple pods. If it is not set to "yes", then the ZFS-LocalPV Driver will not allow the volumes to be mounted by more than one pods. enum: - "yes" - "no" type: string snapname: - description: SnapName specifies the name of the snapshot where the - volume has been cloned from. Snapname can not be edited after the - volume has been provisioned. + description: SnapName specifies the name of the snapshot where the volume has been cloned from. Snapname can not be edited after the volume has been provisioned. type: string thinProvision: - description: 'ThinProvision describes whether space reservation for - the source volume is required or not. The value "yes" indicates - that volume should be thin provisioned and "no" means thick provisioning - of the volume. If thinProvision is set to "yes" then volume can - be provisioned even if the ZPOOL does not have the enough capacity. - If thinProvision is set to "no" then volume can be provisioned only - if the ZPOOL has enough capacity and capacity required by volume - can be reserved. ThinProvision can not be modified once volume has - been provisioned. Default Value: no.' + description: 'ThinProvision describes whether space reservation for the source volume is required or not. The value "yes" indicates that volume should be thin provisioned and "no" means thick provisioning of the volume. If thinProvision is set to "yes" then volume can be provisioned even if the ZPOOL does not have the enough capacity. If thinProvision is set to "no" then volume can be provisioned only if the ZPOOL has enough capacity and capacity required by volume can be reserved. ThinProvision can not be modified once volume has been provisioned. Default Value: no.' enum: - "yes" - "no" type: string volblocksize: - description: 'VolBlockSize specifies the block size for the zvol. - The volsize can only be set to a multiple of volblocksize, and cannot - be zero. VolBlockSize can not be edited after the volume has been - provisioned. Default Value: 8k.' + description: 'VolBlockSize specifies the block size for the zvol. The volsize can only be set to a multiple of volblocksize, and cannot be zero. VolBlockSize can not be edited after the volume has been provisioned. Default Value: 8k.' minLength: 1 type: string volumeType: - description: volumeType determines whether the volume is of type "DATASET" - or "ZVOL". If fstype provided in the storageclass is "zfs", a volume - of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" - is mentioned as fstype in the storageclass, then a volume of type - zvol will be created, which will be further formatted as the fstype - provided in the storageclass. VolumeType can not be modified once - volume has been provisioned. + description: volumeType determines whether the volume is of type "DATASET" or "ZVOL". If fstype provided in the storageclass is "zfs", a volume of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype in the storageclass, then a volume of type zvol will be created, which will be further formatted as the fstype provided in the storageclass. VolumeType can not be modified once volume has been provisioned. enum: - ZVOL - DATASET @@ -1205,643 +1073,226 @@ status: plural: "" conditions: [] storedVersions: [] - -############################################## -########### ############ -########### ZFSNode CRD ############ -########### ############ -############################################## - -# ZFSNode CRD is autogenerated via `make manifests` command. -# Do the modification in the code and run the `make manifests` command -# to generate the CRD definition - --- +# Source: zfs-localpv/charts/crds/templates/zfssnapshot.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.4.0 + helm.sh/resource-policy: keep + creationTimestamp: null - name: zfsnodes.zfs.openebs.io + name: zfssnapshots.zfs.openebs.io spec: group: zfs.openebs.io names: - kind: ZFSNode - listKind: ZFSNodeList - plural: zfsnodes + kind: ZFSSnapshot + listKind: ZFSSnapshotList + plural: zfssnapshots shortNames: - - zfsnode - singular: zfsnode + - zfssnap + singular: zfssnapshot scope: Namespaced versions: - name: v1 schema: openAPIV3Schema: - description: ZFSNode records information about all zfs pools available in - a node. In general, the openebs node-agent creates the ZFSNode object & - periodically synchronizing the zfs pools available in the node. ZFSNode - has an owner reference pointing to the corresponding node object. + description: ZFSSnapshot represents a ZFS Snapshot of the zfsvolume 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' + 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' + 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 - pools: - items: - description: Pool specifies attributes of a given zfs pool that exists - on the node. - properties: - free: - anyOf: - - type: integer - - type: string - description: Free specifies the available capacity of zfs pool. - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - name: - description: Name of the zfs pool. - minLength: 1 - type: string - used: - anyOf: - - type: integer - - type: string - description: Used specifies the used capacity of zfs pool. - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - uuid: - description: UUID denotes a unique identity of a zfs pool. - minLength: 1 - type: string - required: - - free - - name - - used - - uuid - type: object - type: array + spec: + description: VolumeInfo defines ZFS volume parameters for all modes in which ZFS volumes can be created like - ZFS volume with filesystem, ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. Some of the parameters can be only set during creation time (as specified in the details of the parameter), and a few are editable. In case of Cloned volumes, the parameters are assigned the same values as the source volume. + properties: + capacity: + description: Capacity of the volume + minLength: 1 + type: string + compression: + description: 'Compression specifies the block-level compression algorithm to be applied to the ZFS Volume. The value "on" indicates ZFS to use the default compression algorithm. The default compression algorithm used by ZFS will be either lzjb or, if the lz4_compress feature is enabled, lz4. Compression property can be edited after the volume has been created. The change will only be applied to the newly-written data. For instance, if the Volume was created with "off" and the next day the compression was modified to "on", the data written prior to setting "on" will not be compressed. Default Value: off.' + pattern: ^(on|off|lzjb|zstd|zstd-[1-9]|zstd-1[0-9]|gzip|gzip-[1-9]|zle|lz4)$ + type: string + dedup: + description: 'Deduplication is the process for removing redundant data at the block level, reducing the total amount of data stored. If a file system has the dedup property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files. Deduplication can consume significant processing power (CPU) and memory as well as generate additional disk IO. Before creating a pool with deduplication enabled, ensure that you have planned your hardware requirements appropriately and implemented appropriate recovery practices, such as regular backups. As an alternative to deduplication consider using compression=lz4, as a less resource-intensive alternative. should be enabled on the zvol. Dedup property can be edited after the volume has been created. Default Value: off.' + enum: + - "on" + - "off" + type: string + encryption: + description: 'Enabling the encryption feature allows for the creation of encrypted filesystems and volumes. ZFS will encrypt file and zvol data, file attributes, ACLs, permission bits, directory listings, FUID mappings, and userused / groupused data. ZFS will not encrypt metadata related to the pool structure, including dataset and snapshot names, dataset hierarchy, properties, file size, file holes, and deduplication tables (though the deduplicated data itself is encrypted). Default Value: off.' + pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ + type: string + fsType: + description: 'FsType specifies filesystem type for the zfs volume/dataset. If FsType is provided as "zfs", then the driver will create a ZFS dataset, formatting is not required as underlying filesystem is ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver will create a ZVOL and format the volume accordingly. FsType can not be modified once volume has been provisioned. Default Value: ext4.' + type: string + keyformat: + description: KeyFormat specifies format of the encryption key The supported KeyFormats are passphrase, raw, hex. + enum: + - passphrase + - raw + - hex + type: string + keylocation: + description: KeyLocation is the location of key for the encryption + type: string + ownerNodeID: + description: OwnerNodeID is the Node ID where the ZPOOL is running which is where the volume has been provisioned. OwnerNodeID can not be edited after the volume has been provisioned. + minLength: 1 + type: string + poolName: + description: poolName specifies the name of the pool where the volume has been created. PoolName can not be edited after the volume has been provisioned. + minLength: 1 + type: string + recordsize: + description: 'Specifies a suggested block size for files in the file system. The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes. RecordSize property can be edited after the volume has been created. Changing the file system''s recordsize affects only files created afterward; existing files are unaffected. Default Value: 128k.' + minLength: 1 + type: string + shared: + description: Shared specifies whether the volume can be shared among multiple pods. If it is not set to "yes", then the ZFS-LocalPV Driver will not allow the volumes to be mounted by more than one pods. + enum: + - "yes" + - "no" + type: string + snapname: + description: SnapName specifies the name of the snapshot where the volume has been cloned from. Snapname can not be edited after the volume has been provisioned. + type: string + thinProvision: + description: 'ThinProvision describes whether space reservation for the source volume is required or not. The value "yes" indicates that volume should be thin provisioned and "no" means thick provisioning of the volume. If thinProvision is set to "yes" then volume can be provisioned even if the ZPOOL does not have the enough capacity. If thinProvision is set to "no" then volume can be provisioned only if the ZPOOL has enough capacity and capacity required by volume can be reserved. ThinProvision can not be modified once volume has been provisioned. Default Value: no.' + enum: + - "yes" + - "no" + type: string + volblocksize: + description: 'VolBlockSize specifies the block size for the zvol. The volsize can only be set to a multiple of volblocksize, and cannot be zero. VolBlockSize can not be edited after the volume has been provisioned. Default Value: 8k.' + minLength: 1 + type: string + volumeType: + description: volumeType determines whether the volume is of type "DATASET" or "ZVOL". If fstype provided in the storageclass is "zfs", a volume of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype in the storageclass, then a volume of type zvol will be created, which will be further formatted as the fstype provided in the storageclass. VolumeType can not be modified once volume has been provisioned. + enum: + - ZVOL + - DATASET + type: string + required: + - capacity + - ownerNodeID + - poolName + - volumeType + type: object + status: + description: SnapStatus string that reflects if the snapshot was created successfully + properties: + state: + type: string + type: object required: - - pools + - spec + - status type: object served: true storage: true -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] - ---- - -# Create the CSI Driver object -apiVersion: storage.k8s.io/v1 -kind: CSIDriver -metadata: - name: zfs.csi.openebs.io -spec: - # do not require volumeattachment - attachRequired: false - podInfoOnMount: false - storageCapacity: true ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.11.3 - api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/814" - creationTimestamp: null - name: volumesnapshotclasses.snapshot.storage.k8s.io -spec: - group: snapshot.storage.k8s.io - names: - kind: VolumeSnapshotClass - listKind: VolumeSnapshotClassList - plural: volumesnapshotclasses - shortNames: - - vsclass - - vsclasses - singular: volumesnapshotclass - scope: Cluster - versions: - - additionalPrinterColumns: - - jsonPath: .driver - name: Driver - type: string - - description: Determines whether a VolumeSnapshotContent created through the - VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. - jsonPath: .deletionPolicy - name: DeletionPolicy - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1 - schema: - openAPIV3Schema: - description: VolumeSnapshotClass specifies parameters that a underlying storage - system uses when creating a volume snapshot. A specific VolumeSnapshotClass - is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses - are non-namespaced - 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 - deletionPolicy: - description: deletionPolicy determines whether a VolumeSnapshotContent - created through the VolumeSnapshotClass should be deleted when its bound - VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". - "Retain" means that the VolumeSnapshotContent and its physical snapshot - on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent - and its physical snapshot on underlying storage system are deleted. - Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the storage driver that handles this - VolumeSnapshotClass. Required. - 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 - parameters: - additionalProperties: - type: string - description: parameters is a key-value map with storage driver specific - parameters for creating snapshots. These values are opaque to Kubernetes. - type: object - required: - - deletionPolicy - - driver - type: object - served: true - storage: true - subresources: {} - - additionalPrinterColumns: - - jsonPath: .driver - name: Driver - type: string - - description: Determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. - jsonPath: .deletionPolicy - name: DeletionPolicy - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta1 - # This indicates the v1beta1 version of the custom resource is deprecated. - # API requests to this version receive a warning in the server response. - deprecated: true - # This overrides the default warning returned to clients making v1beta1 API requests. - deprecationWarning: "snapshot.storage.k8s.io/v1beta1 VolumeSnapshotClass is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshotClass" + - name: v1alpha1 schema: openAPIV3Schema: - description: VolumeSnapshotClass specifies parameters that a underlying storage system uses when creating a volume snapshot. A specific VolumeSnapshotClass is used by specifying its name in a VolumeSnapshot object. VolumeSnapshotClasses are non-namespaced + description: ZFSSnapshot represents a ZFS Snapshot of the zfsvolume 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 - deletionPolicy: - description: deletionPolicy determines whether a VolumeSnapshotContent created through the VolumeSnapshotClass should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the storage driver that handles this VolumeSnapshotClass. Required. - 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 - parameters: - additionalProperties: - type: string - description: parameters is a key-value map with storage driver specific parameters for creating snapshots. These values are opaque to Kubernetes. + metadata: type: object - required: - - deletionPolicy - - driver - type: object - served: false - storage: false - subresources: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.11.3 - api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/814" - creationTimestamp: null - name: volumesnapshotcontents.snapshot.storage.k8s.io -spec: - group: snapshot.storage.k8s.io - names: - kind: VolumeSnapshotContent - listKind: VolumeSnapshotContentList - plural: volumesnapshotcontents - shortNames: - - vsc - - vscs - singular: volumesnapshotcontent - scope: Cluster - versions: - - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: Represents the complete size of the snapshot in bytes - jsonPath: .status.restoreSize - name: RestoreSize - type: integer - - description: Determines whether this VolumeSnapshotContent and its physical - snapshot on the underlying storage system should be deleted when its bound - VolumeSnapshot is deleted. - jsonPath: .spec.deletionPolicy - name: DeletionPolicy - type: string - - description: Name of the CSI driver used to create the physical snapshot on - the underlying storage system. - jsonPath: .spec.driver - name: Driver - type: string - - description: Name of the VolumeSnapshotClass to which this snapshot belongs. - jsonPath: .spec.volumeSnapshotClassName - name: VolumeSnapshotClass - type: string - - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent - object is bound. - jsonPath: .spec.volumeSnapshotRef.name - name: VolumeSnapshot - type: string - - description: Namespace of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. - jsonPath: .spec.volumeSnapshotRef.namespace - name: VolumeSnapshotNamespace - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1 - schema: - openAPIV3Schema: - description: VolumeSnapshotContent represents the actual "on-disk" snapshot - object in the underlying storage system - 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 spec: - description: spec defines properties of a VolumeSnapshotContent created - by the underlying storage system. Required. + description: VolumeInfo defines ZFS volume parameters for all modes in which ZFS volumes can be created like - ZFS volume with filesystem, ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. Some of the parameters can be only set during creation time (as specified in the details of the parameter), and a few are editable. In case of Cloned volumes, the parameters are assigned the same values as the source volume. properties: - deletionPolicy: - description: deletionPolicy determines whether this VolumeSnapshotContent - and its physical snapshot on the underlying storage system should - be deleted when its bound VolumeSnapshot is deleted. Supported values - are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent - and its physical snapshot on underlying storage system are kept. - "Delete" means that the VolumeSnapshotContent and its physical snapshot - on underlying storage system are deleted. For dynamically provisioned - snapshots, this field will automatically be filled in by the CSI - snapshotter sidecar with the "DeletionPolicy" field defined in the - corresponding VolumeSnapshotClass. For pre-existing snapshots, users - MUST specify this field when creating the VolumeSnapshotContent - object. Required. - enum: - - Delete - - Retain - type: string - driver: - description: driver is the name of the CSI driver used to create the - physical snapshot on the underlying storage system. This MUST be - the same as the name returned by the CSI GetPluginName() call for - that driver. Required. + capacity: + description: Capacity of the volume + minLength: 1 type: string - source: - description: source specifies whether the snapshot is (or should be) - dynamically provisioned or already exists, and just requires a Kubernetes - object representation. This field is immutable after creation. Required. - properties: - snapshotHandle: - description: snapshotHandle specifies the CSI "snapshot_id" of - a pre-existing snapshot on the underlying storage system for - which a Kubernetes object representation was (or should be) - created. This field is immutable. - type: string - volumeHandle: - description: volumeHandle specifies the CSI "volume_id" of the - volume from which a snapshot should be dynamically taken from. - This field is immutable. - type: string - type: object - oneOf: - - required: ["snapshotHandle"] - - required: ["volumeHandle"] - sourceVolumeMode: - description: SourceVolumeMode is the mode of the volume whose snapshot - is taken. Can be either “Filesystem” or “Block”. If not specified, - it indicates the source volume's mode is unknown. This field is - immutable. This field is an alpha field. + compression: + description: 'Compression specifies the block-level compression algorithm to be applied to the ZFS Volume. The value "on" indicates ZFS to use the default compression algorithm. The default compression algorithm used by ZFS will be either lzjb or, if the lz4_compress feature is enabled, lz4. Compression property can be edited after the volume has been created. The change will only be applied to the newly-written data. For instance, if the Volume was created with "off" and the next day the compression was modified to "on", the data written prior to setting "on" will not be compressed. Default Value: off.' + pattern: ^(on|off|lzjb|gzip|gzip-[1-9]|zle|lz4)$ type: string - volumeSnapshotClassName: - description: name of the VolumeSnapshotClass from which this snapshot - was (or will be) created. Note that after provisioning, the VolumeSnapshotClass - may be deleted or recreated with different set of values, and as - such, should not be referenced post-snapshot creation. + dedup: + description: 'Deduplication is the process for removing redundant data at the block level, reducing the total amount of data stored. If a file system has the dedup property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files. Deduplication can consume significant processing power (CPU) and memory as well as generate additional disk IO. Before creating a pool with deduplication enabled, ensure that you have planned your hardware requirements appropriately and implemented appropriate recovery practices, such as regular backups. As an alternative to deduplication consider using compression=lz4, as a less resource-intensive alternative. should be enabled on the zvol. Dedup property can be edited after the volume has been created. Default Value: off.' + enum: + - "on" + - "off" type: string - volumeSnapshotRef: - description: volumeSnapshotRef specifies the VolumeSnapshot object - to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName - field must reference to this VolumeSnapshotContent's name for the - bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent - object, name and namespace of the VolumeSnapshot object MUST be - provided for binding to happen. This field is immutable after creation. - Required. - properties: - apiVersion: - description: API version of the referent. - type: string - fieldPath: - description: 'If referring to a piece of an object instead of - an entire object, this string should contain a valid JSON/Go - field access statement, such as desiredState.manifest.containers[2]. - For example, if the object reference is to a container within - a pod, this would take on a value like: "spec.containers{name}" - (where "name" refers to the name of the container that triggered - the event) or if no container name is specified "spec.containers[2]" - (container with index 2 in this pod). This syntax is chosen - only to have some well-defined way of referencing a part of - an object. TODO: this design is not final and this field is - subject to change in the future.' - type: string - kind: - description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' - type: string - namespace: - description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' - type: string - resourceVersion: - description: 'Specific resourceVersion to which this reference - is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' - type: string - uid: - description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' - type: string - type: object - x-kubernetes-map-type: atomic - required: - - deletionPolicy - - driver - - source - - volumeSnapshotRef - type: object - status: - description: status represents the current information of a snapshot. - properties: - creationTime: - description: creationTime is the timestamp when the point-in-time - snapshot is taken by the underlying storage system. In dynamic snapshot - creation case, this field will be filled in by the CSI snapshotter - sidecar with the "creation_time" value returned from CSI "CreateSnapshot" - gRPC call. For a pre-existing snapshot, this field will be filled - with the "creation_time" value returned from the CSI "ListSnapshots" - gRPC call if the driver supports it. If not specified, it indicates - the creation time is unknown. The format of this field is a Unix - nanoseconds time encoded as an int64. On Unix, the command `date - +%s%N` returns the current time in nanoseconds since 1970-01-01 - 00:00:00 UTC. - format: int64 - type: integer - error: - description: error is the last observed error during snapshot creation, - if any. Upon success after retry, this error field will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error - during snapshot creation if specified. NOTE: message may be - logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if a snapshot is ready to be used - to restore a volume. In dynamic snapshot creation case, this field - will be filled in by the CSI snapshotter sidecar with the "ready_to_use" - value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing - snapshot, this field will be filled with the "ready_to_use" value - returned from the CSI "ListSnapshots" gRPC call if the driver supports - it, otherwise, this field will be set to "True". If not specified, - it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - description: restoreSize represents the complete size of the snapshot - in bytes. In dynamic snapshot creation case, this field will be - filled in by the CSI snapshotter sidecar with the "size_bytes" value - returned from CSI "CreateSnapshot" gRPC call. For a pre-existing - snapshot, this field will be filled with the "size_bytes" value - returned from the CSI "ListSnapshots" gRPC call if the driver supports - it. When restoring a volume from this snapshot, the size of the - volume MUST NOT be smaller than the restoreSize if it is specified, - otherwise the restoration will fail. If not specified, it indicates - that the size is unknown. - format: int64 - minimum: 0 - type: integer - snapshotHandle: - description: snapshotHandle is the CSI "snapshot_id" of a snapshot - on the underlying storage system. If not specified, it indicates - that dynamic snapshot creation has either failed or it is still - in progress. + encryption: + description: 'Enabling the encryption feature allows for the creation of encrypted filesystems and volumes. ZFS will encrypt file and zvol data, file attributes, ACLs, permission bits, directory listings, FUID mappings, and userused / groupused data. ZFS will not encrypt metadata related to the pool structure, including dataset and snapshot names, dataset hierarchy, properties, file size, file holes, and deduplication tables (though the deduplicated data itself is encrypted). Default Value: off.' + pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ type: string - volumeGroupSnapshotContentName: - description: VolumeGroupSnapshotContentName is the name of the VolumeGroupSnapshotContent - of which this VolumeSnapshotContent is a part of. + fsType: + description: 'FsType specifies filesystem type for the zfs volume/dataset. If FsType is provided as "zfs", then the driver will create a ZFS dataset, formatting is not required as underlying filesystem is ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver will create a ZVOL and format the volume accordingly. FsType can not be modified once volume has been provisioned. Default Value: ext4.' type: string - type: object - required: - - spec - type: object - served: true - storage: true - subresources: - status: {} - - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: Represents the complete size of the snapshot in bytes - jsonPath: .status.restoreSize - name: RestoreSize - type: integer - - description: Determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. - jsonPath: .spec.deletionPolicy - name: DeletionPolicy - type: string - - description: Name of the CSI driver used to create the physical snapshot on the underlying storage system. - jsonPath: .spec.driver - name: Driver - type: string - - description: Name of the VolumeSnapshotClass to which this snapshot belongs. - jsonPath: .spec.volumeSnapshotClassName - name: VolumeSnapshotClass - type: string - - description: Name of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. - jsonPath: .spec.volumeSnapshotRef.name - name: VolumeSnapshot - type: string - - description: Namespace of the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. - jsonPath: .spec.volumeSnapshotRef.namespace - name: VolumeSnapshotNamespace - type: string - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta1 - # This indicates the v1beta1 version of the custom resource is deprecated. - # API requests to this version receive a warning in the server response. - deprecated: true - # This overrides the default warning returned to clients making v1beta1 API requests. - deprecationWarning: "snapshot.storage.k8s.io/v1beta1 VolumeSnapshotContent is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshotContent" - schema: - openAPIV3Schema: - description: VolumeSnapshotContent represents the actual "on-disk" snapshot object in the underlying storage system - 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 - spec: - description: spec defines properties of a VolumeSnapshotContent created by the underlying storage system. Required. - properties: - deletionPolicy: - description: deletionPolicy determines whether this VolumeSnapshotContent and its physical snapshot on the underlying storage system should be deleted when its bound VolumeSnapshot is deleted. Supported values are "Retain" and "Delete". "Retain" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are kept. "Delete" means that the VolumeSnapshotContent and its physical snapshot on underlying storage system are deleted. For dynamically provisioned snapshots, this field will automatically be filled in by the CSI snapshotter sidecar with the "DeletionPolicy" field defined in the corresponding VolumeSnapshotClass. For pre-existing snapshots, users MUST specify this field when creating the VolumeSnapshotContent object. Required. + keyformat: + description: KeyFormat specifies format of the encryption key The supported KeyFormats are passphrase, raw, hex. enum: - - Delete - - Retain + - passphrase + - raw + - hex type: string - driver: - description: driver is the name of the CSI driver used to create the physical snapshot on the underlying storage system. This MUST be the same as the name returned by the CSI GetPluginName() call for that driver. Required. + keylocation: + description: KeyLocation is the location of key for the encryption type: string - source: - description: source specifies whether the snapshot is (or should be) dynamically provisioned or already exists, and just requires a Kubernetes object representation. This field is immutable after creation. Required. - properties: - snapshotHandle: - description: snapshotHandle specifies the CSI "snapshot_id" of a pre-existing snapshot on the underlying storage system for which a Kubernetes object representation was (or should be) created. This field is immutable. - type: string - volumeHandle: - description: volumeHandle specifies the CSI "volume_id" of the volume from which a snapshot should be dynamically taken from. This field is immutable. - type: string - type: object - volumeSnapshotClassName: - description: name of the VolumeSnapshotClass from which this snapshot was (or will be) created. Note that after provisioning, the VolumeSnapshotClass may be deleted or recreated with different set of values, and as such, should not be referenced post-snapshot creation. + ownerNodeID: + description: OwnerNodeID is the Node ID where the ZPOOL is running which is where the volume has been provisioned. OwnerNodeID can not be edited after the volume has been provisioned. + minLength: 1 + type: string + poolName: + description: poolName specifies the name of the pool where the volume has been created. PoolName can not be edited after the volume has been provisioned. + minLength: 1 + type: string + recordsize: + description: 'Specifies a suggested block size for files in the file system. The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes. RecordSize property can be edited after the volume has been created. Changing the file system''s recordsize affects only files created afterward; existing files are unaffected. Default Value: 128k.' + minLength: 1 + type: string + snapname: + description: SnapName specifies the name of the snapshot where the volume has been cloned from. Snapname can not be edited after the volume has been provisioned. + type: string + thinProvision: + description: 'ThinProvision describes whether space reservation for the source volume is required or not. The value "yes" indicates that volume should be thin provisioned and "no" means thick provisioning of the volume. If thinProvision is set to "yes" then volume can be provisioned even if the ZPOOL does not have the enough capacity. If thinProvision is set to "no" then volume can be provisioned only if the ZPOOL has enough capacity and capacity required by volume can be reserved. ThinProvision can not be modified once volume has been provisioned. Default Value: no.' + enum: + - "yes" + - "no" + type: string + volblocksize: + description: 'VolBlockSize specifies the block size for the zvol. The volsize can only be set to a multiple of volblocksize, and cannot be zero. VolBlockSize can not be edited after the volume has been provisioned. Default Value: 8k.' + minLength: 1 + type: string + volumeType: + description: volumeType determines whether the volume is of type "DATASET" or "ZVOL". If fstype provided in the storageclass is "zfs", a volume of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype in the storageclass, then a volume of type zvol will be created, which will be further formatted as the fstype provided in the storageclass. VolumeType can not be modified once volume has been provisioned. + enum: + - ZVOL + - DATASET type: string - volumeSnapshotRef: - description: volumeSnapshotRef specifies the VolumeSnapshot object to which this VolumeSnapshotContent object is bound. VolumeSnapshot.Spec.VolumeSnapshotContentName field must reference to this VolumeSnapshotContent's name for the bidirectional binding to be valid. For a pre-existing VolumeSnapshotContent object, name and namespace of the VolumeSnapshot object MUST be provided for binding to happen. This field is immutable after creation. Required. - properties: - apiVersion: - description: API version of the referent. - type: string - fieldPath: - description: 'If referring to a piece of an object instead of an entire object, this string should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2]. For example, if the object reference is to a container within a pod, this would take on a value like: "spec.containers{name}" (where "name" refers to the name of the container that triggered the event) or if no container name is specified "spec.containers[2]" (container with index 2 in this pod). This syntax is chosen only to have some well-defined way of referencing a part of an object. TODO: this design is not final and this field is subject to change in the future.' - type: string - kind: - description: 'Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - name: - description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names' - type: string - namespace: - description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/' - type: string - resourceVersion: - description: 'Specific resourceVersion to which this reference is made, if any. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency' - type: string - uid: - description: 'UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids' - type: string - type: object required: - - deletionPolicy - - driver - - source - - volumeSnapshotRef + - capacity + - ownerNodeID + - poolName + - volumeType type: object status: - description: status represents the current information of a snapshot. + description: SnapStatus string that reflects if the snapshot was created successfully properties: - creationTime: - description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it indicates the creation time is unknown. The format of this field is a Unix nanoseconds time encoded as an int64. On Unix, the command `date +%s%N` returns the current time in nanoseconds since 1970-01-01 00:00:00 UTC. - format: int64 - type: integer - error: - description: error is the last observed error during snapshot creation, if any. Upon success after retry, this error field will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if a snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - description: restoreSize represents the complete size of the snapshot in bytes. In dynamic snapshot creation case, this field will be filled in by the CSI snapshotter sidecar with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. - format: int64 - minimum: 0 - type: integer - snapshotHandle: - description: snapshotHandle is the CSI "snapshot_id" of a snapshot on the underlying storage system. If not specified, it indicates that dynamic snapshot creation has either failed or it is still in progress. + state: type: string type: object required: - spec + - status type: object - served: false + served: true storage: false - subresources: - status: {} status: acceptedNames: kind: "" @@ -1849,198 +1300,152 @@ status: conditions: [] storedVersions: [] --- +# Source: zfs-localpv/charts/crds/templates/zfsvolume.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.11.3 - api-approved.kubernetes.io: "https://github.com/kubernetes-csi/external-snapshotter/pull/814" + controller-gen.kubebuilder.io/version: v0.4.0 + helm.sh/resource-policy: keep + creationTimestamp: null - name: volumesnapshots.snapshot.storage.k8s.io + name: zfsvolumes.zfs.openebs.io spec: - group: snapshot.storage.k8s.io + group: zfs.openebs.io names: - kind: VolumeSnapshot - listKind: VolumeSnapshotList - plural: volumesnapshots + kind: ZFSVolume + listKind: ZFSVolumeList + plural: zfsvolumes shortNames: - - vs - singular: volumesnapshot + - zfsvol + - zv + singular: zfsvolume scope: Namespaced versions: - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: If a new snapshot needs to be created, this contains the name of - the source PVC from which this snapshot was (or will be) created. - jsonPath: .spec.source.persistentVolumeClaimName - name: SourcePVC + - description: ZFS Pool where the volume is created + jsonPath: .spec.poolName + name: ZPool type: string - - description: If a snapshot already exists, this contains the name of the existing - VolumeSnapshotContent object representing the existing snapshot. - jsonPath: .spec.source.volumeSnapshotContentName - name: SourceSnapshotContent + - description: Node where the volume is created + jsonPath: .spec.ownerNodeID + name: NodeID type: string - - description: Represents the minimum size of volume required to rehydrate from - this snapshot. - jsonPath: .status.restoreSize - name: RestoreSize + - description: Size of the volume + jsonPath: .spec.capacity + name: Size type: string - - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. - jsonPath: .spec.volumeSnapshotClassName - name: SnapshotClass + - description: Status of the volume + jsonPath: .status.state + name: Status type: string - - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot - object intends to bind to. Please note that verification of binding actually - requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure - both are pointing at each other. Binding MUST be verified prior to usage of - this object. - jsonPath: .status.boundVolumeSnapshotContentName - name: SnapshotContent + - description: filesystem created on the volume + jsonPath: .spec.fsType + name: Filesystem type: string - - description: Timestamp when the point-in-time snapshot was taken by the underlying - storage system. - jsonPath: .status.creationTime - name: CreationTime - type: date - - jsonPath: .metadata.creationTimestamp + - description: Age of the volume + jsonPath: .metadata.creationTimestamp name: Age type: date name: v1 schema: openAPIV3Schema: - description: VolumeSnapshot is a user's request for either creating a point-in-time - snapshot of a persistent volume, or binding to a pre-existing snapshot. + description: ZFSVolume represents a ZFS based 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' + 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' + 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: 'spec defines the desired characteristics of a snapshot requested - by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots - Required.' + description: VolumeInfo defines ZFS volume parameters for all modes in which ZFS volumes can be created like - ZFS volume with filesystem, ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. Some of the parameters can be only set during creation time (as specified in the details of the parameter), and a few are editable. In case of Cloned volumes, the parameters are assigned the same values as the source volume. properties: - source: - description: source specifies where a snapshot will be created from. - This field is immutable after creation. Required. - properties: - persistentVolumeClaimName: - description: persistentVolumeClaimName specifies the name of the - PersistentVolumeClaim object representing the volume from which - a snapshot should be created. This PVC is assumed to be in the - same namespace as the VolumeSnapshot object. This field should - be set if the snapshot does not exists, and needs to be created. - This field is immutable. - type: string - volumeSnapshotContentName: - description: volumeSnapshotContentName specifies the name of a - pre-existing VolumeSnapshotContent object representing an existing - volume snapshot. This field should be set if the snapshot already - exists and only needs a representation in Kubernetes. This field - is immutable. - type: string - type: object - oneOf: - - required: ["persistentVolumeClaimName"] - - required: ["volumeSnapshotContentName"] - volumeSnapshotClassName: - description: 'VolumeSnapshotClassName is the name of the VolumeSnapshotClass - requested by the VolumeSnapshot. VolumeSnapshotClassName may be - left nil to indicate that the default SnapshotClass should be used. - A given cluster may have multiple default Volume SnapshotClasses: - one default per CSI Driver. If a VolumeSnapshot does not specify - a SnapshotClass, VolumeSnapshotSource will be checked to figure - out what the associated CSI Driver is, and the default VolumeSnapshotClass - associated with that CSI Driver will be used. If more than one VolumeSnapshotClass - exist for a given CSI Driver and more than one have been marked - as default, CreateSnapshot will fail and generate an event. Empty - string is not allowed for this field.' + capacity: + description: Capacity of the volume + minLength: 1 + type: string + compression: + description: 'Compression specifies the block-level compression algorithm to be applied to the ZFS Volume. The value "on" indicates ZFS to use the default compression algorithm. The default compression algorithm used by ZFS will be either lzjb or, if the lz4_compress feature is enabled, lz4. Compression property can be edited after the volume has been created. The change will only be applied to the newly-written data. For instance, if the Volume was created with "off" and the next day the compression was modified to "on", the data written prior to setting "on" will not be compressed. Default Value: off.' + pattern: ^(on|off|lzjb|zstd|zstd-[1-9]|zstd-1[0-9]|gzip|gzip-[1-9]|zle|lz4)$ + type: string + dedup: + description: 'Deduplication is the process for removing redundant data at the block level, reducing the total amount of data stored. If a file system has the dedup property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files. Deduplication can consume significant processing power (CPU) and memory as well as generate additional disk IO. Before creating a pool with deduplication enabled, ensure that you have planned your hardware requirements appropriately and implemented appropriate recovery practices, such as regular backups. As an alternative to deduplication consider using compression=lz4, as a less resource-intensive alternative. should be enabled on the zvol. Dedup property can be edited after the volume has been created. Default Value: off.' + enum: + - "on" + - "off" + type: string + encryption: + description: 'Enabling the encryption feature allows for the creation of encrypted filesystems and volumes. ZFS will encrypt file and zvol data, file attributes, ACLs, permission bits, directory listings, FUID mappings, and userused / groupused data. ZFS will not encrypt metadata related to the pool structure, including dataset and snapshot names, dataset hierarchy, properties, file size, file holes, and deduplication tables (though the deduplicated data itself is encrypted). Default Value: off.' + pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ + type: string + fsType: + description: 'FsType specifies filesystem type for the zfs volume/dataset. If FsType is provided as "zfs", then the driver will create a ZFS dataset, formatting is not required as underlying filesystem is ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver will create a ZVOL and format the volume accordingly. FsType can not be modified once volume has been provisioned. Default Value: ext4.' + type: string + keyformat: + description: KeyFormat specifies format of the encryption key The supported KeyFormats are passphrase, raw, hex. + enum: + - passphrase + - raw + - hex + type: string + keylocation: + description: KeyLocation is the location of key for the encryption + type: string + ownerNodeID: + description: OwnerNodeID is the Node ID where the ZPOOL is running which is where the volume has been provisioned. OwnerNodeID can not be edited after the volume has been provisioned. + minLength: 1 + type: string + poolName: + description: poolName specifies the name of the pool where the volume has been created. PoolName can not be edited after the volume has been provisioned. + minLength: 1 + type: string + recordsize: + description: 'Specifies a suggested block size for files in the file system. The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes. RecordSize property can be edited after the volume has been created. Changing the file system''s recordsize affects only files created afterward; existing files are unaffected. Default Value: 128k.' + minLength: 1 + type: string + shared: + description: Shared specifies whether the volume can be shared among multiple pods. If it is not set to "yes", then the ZFS-LocalPV Driver will not allow the volumes to be mounted by more than one pods. + enum: + - "yes" + - "no" + type: string + snapname: + description: SnapName specifies the name of the snapshot where the volume has been cloned from. Snapname can not be edited after the volume has been provisioned. + type: string + thinProvision: + description: 'ThinProvision describes whether space reservation for the source volume is required or not. The value "yes" indicates that volume should be thin provisioned and "no" means thick provisioning of the volume. If thinProvision is set to "yes" then volume can be provisioned even if the ZPOOL does not have the enough capacity. If thinProvision is set to "no" then volume can be provisioned only if the ZPOOL has enough capacity and capacity required by volume can be reserved. ThinProvision can not be modified once volume has been provisioned. Default Value: no.' + enum: + - "yes" + - "no" + type: string + volblocksize: + description: 'VolBlockSize specifies the block size for the zvol. The volsize can only be set to a multiple of volblocksize, and cannot be zero. VolBlockSize can not be edited after the volume has been provisioned. Default Value: 8k.' + minLength: 1 + type: string + volumeType: + description: volumeType determines whether the volume is of type "DATASET" or "ZVOL". If fstype provided in the storageclass is "zfs", a volume of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype in the storageclass, then a volume of type zvol will be created, which will be further formatted as the fstype provided in the storageclass. VolumeType can not be modified once volume has been provisioned. + enum: + - ZVOL + - DATASET type: string required: - - source + - capacity + - ownerNodeID + - poolName + - volumeType type: object status: - description: status represents the current information of a snapshot. - Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent - objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent - point at each other) before using this object. + description: VolStatus string that specifies the current state of the volume provisioning request. properties: - boundVolumeSnapshotContentName: - description: 'boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent - object to which this VolumeSnapshot object intends to bind to. If - not specified, it indicates that the VolumeSnapshot object has not - been successfully bound to a VolumeSnapshotContent object yet. NOTE: - To avoid possible security issues, consumers must verify binding - between VolumeSnapshot and VolumeSnapshotContent objects is successful - (by validating that both VolumeSnapshot and VolumeSnapshotContent - point at each other) before using this object.' - type: string - creationTime: - description: creationTime is the timestamp when the point-in-time - snapshot is taken by the underlying storage system. In dynamic snapshot - creation case, this field will be filled in by the snapshot controller - with the "creation_time" value returned from CSI "CreateSnapshot" - gRPC call. For a pre-existing snapshot, this field will be filled - with the "creation_time" value returned from the CSI "ListSnapshots" - gRPC call if the driver supports it. If not specified, it may indicate - that the creation time of the snapshot is unknown. - format: date-time - type: string - error: - description: error is the last observed error during snapshot creation, - if any. This field could be helpful to upper level controllers(i.e., - application controller) to decide whether they should continue on - waiting for the snapshot to be created based on the type of error - reported. The snapshot controller will keep retrying when an error - occurs during the snapshot creation. Upon success, this error field - will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error - during snapshot creation if specified. NOTE: message may be - logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if the snapshot is ready to be used - to restore a volume. In dynamic snapshot creation case, this field - will be filled in by the snapshot controller with the "ready_to_use" - value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing - snapshot, this field will be filled with the "ready_to_use" value - returned from the CSI "ListSnapshots" gRPC call if the driver supports - it, otherwise, this field will be set to "True". If not specified, - it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: - type: string - description: restoreSize represents the minimum size of volume required - to create a volume from this snapshot. In dynamic snapshot creation - case, this field will be filled in by the snapshot controller with - the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. - For a pre-existing snapshot, this field will be filled with the - "size_bytes" value returned from the CSI "ListSnapshots" gRPC call - if the driver supports it. When restoring a volume from this snapshot, - the size of the volume MUST NOT be smaller than the restoreSize - if it is specified, otherwise the restoration will fail. If not - specified, it indicates that the size is unknown. - pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ - x-kubernetes-int-or-string: true - volumeGroupSnapshotName: - description: VolumeGroupSnapshotName is the name of the VolumeGroupSnapshot - of which this VolumeSnapshot is a part of. + state: + description: State specifies the current state of the volume provisioning request. The state "Pending" means that the volume creation request has not processed yet. The state "Ready" means that the volume has been created and it is ready for the use. + enum: + - Pending + - Ready + - Failed type: string type: object required: @@ -2048,49 +1453,36 @@ spec: type: object served: true storage: true - subresources: - status: {} + subresources: {} - additionalPrinterColumns: - - description: Indicates if the snapshot is ready to be used to restore a volume. - jsonPath: .status.readyToUse - name: ReadyToUse - type: boolean - - description: If a new snapshot needs to be created, this contains the name of the source PVC from which this snapshot was (or will be) created. - jsonPath: .spec.source.persistentVolumeClaimName - name: SourcePVC + - description: ZFS Pool where the volume is created + jsonPath: .spec.poolName + name: ZPool type: string - - description: If a snapshot already exists, this contains the name of the existing VolumeSnapshotContent object representing the existing snapshot. - jsonPath: .spec.source.volumeSnapshotContentName - name: SourceSnapshotContent + - description: Node where the volume is created + jsonPath: .spec.ownerNodeID + name: Node type: string - - description: Represents the minimum size of volume required to rehydrate from this snapshot. - jsonPath: .status.restoreSize - name: RestoreSize + - description: Size of the volume + jsonPath: .spec.capacity + name: Size type: string - - description: The name of the VolumeSnapshotClass requested by the VolumeSnapshot. - jsonPath: .spec.volumeSnapshotClassName - name: SnapshotClass + - description: Status of the volume + jsonPath: .status.state + name: Status type: string - - description: Name of the VolumeSnapshotContent object to which the VolumeSnapshot object intends to bind to. Please note that verification of binding actually requires checking both VolumeSnapshot and VolumeSnapshotContent to ensure both are pointing at each other. Binding MUST be verified prior to usage of this object. - jsonPath: .status.boundVolumeSnapshotContentName - name: SnapshotContent + - description: filesystem created on the volume + jsonPath: .spec.fsType + name: Filesystem type: string - - description: Timestamp when the point-in-time snapshot was taken by the underlying storage system. - jsonPath: .status.creationTime - name: CreationTime - type: date - - jsonPath: .metadata.creationTimestamp + - description: Age of the volume + jsonPath: .metadata.creationTimestamp name: Age - type: date - name: v1beta1 - # This indicates the v1beta1 version of the custom resource is deprecated. - # API requests to this version receive a warning in the server response. - deprecated: true - # This overrides the default warning returned to clients making v1beta1 API requests. - deprecationWarning: "snapshot.storage.k8s.io/v1beta1 VolumeSnapshot is deprecated; use snapshot.storage.k8s.io/v1 VolumeSnapshot" + type: date + name: v1alpha1 schema: openAPIV3Schema: - description: VolumeSnapshot is a user's request for either creating a point-in-time snapshot of a persistent volume, or binding to a pre-existing snapshot. + description: ZFSVolume represents a ZFS based 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' @@ -2098,62 +1490,95 @@ spec: 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: 'spec defines the desired characteristics of a snapshot requested by a user. More info: https://kubernetes.io/docs/concepts/storage/volume-snapshots#volumesnapshots Required.' + description: VolumeInfo defines ZFS volume parameters for all modes in which ZFS volumes can be created like - ZFS volume with filesystem, ZFS Volume exposed as zfs or ZFS volume exposed as raw block device. Some of the parameters can be only set during creation time (as specified in the details of the parameter), and a few are editable. In case of Cloned volumes, the parameters are assigned the same values as the source volume. properties: - source: - description: source specifies where a snapshot will be created from. This field is immutable after creation. Required. - properties: - persistentVolumeClaimName: - description: persistentVolumeClaimName specifies the name of the PersistentVolumeClaim object representing the volume from which a snapshot should be created. This PVC is assumed to be in the same namespace as the VolumeSnapshot object. This field should be set if the snapshot does not exists, and needs to be created. This field is immutable. - type: string - volumeSnapshotContentName: - description: volumeSnapshotContentName specifies the name of a pre-existing VolumeSnapshotContent object representing an existing volume snapshot. This field should be set if the snapshot already exists and only needs a representation in Kubernetes. This field is immutable. - type: string - type: object - volumeSnapshotClassName: - description: 'VolumeSnapshotClassName is the name of the VolumeSnapshotClass requested by the VolumeSnapshot. VolumeSnapshotClassName may be left nil to indicate that the default SnapshotClass should be used. A given cluster may have multiple default Volume SnapshotClasses: one default per CSI Driver. If a VolumeSnapshot does not specify a SnapshotClass, VolumeSnapshotSource will be checked to figure out what the associated CSI Driver is, and the default VolumeSnapshotClass associated with that CSI Driver will be used. If more than one VolumeSnapshotClass exist for a given CSI Driver and more than one have been marked as default, CreateSnapshot will fail and generate an event. Empty string is not allowed for this field.' + capacity: + description: Capacity of the volume + minLength: 1 + type: string + compression: + description: 'Compression specifies the block-level compression algorithm to be applied to the ZFS Volume. The value "on" indicates ZFS to use the default compression algorithm. The default compression algorithm used by ZFS will be either lzjb or, if the lz4_compress feature is enabled, lz4. Compression property can be edited after the volume has been created. The change will only be applied to the newly-written data. For instance, if the Volume was created with "off" and the next day the compression was modified to "on", the data written prior to setting "on" will not be compressed. Default Value: off.' + pattern: ^(on|off|lzjb|gzip|gzip-[1-9]|zle|lz4)$ + type: string + dedup: + description: 'Deduplication is the process for removing redundant data at the block level, reducing the total amount of data stored. If a file system has the dedup property enabled, duplicate data blocks are removed synchronously. The result is that only unique data is stored and common components are shared among files. Deduplication can consume significant processing power (CPU) and memory as well as generate additional disk IO. Before creating a pool with deduplication enabled, ensure that you have planned your hardware requirements appropriately and implemented appropriate recovery practices, such as regular backups. As an alternative to deduplication consider using compression=lz4, as a less resource-intensive alternative. should be enabled on the zvol. Dedup property can be edited after the volume has been created. Default Value: off.' + enum: + - "on" + - "off" + type: string + encryption: + description: 'Enabling the encryption feature allows for the creation of encrypted filesystems and volumes. ZFS will encrypt file and zvol data, file attributes, ACLs, permission bits, directory listings, FUID mappings, and userused / groupused data. ZFS will not encrypt metadata related to the pool structure, including dataset and snapshot names, dataset hierarchy, properties, file size, file holes, and deduplication tables (though the deduplicated data itself is encrypted). Default Value: off.' + pattern: ^(on|off|aes-128-[c,g]cm|aes-192-[c,g]cm|aes-256-[c,g]cm)$ + type: string + fsType: + description: 'FsType specifies filesystem type for the zfs volume/dataset. If FsType is provided as "zfs", then the driver will create a ZFS dataset, formatting is not required as underlying filesystem is ZFS anyway. If FsType is ext2, ext3, ext4 or xfs, then the driver will create a ZVOL and format the volume accordingly. FsType can not be modified once volume has been provisioned. Default Value: ext4.' + type: string + keyformat: + description: KeyFormat specifies format of the encryption key The supported KeyFormats are passphrase, raw, hex. + enum: + - passphrase + - raw + - hex + type: string + keylocation: + description: KeyLocation is the location of key for the encryption + type: string + ownerNodeID: + description: OwnerNodeID is the Node ID where the ZPOOL is running which is where the volume has been provisioned. OwnerNodeID can not be edited after the volume has been provisioned. + minLength: 1 + type: string + poolName: + description: poolName specifies the name of the pool where the volume has been created. PoolName can not be edited after the volume has been provisioned. + minLength: 1 + type: string + recordsize: + description: 'Specifies a suggested block size for files in the file system. The size specified must be a power of two greater than or equal to 512 and less than or equal to 128 Kbytes. RecordSize property can be edited after the volume has been created. Changing the file system''s recordsize affects only files created afterward; existing files are unaffected. Default Value: 128k.' + minLength: 1 + type: string + snapname: + description: SnapName specifies the name of the snapshot where the volume has been cloned from. Snapname can not be edited after the volume has been provisioned. + type: string + thinProvision: + description: 'ThinProvision describes whether space reservation for the source volume is required or not. The value "yes" indicates that volume should be thin provisioned and "no" means thick provisioning of the volume. If thinProvision is set to "yes" then volume can be provisioned even if the ZPOOL does not have the enough capacity. If thinProvision is set to "no" then volume can be provisioned only if the ZPOOL has enough capacity and capacity required by volume can be reserved. ThinProvision can not be modified once volume has been provisioned. Default Value: no.' + enum: + - "yes" + - "no" + type: string + volblocksize: + description: 'VolBlockSize specifies the block size for the zvol. The volsize can only be set to a multiple of volblocksize, and cannot be zero. VolBlockSize can not be edited after the volume has been provisioned. Default Value: 8k.' + minLength: 1 + type: string + volumeType: + description: volumeType determines whether the volume is of type "DATASET" or "ZVOL". If fstype provided in the storageclass is "zfs", a volume of type dataset will be created. If "ext4", "ext3", "ext2" or "xfs" is mentioned as fstype in the storageclass, then a volume of type zvol will be created, which will be further formatted as the fstype provided in the storageclass. VolumeType can not be modified once volume has been provisioned. + enum: + - ZVOL + - DATASET type: string required: - - source + - capacity + - ownerNodeID + - poolName + - volumeType type: object status: - description: status represents the current information of a snapshot. Consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object. + description: VolStatus string that specifies the current state of the volume provisioning request. properties: - boundVolumeSnapshotContentName: - description: 'boundVolumeSnapshotContentName is the name of the VolumeSnapshotContent object to which this VolumeSnapshot object intends to bind to. If not specified, it indicates that the VolumeSnapshot object has not been successfully bound to a VolumeSnapshotContent object yet. NOTE: To avoid possible security issues, consumers must verify binding between VolumeSnapshot and VolumeSnapshotContent objects is successful (by validating that both VolumeSnapshot and VolumeSnapshotContent point at each other) before using this object.' - type: string - creationTime: - description: creationTime is the timestamp when the point-in-time snapshot is taken by the underlying storage system. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "creation_time" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "creation_time" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. If not specified, it may indicate that the creation time of the snapshot is unknown. - format: date-time - type: string - error: - description: error is the last observed error during snapshot creation, if any. This field could be helpful to upper level controllers(i.e., application controller) to decide whether they should continue on waiting for the snapshot to be created based on the type of error reported. The snapshot controller will keep retrying when an error occurs during the snapshot creation. Upon success, this error field will be cleared. - properties: - message: - description: 'message is a string detailing the encountered error during snapshot creation if specified. NOTE: message may be logged, and it should not contain sensitive information.' - type: string - time: - description: time is the timestamp when the error was encountered. - format: date-time - type: string - type: object - readyToUse: - description: readyToUse indicates if the snapshot is ready to be used to restore a volume. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "ready_to_use" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "ready_to_use" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it, otherwise, this field will be set to "True". If not specified, it means the readiness of a snapshot is unknown. - type: boolean - restoreSize: + state: + description: State specifies the current state of the volume provisioning request. The state "Pending" means that the volume creation request has not processed yet. The state "Ready" means that the volume has been created and it is ready for the use. + enum: + - Pending + - Ready type: string - description: restoreSize represents the minimum size of volume required to create a volume from this snapshot. In dynamic snapshot creation case, this field will be filled in by the snapshot controller with the "size_bytes" value returned from CSI "CreateSnapshot" gRPC call. For a pre-existing snapshot, this field will be filled with the "size_bytes" value returned from the CSI "ListSnapshots" gRPC call if the driver supports it. When restoring a volume from this snapshot, the size of the volume MUST NOT be smaller than the restoreSize if it is specified, otherwise the restoration will fail. If not specified, it indicates that the size is unknown. - 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 required: - spec type: object - served: false + served: true storage: false - subresources: - status: {} + subresources: {} status: acceptedNames: kind: "" @@ -2161,351 +1586,221 @@ status: conditions: [] storedVersions: [] --- -############################################## -########### ############ -########### Controller plugin ############ -########### ############ -############################################## - -kind: ServiceAccount -apiVersion: v1 +# Source: zfs-localpv/templates/rbac.yaml +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1 metadata: - name: openebs-zfs-controller-sa - namespace: kube-system - + name: openebs-zfs-provisioner-role + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" +rules: +- apiGroups: [""] + resources: ["secrets"] + verbs: ["get", "list"] +- apiGroups: [""] + resources: ["namespaces"] + verbs: ["*"] +- apiGroups: [""] + resources: ["persistentvolumes", "services"] + verbs: ["get", "list", "watch", "create", "delete", "update", "patch"] +- apiGroups: [""] + resources: ["persistentvolumeclaims"] + verbs: ["get", "list", "watch", "update"] +- apiGroups: [""] + resources: ["persistentvolumeclaims/status"] + verbs: ["update", "patch"] +- apiGroups: ["storage.k8s.io"] + resources: ["storageclasses", "csinodes"] + verbs: ["get", "list", "watch"] +- apiGroups: ["storage.k8s.io"] + resources: ["csistoragecapacities"] + verbs: ["*"] +- apiGroups: [""] + resources: ["events"] + verbs: ["list", "watch", "create", "update", "patch"] +- apiGroups: ["coordination.k8s.io"] + resources: ["leases"] + verbs: ["get", "watch", "list", "delete", "update", "create"] +- apiGroups: [""] + resources: ["nodes"] + verbs: ["get", "list", "watch"] +- apiGroups: [""] + resources: ["pods"] + verbs: ["get", "list", "watch", "update", "patch"] +- apiGroups: [""] + resources: ["pods"] + verbs: ["get", "list", "watch", "update", "patch"] +- apiGroups: ["*"] + resources: ["zfsvolumes", "zfssnapshots", "zfsbackups", "zfsrestores", "zfsnodes"] + verbs: ["*"] --- +# Source: zfs-localpv/templates/rbac.yaml kind: ClusterRole apiVersion: rbac.authorization.k8s.io/v1 metadata: - name: openebs-zfs-provisioner-role + name: openebs-zfs-snapshotter-role + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" rules: - - apiGroups: [""] - resources: ["secrets"] - verbs: ["get", "list"] - - apiGroups: [""] - resources: ["namespaces"] - verbs: ["*"] - - apiGroups: [""] - resources: ["persistentvolumes", "services"] - verbs: ["get", "list", "watch", "create", "delete", "update", "patch"] - - apiGroups: [""] - resources: ["persistentvolumeclaims"] - verbs: ["get", "list", "watch", "update"] - - apiGroups: [""] - resources: ["persistentvolumeclaims/status"] - verbs: ["update", "patch"] - - apiGroups: ["storage.k8s.io"] - resources: ["storageclasses", "csinodes"] - verbs: ["get", "list", "watch"] - - apiGroups: [ "storage.k8s.io" ] - resources: [ "csistoragecapacities"] - verbs: ["*"] - - apiGroups: [""] - resources: ["events"] - verbs: ["list", "watch", "create", "update", "patch"] - - apiGroups: ["coordination.k8s.io"] - resources: ["leases"] - verbs: ["get", "watch", "list", "delete", "update", "create"] - - apiGroups: [""] - resources: ["nodes"] - verbs: ["get", "list", "watch"] - - apiGroups: [""] - resources: ["pods"] - verbs: ["get", "list", "watch", "update", "patch"] - - apiGroups: ["*"] - resources: ["zfsvolumes", "zfssnapshots", "zfsbackups", "zfsrestores", "zfsnodes"] - verbs: ["*"] +- apiGroups: [""] + resources: ["persistentvolumes"] + verbs: ["get", "list", "watch"] +- apiGroups: [""] + resources: ["persistentvolumeclaims"] + verbs: ["get", "list", "watch"] +- apiGroups: ["storage.k8s.io"] + resources: ["storageclasses"] + verbs: ["get", "list", "watch"] +- apiGroups: [""] + resources: ["events"] + verbs: ["list", "watch", "create", "update", "patch"] +- apiGroups: [""] + resources: ["secrets"] + verbs: ["get", "list"] +- apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshotclasses"] + verbs: ["get", "list", "watch"] +- apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshotcontents"] + verbs: ["create", "get", "list", "watch", "update", "delete", "patch"] +- apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshots"] + verbs: ["get", "list", "watch", "update", "patch"] +- apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshotcontents/status"] + verbs: ["update"] +- apiGroups: ["snapshot.storage.k8s.io"] + resources: ["volumesnapshots/status"] + verbs: ["update"] +- apiGroups: ["apiextensions.k8s.io"] + resources: ["customresourcedefinitions"] + verbs: ["create", "list", "watch", "delete"] --- - +# Source: zfs-localpv/templates/rbac.yaml +kind: ClusterRole +apiVersion: rbac.authorization.k8s.io/v1 +metadata: + name: openebs-zfs-driver-registrar-role + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + name: "openebs-zfs-node" + release: openebs + openebs.io/component-name: "openebs-zfs-node" +rules: +- apiGroups: [""] + resources: ["events"] + verbs: ["get", "list", "watch", "create", "update", "patch"] +- apiGroups: [""] + resources: ["persistentvolumes", "nodes", "services"] + verbs: ["get", "list"] +- apiGroups: ["*"] + resources: ["zfsvolumes", "zfssnapshots", "zfsbackups", "zfsrestores", "zfsnodes"] + verbs: ["get", "list", "watch", "create", "update", "patch"] +--- +# Source: zfs-localpv/templates/rbac.yaml kind: ClusterRoleBinding apiVersion: rbac.authorization.k8s.io/v1 metadata: name: openebs-zfs-provisioner-binding + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" subjects: - - kind: ServiceAccount - name: openebs-zfs-controller-sa - namespace: kube-system +- kind: ServiceAccount + name: openebs-zfs-controller-sa + namespace: openebs roleRef: kind: ClusterRole name: openebs-zfs-provisioner-role apiGroup: rbac.authorization.k8s.io - ---- - -apiVersion: scheduling.k8s.io/v1 -kind: PriorityClass -metadata: - name: openebs-zfs-csi-controller-critical -# A PriorityClass object can have any 32-bit integer value smaller than or equal -# to 1 billion. Larger numbers are reserved for critical system Pods that should -# not normally be preempted or evicted. The higher the value, the higher the priority. -value: 900000000 -globalDefault: false -description: "This priority class should be used for the OpenEBS ZFS localPV CSI driver controller deployment only." - ---- - -kind: Deployment -apiVersion: apps/v1 -metadata: - name: openebs-zfs-controller - namespace: kube-system - labels: - openebs.io/component-name: openebs-zfs-controller - openebs.io/version: ci -spec: - selector: - matchLabels: - app: openebs-zfs-controller - role: openebs-zfs - replicas: 1 - template: - metadata: - labels: - app: openebs-zfs-controller - role: openebs-zfs - openebs.io/component-name: openebs-zfs-controller - openebs.io/version: ci - spec: - affinity: - podAntiAffinity: - requiredDuringSchedulingIgnoredDuringExecution: - - labelSelector: - matchExpressions: - - key: app - operator: In - values: - - openebs-zfs-controller - topologyKey: "kubernetes.io/hostname" - priorityClassName: openebs-zfs-csi-controller-critical - serviceAccountName: openebs-zfs-controller-sa - containers: - - name: csi-resizer - image: registry.k8s.io/sig-storage/csi-resizer:v1.8.0 - args: - - "--v=5" - - "--csi-address=$(ADDRESS)" - - "--leader-election" - env: - - name: ADDRESS - value: /var/lib/csi/sockets/pluginproxy/csi.sock - imagePullPolicy: IfNotPresent - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - - name: csi-snapshotter - image: registry.k8s.io/sig-storage/csi-snapshotter:v6.2.2 - imagePullPolicy: IfNotPresent - args: - - "--csi-address=$(ADDRESS)" - - "--leader-election" - env: - - name: ADDRESS - value: /var/lib/csi/sockets/pluginproxy/csi.sock - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - - name: snapshot-controller - image: registry.k8s.io/sig-storage/snapshot-controller:v6.2.2 - args: - - "--v=5" - - "--leader-election=true" - imagePullPolicy: IfNotPresent - - name: csi-provisioner - image: registry.k8s.io/sig-storage/csi-provisioner:v3.5.0 - imagePullPolicy: IfNotPresent - args: - - "--csi-address=$(ADDRESS)" - - "--v=5" - - "--feature-gates=Topology=true" - - "--strict-topology" - - "--leader-election" - - "--extra-create-metadata=true" - - "--enable-capacity=true" - - "--default-fstype=ext4" - env: - - name: ADDRESS - value: /var/lib/csi/sockets/pluginproxy/csi.sock - - name: NAMESPACE - valueFrom: - fieldRef: - fieldPath: metadata.namespace - - name: POD_NAME - valueFrom: - fieldRef: - fieldPath: metadata.name - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - - name: openebs-zfs-plugin - image: openebs/zfs-driver:ci - imagePullPolicy: IfNotPresent - env: - - name: OPENEBS_CONTROLLER_DRIVER - value: controller - - name: OPENEBS_CSI_ENDPOINT - value: unix:///var/lib/csi/sockets/pluginproxy/csi.sock - - name: OPENEBS_NAMESPACE - value: openebs - - name: OPENEBS_IO_INSTALLER_TYPE - value: "zfs-operator" - - name: OPENEBS_IO_ENABLE_ANALYTICS - value: "true" - args : - - "--endpoint=$(OPENEBS_CSI_ENDPOINT)" - - "--plugin=$(OPENEBS_CONTROLLER_DRIVER)" - volumeMounts: - - name: socket-dir - mountPath: /var/lib/csi/sockets/pluginproxy/ - volumes: - - name: socket-dir - emptyDir: {} ---- - -kind: ClusterRole -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-snapshotter-role -rules: - - apiGroups: [""] - resources: ["persistentvolumes"] - verbs: ["get", "list", "watch"] - - apiGroups: [""] - resources: ["persistentvolumeclaims"] - verbs: ["get", "list", "watch"] - - apiGroups: ["storage.k8s.io"] - resources: ["storageclasses"] - verbs: ["get", "list", "watch"] - - apiGroups: [""] - resources: ["events"] - verbs: ["list", "watch", "create", "update", "patch"] - - apiGroups: [""] - resources: ["secrets"] - verbs: ["get", "list"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshotclasses"] - verbs: ["get", "list", "watch"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshotcontents"] - verbs: ["create", "get", "list", "watch", "update", "delete", "patch"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshots"] - verbs: ["get", "list", "watch", "update", "patch"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshotcontents/status"] - verbs: ["update"] - - apiGroups: ["snapshot.storage.k8s.io"] - resources: ["volumesnapshots/status"] - verbs: ["update"] - - apiGroups: ["apiextensions.k8s.io"] - resources: ["customresourcedefinitions"] - verbs: ["create", "list", "watch", "delete"] - --- +# Source: zfs-localpv/templates/rbac.yaml kind: ClusterRoleBinding apiVersion: rbac.authorization.k8s.io/v1 metadata: name: openebs-zfs-snapshotter-binding + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" subjects: - - kind: ServiceAccount - name: openebs-zfs-controller-sa - namespace: kube-system +- kind: ServiceAccount + name: openebs-zfs-controller-sa + namespace: openebs roleRef: kind: ClusterRole name: openebs-zfs-snapshotter-role apiGroup: rbac.authorization.k8s.io - ---- - -######################################## -########### ############ -########### Node plugin ############ -########### ############ -######################################## - -apiVersion: v1 -kind: ServiceAccount -metadata: - name: openebs-zfs-node-sa - namespace: kube-system - ---- - -kind: ClusterRole -apiVersion: rbac.authorization.k8s.io/v1 -metadata: - name: openebs-zfs-driver-registrar-role -rules: - - apiGroups: [""] - resources: ["events"] - verbs: ["get", "list", "watch", "create", "update", "patch"] - - apiGroups: [""] - resources: ["persistentvolumes", "nodes", "services"] - verbs: ["get", "list"] - - apiGroups: ["*"] - resources: ["zfsvolumes", "zfssnapshots", "zfsbackups", "zfsrestores", "zfsnodes"] - verbs: ["get", "list", "watch", "create", "update", "patch"] - --- - +# Source: zfs-localpv/templates/rbac.yaml kind: ClusterRoleBinding apiVersion: rbac.authorization.k8s.io/v1 metadata: name: openebs-zfs-driver-registrar-binding + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + name: "openebs-zfs-node" + release: openebs + openebs.io/component-name: "openebs-zfs-node" subjects: - - kind: ServiceAccount - name: openebs-zfs-node-sa - namespace: kube-system +- kind: ServiceAccount + name: openebs-zfs-node-sa + namespace: openebs roleRef: kind: ClusterRole name: openebs-zfs-driver-registrar-role apiGroup: rbac.authorization.k8s.io - ---- - -kind: ConfigMap -apiVersion: v1 -metadata: - name: openebs-zfspv-bin - namespace: kube-system # should be the same namespace where it is getting mounted -data: - zfs: | - #!/bin/sh - if [ -x /host/sbin/zfs ]; then - chroot /host /sbin/zfs "$@" - elif [ -x /host/usr/sbin/zfs ]; then - chroot /host /usr/sbin/zfs "$@" - else - chroot /host zfs "$@" - fi - ---- - -apiVersion: scheduling.k8s.io/v1 -kind: PriorityClass -metadata: - name: openebs-zfs-csi-node-critical -# A PriorityClass object can have any 32-bit integer value smaller than or equal -# to 1 billion. Larger numbers are reserved for critical system Pods that should -# not normally be preempted or evicted. The higher the value, the higher the priority. -value: 900001000 -globalDefault: false -description: "This priority class should be used for the OpenEBS ZFS localPV CSI driver node deployment only." - --- - +# Source: zfs-localpv/templates/zfs-node.yaml kind: DaemonSet apiVersion: apps/v1 metadata: - name: openebs-zfs-node - namespace: kube-system + name: openebs-zfs-localpv-node + namespace: openebs labels: - openebs.io/component-name: openebs-zfs-node - openebs.io/version: ci + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + name: "openebs-zfs-node" + release: openebs + openebs.io/component-name: "openebs-zfs-node" spec: selector: matchLabels: - app: openebs-zfs-node + name: "openebs-zfs-node" + release: openebs updateStrategy: rollingUpdate: maxUnavailable: 100% @@ -2513,115 +1808,245 @@ spec: template: metadata: labels: - app: openebs-zfs-node - role: openebs-zfs - openebs.io/component-name: openebs-zfs-node - openebs.io/version: ci + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + name: "openebs-zfs-node" + release: openebs + openebs.io/component-name: "openebs-zfs-node" spec: priorityClassName: openebs-zfs-csi-node-critical serviceAccountName: openebs-zfs-node-sa hostNetwork: true containers: - - name: csi-node-driver-registrar - image: registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.8.0 - imagePullPolicy: IfNotPresent - args: - - "--v=5" - - "--csi-address=$(ADDRESS)" - - "--kubelet-registration-path=$(DRIVER_REG_SOCK_PATH)" - lifecycle: - preStop: - exec: - command: ["/bin/sh", "-c", "rm -rf /registration/zfs-localpv /registration/zfs-localpv-reg.sock"] - env: - - name: ADDRESS - value: /plugin/csi.sock - - name: DRIVER_REG_SOCK_PATH - value: /var/lib/kubelet/plugins/zfs-localpv/csi.sock - - name: KUBE_NODE_NAME - valueFrom: - fieldRef: - fieldPath: spec.nodeName - - name: NODE_DRIVER - value: openebs-zfs - volumeMounts: - - name: plugin-dir - mountPath: /plugin - - name: registration-dir - mountPath: /registration - - name: openebs-zfs-plugin - securityContext: - privileged: true - allowPrivilegeEscalation: true - image: openebs/zfs-driver:ci - imagePullPolicy: IfNotPresent - args: - - "--nodename=$(OPENEBS_NODE_NAME)" - - "--endpoint=$(OPENEBS_CSI_ENDPOINT)" - - "--plugin=$(OPENEBS_NODE_DRIVER)" - env: - - name: OPENEBS_NODE_NAME - valueFrom: - fieldRef: - fieldPath: spec.nodeName - - name: OPENEBS_CSI_ENDPOINT - value: unix:///plugin/csi.sock - - name: OPENEBS_NODE_DRIVER - value: agent - - name: OPENEBS_NAMESPACE - value: openebs - - name: ALLOWED_TOPOLOGIES - # The desired comma separated keys can be added here, - # by default all the node label keys are allowed. - # For example: - # value: "kubernetes.io/hostname,openebs.io/rack" - value: "All" - volumeMounts: - - name: plugin-dir - mountPath: /plugin - - name: device-dir - mountPath: /dev - - name: encr-keys - mountPath: /home/keys - - name: chroot-zfs - mountPath: /sbin/zfs - subPath: zfs - - name: host-root - mountPath: /host - mountPropagation: "HostToContainer" - readOnly: true - - name: pods-mount-dir - mountPath: /var/lib/kubelet/ - # needed so that any mounts setup inside this container are - # propagated back to the host machine. - mountPropagation: "Bidirectional" - volumes: + - name: csi-node-driver-registrar + image: "registry.k8s.io/sig-storage/csi-node-driver-registrar:v2.8.0" + imagePullPolicy: IfNotPresent + args: + - "--v=5" + - "--csi-address=$(ADDRESS)" + - "--kubelet-registration-path=$(DRIVER_REG_SOCK_PATH)" + lifecycle: + preStop: + exec: + command: ["/bin/sh", "-c", "rm -rf /registration/zfs-localpv /registration/zfs-localpv-reg.sock"] + env: + - name: ADDRESS + value: /plugin/csi.sock + - name: DRIVER_REG_SOCK_PATH + value: "/var/lib/kubelet/plugins/zfs-localpv/csi.sock" + - name: KUBE_NODE_NAME + valueFrom: + fieldRef: + fieldPath: spec.nodeName + - name: NODE_DRIVER + value: openebs-zfs + volumeMounts: + - name: plugin-dir + mountPath: /plugin + - name: registration-dir + mountPath: /registration + - name: openebs-zfs-plugin + securityContext: + privileged: true + allowPrivilegeEscalation: true + image: "openebs/zfs-driver:2.7.0-develop" + imagePullPolicy: IfNotPresent + args: + - "--nodename=$(OPENEBS_NODE_NAME)" + - "--endpoint=$(OPENEBS_CSI_ENDPOINT)" + - "--plugin=$(OPENEBS_NODE_DRIVER)" + env: + - name: OPENEBS_NODE_NAME + valueFrom: + fieldRef: + fieldPath: spec.nodeName + - name: OPENEBS_CSI_ENDPOINT + value: unix:///plugin/csi.sock + - name: OPENEBS_NODE_DRIVER + value: agent + - name: OPENEBS_NAMESPACE + valueFrom: + fieldRef: + fieldPath: metadata.namespace + - name: ALLOWED_TOPOLOGIES + value: "All" + volumeMounts: + - name: plugin-dir + mountPath: /plugin - name: device-dir - hostPath: - path: /dev - type: Directory + mountPath: /dev - name: encr-keys - hostPath: - path: /home/keys - type: DirectoryOrCreate + mountPath: /home/keys - name: chroot-zfs - configMap: - defaultMode: 0555 - name: openebs-zfspv-bin + mountPath: /sbin/zfs + subPath: zfs - name: host-root - hostPath: - path: / - type: Directory - - name: registration-dir - hostPath: - path: /var/lib/kubelet/plugins_registry/ - type: DirectoryOrCreate - - name: plugin-dir - hostPath: - path: /var/lib/kubelet/plugins/zfs-localpv/ - type: DirectoryOrCreate + mountPath: /host + mountPropagation: "HostToContainer" + readOnly: true - name: pods-mount-dir - hostPath: - path: /var/lib/kubelet/ - type: Directory + mountPath: "/var/lib/kubelet/" + # needed so that any mounts setup inside this container are + # propagated back to the host machine. + mountPropagation: "Bidirectional" + volumes: + - name: device-dir + hostPath: + path: /dev + type: Directory + - name: encr-keys + hostPath: + path: /home/keys + type: DirectoryOrCreate + - name: chroot-zfs + configMap: + defaultMode: 0555 + name: openebs-zfspv-bin + - name: host-root + hostPath: + path: / + type: Directory + - name: registration-dir + hostPath: + path: "/var/lib/kubelet/plugins_registry/" + type: DirectoryOrCreate + - name: plugin-dir + hostPath: + path: "/var/lib/kubelet/plugins/zfs-localpv/" + type: DirectoryOrCreate + - name: pods-mount-dir + hostPath: + path: "/var/lib/kubelet/" + type: Directory --- +# Source: zfs-localpv/templates/zfs-controller.yaml +apiVersion: apps/v1 +kind: Deployment +metadata: + name: openebs-zfs-localpv-controller + namespace: openebs + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" +spec: + selector: + matchLabels: + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + replicas: 1 + template: + metadata: + labels: + chart: zfs-localpv-2.7.0-develop + heritage: Helm + openebs.io/version: "2.7.0-develop" + role: "openebs-zfs" + app: "openebs-zfs-controller" + release: openebs + component: "openebs-zfs-controller" + openebs.io/component-name: "openebs-zfs-controller" + + name: openebs-zfs-controller + spec: + priorityClassName: openebs-zfs-csi-controller-critical + serviceAccountName: openebs-zfs-controller-sa + containers: + - name: csi-resizer + image: "registry.k8s.io/sig-storage/csi-resizer:v1.8.0" + args: + - "--v=5" + - "--csi-address=$(ADDRESS)" + env: + - name: ADDRESS + value: /var/lib/csi/sockets/pluginproxy/csi.sock + imagePullPolicy: IfNotPresent + volumeMounts: + - name: socket-dir + mountPath: /var/lib/csi/sockets/pluginproxy/ + - name: csi-snapshotter + image: "registry.k8s.io/sig-storage/csi-snapshotter:v6.2.2" + imagePullPolicy: IfNotPresent + args: + - "--csi-address=$(ADDRESS)" + env: + - name: ADDRESS + value: /var/lib/csi/sockets/pluginproxy/csi.sock + volumeMounts: + - name: socket-dir + mountPath: /var/lib/csi/sockets/pluginproxy/ + - name: snapshot-controller + image: "registry.k8s.io/sig-storage/snapshot-controller:v6.2.2" + args: + - "--v=5" + imagePullPolicy: IfNotPresent + - name: csi-provisioner + image: "registry.k8s.io/sig-storage/csi-provisioner:v3.5.0" + imagePullPolicy: IfNotPresent + args: + - "--csi-address=$(ADDRESS)" + - "--v=5" + - "--feature-gates=Topology=true" + - "--strict-topology" + - "--enable-capacity=true" + - "--extra-create-metadata=true" + - "--default-fstype=ext4" + env: + - name: ADDRESS + value: /var/lib/csi/sockets/pluginproxy/csi.sock + - name: NAMESPACE + valueFrom: + fieldRef: + fieldPath: metadata.namespace + - name: POD_NAME + valueFrom: + fieldRef: + fieldPath: metadata.name + volumeMounts: + - name: socket-dir + mountPath: /var/lib/csi/sockets/pluginproxy/ + - name: openebs-zfs-plugin + image: "openebs/zfs-driver:2.7.0-develop" + imagePullPolicy: IfNotPresent + env: + - name: OPENEBS_CONTROLLER_DRIVER + value: controller + - name: OPENEBS_CSI_ENDPOINT + value: unix:///var/lib/csi/sockets/pluginproxy/csi.sock + - name: OPENEBS_NAMESPACE + valueFrom: + fieldRef: + fieldPath: metadata.namespace + - name: OPENEBS_IO_INSTALLER_TYPE + value: "zfs-localpv-helm" + - name: OPENEBS_IO_ENABLE_ANALYTICS + value: "true" + args: + - "--endpoint=$(OPENEBS_CSI_ENDPOINT)" + - "--plugin=$(OPENEBS_CONTROLLER_DRIVER)" + volumeMounts: + - name: socket-dir + mountPath: /var/lib/csi/sockets/pluginproxy/ + volumes: + - name: socket-dir + emptyDir: {} +--- +# Source: zfs-localpv/templates/csidriver.yaml +# Create the CSI Driver object +apiVersion: storage.k8s.io/v1 +kind: CSIDriver +metadata: + name: zfs.csi.openebs.io +spec: + # do not require volumeattachment + attachRequired: false + podInfoOnMount: false + storageCapacity: true