diff --git a/.github/workflows/generate-sbom.yml b/.github/workflows/generate-sbom.yml new file mode 100644 index 0000000000..aa95fe3628 --- /dev/null +++ b/.github/workflows/generate-sbom.yml @@ -0,0 +1,61 @@ +name: Generate-SBOM +on: + release: + types: [published] + workflow_dispatch: + inputs: + tag: + description: "Tag that needs to generate sbom" + required: true +jobs: + generate-sbom: + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + - name: Install Syft + run: | + curl -sSfL https://raw.githubusercontent.com/anchore/syft/main/install.sh | sh -s -- -b /usr/local/bin + - name: Install Cosign + uses: sigstore/cosign-installer@v3.5.0 + - name: Generate Key + run: | + cosign generate-key-pair + env: + COSIGN_PASSWORD: "" + - name: Generate SBOM + run: | + mkdir sbom + LONGHORN_IMAGES_FILE=deploy/longhorn-images.txt + while read -r IMAGE; do + IMAGE_NAME="${IMAGE#*/}" + FILE_PREFIX="${IMAGE_NAME//:/-}" + syft -q "${IMAGE}" -o json --platform=linux/amd64 > "sbom/${FILE_PREFIX}-amd64.sbom" + if [[ "${IMAGE}" != *"openshift-origin-oauth-proxy"* ]]; then + syft -q "${IMAGE}" -o json --platform=linux/arm64 > "sbom/${FILE_PREFIX}-arm64.sbom" + fi + done < "${LONGHORN_IMAGES_FILE}" + - name: Sign SBOM + run: | + for SBOM_FILE in "sbom"/*; do + SIG_FILE_NAME="${SBOM_FILE%.*}.sig" + cosign sign-blob -y "${SBOM_FILE}" --key cosign.key --output-signature "${SIG_FILE_NAME}" + done + - name: Verify SBOM + run: | + for SBOM_FILE in "sbom"/*.sbom; do + SIG_FILE_NAME="${SBOM_FILE%.*}.sig" + cosign verify-blob --key cosign.pub --signature "$(cat "${SIG_FILE_NAME}")" "${SBOM_FILE}" + done + - name: Ship Public Key + run: | + cp cosign.pub sbom/cosign.pub + - name: Tar Assets + run: | + tar zcvf sbom.tar.gz sbom + - name: Upload Release Assets + uses: AButler/upload-release-assets@v3.0 + with: + files: sbom.tar.gz + repo-token: ${{ secrets.CUSTOM_GITHUB_TOKEN }} + release-tag: ${{ inputs.tag || '' }} \ No newline at end of file diff --git a/chart/Chart.yaml b/chart/Chart.yaml index 8d071db4e0..28a48b28a3 100644 --- a/chart/Chart.yaml +++ b/chart/Chart.yaml @@ -1,7 +1,7 @@ apiVersion: v1 name: longhorn -version: 1.6.0-dev -appVersion: v1.6.0-dev +version: 1.6.4 +appVersion: v1.6.4 kubeVersion: ">=1.21.0-0" description: Longhorn is a distributed block storage system for Kubernetes. keywords: diff --git a/chart/README.md b/chart/README.md index 87c1e4dbf6..34db95fb3b 100644 --- a/chart/README.md +++ b/chart/README.md @@ -73,257 +73,269 @@ The `values.yaml` contains items used to tweak a deployment of this chart. | Key | Type | Default | Description | |-----|------|---------|-------------| -| global.cattle.systemDefaultRegistry | string | `""` | System default registry | -| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector | string | `"kubernetes.io/os:linux"` | Node selector for Longhorn system managed components | -| global.cattle.windowsCluster.defaultSetting.taintToleration | string | `"cattle.io/os=linux:NoSchedule"` | Toleration for Longhorn system managed components | -| global.cattle.windowsCluster.enabled | bool | `false` | Enable this to allow Longhorn to run on the Rancher-deployed Windows cluster | -| global.cattle.windowsCluster.nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Select Linux nodes to run Longhorn user deployed components | -| global.cattle.windowsCluster.tolerations | list | `[{"effect":"NoSchedule","key":"cattle.io/os","operator":"Equal","value":"linux"}]` | Tolerate Linux nodes to run Longhorn user deployed components | +| global.cattle.systemDefaultRegistry | string | `""` | Default system registry. | +| global.cattle.windowsCluster.defaultSetting.systemManagedComponentsNodeSelector | string | `"kubernetes.io/os:linux"` | Node selector for system-managed Longhorn components. | +| global.cattle.windowsCluster.defaultSetting.taintToleration | string | `"cattle.io/os=linux:NoSchedule"` | Toleration for system-managed Longhorn components. | +| global.cattle.windowsCluster.enabled | bool | `false` | Setting that allows Longhorn to run on a Rancher Windows cluster. | +| global.cattle.windowsCluster.nodeSelector | object | `{"kubernetes.io/os":"linux"}` | Node selector for Linux nodes that can run user-deployed Longhorn components. | +| global.cattle.windowsCluster.tolerations | list | `[{"effect":"NoSchedule","key":"cattle.io/os","operator":"Equal","value":"linux"}]` | Toleration for Linux nodes that can run user-deployed Longhorn components. | +| global.nodeSelector | object | `{}` | Node selector for nodes allowed to run user-deployed components such as Longhorn Manager, Longhorn UI, and Longhorn Driver Deployer. | +| global.tolerations | list | `[]` | Toleration for nodes allowed to run user-deployed components such as Longhorn Manager, Longhorn UI, and Longhorn Driver Deployer. | ### Network Policies | Key | Type | Default | Description | |-----|------|---------|-------------| -| networkPolicies.enabled | bool | `false` | Enable NetworkPolicies to limit access to the Longhorn pods | -| networkPolicies.type | string | `"k3s"` | Create the policy based on your distribution to allow access for the ingress. Options: `k3s`, `rke2`, `rke1` | +| networkPolicies.enabled | bool | `false` | Setting that allows you to enable network policies that control access to Longhorn pods. | +| networkPolicies.type | string | `"k3s"` | Distribution that determines the policy for allowing access for an ingress. (Options: "k3s", "rke2", "rke1") | ### Image Settings | Key | Type | Default | Description | |-----|------|---------|-------------| -| image.csi.attacher.repository | string | `"longhornio/csi-attacher"` | Specify CSI attacher image repository. Leave blank to autodetect | -| image.csi.attacher.tag | string | `"v4.4.2"` | Specify CSI attacher image tag. Leave blank to autodetect | -| image.csi.livenessProbe.repository | string | `"longhornio/livenessprobe"` | Specify CSI liveness probe image repository. Leave blank to autodetect | -| image.csi.livenessProbe.tag | string | `"v2.11.0"` | Specify CSI liveness probe image tag. Leave blank to autodetect | -| image.csi.nodeDriverRegistrar.repository | string | `"longhornio/csi-node-driver-registrar"` | Specify CSI node driver registrar image repository. Leave blank to autodetect | -| image.csi.nodeDriverRegistrar.tag | string | `"v2.9.2"` | Specify CSI node driver registrar image tag. Leave blank to autodetect | -| image.csi.provisioner.repository | string | `"longhornio/csi-provisioner"` | Specify CSI provisioner image repository. Leave blank to autodetect | -| image.csi.provisioner.tag | string | `"v3.6.2"` | Specify CSI provisioner image tag. Leave blank to autodetect | -| image.csi.resizer.repository | string | `"longhornio/csi-resizer"` | Specify CSI driver resizer image repository. Leave blank to autodetect | -| image.csi.resizer.tag | string | `"v1.9.2"` | Specify CSI driver resizer image tag. Leave blank to autodetect | -| image.csi.snapshotter.repository | string | `"longhornio/csi-snapshotter"` | Specify CSI driver snapshotter image repository. Leave blank to autodetect | -| image.csi.snapshotter.tag | string | `"v6.3.2"` | Specify CSI driver snapshotter image tag. Leave blank to autodetect. | -| image.longhorn.backingImageManager.repository | string | `"longhornio/backing-image-manager"` | Specify Longhorn backing image manager image repository | -| image.longhorn.backingImageManager.tag | string | `"master-head"` | Specify Longhorn backing image manager image tag | -| image.longhorn.engine.repository | string | `"longhornio/longhorn-engine"` | Specify Longhorn engine image repository | -| image.longhorn.engine.tag | string | `"master-head"` | Specify Longhorn engine image tag | -| image.longhorn.instanceManager.repository | string | `"longhornio/longhorn-instance-manager"` | Specify Longhorn instance manager image repository | -| image.longhorn.instanceManager.tag | string | `"master-head"` | Specify Longhorn instance manager image tag | -| image.longhorn.manager.repository | string | `"longhornio/longhorn-manager"` | Specify Longhorn manager image repository | -| image.longhorn.manager.tag | string | `"master-head"` | Specify Longhorn manager image tag | -| image.longhorn.shareManager.repository | string | `"longhornio/longhorn-share-manager"` | Specify Longhorn share manager image repository | -| image.longhorn.shareManager.tag | string | `"master-head"` | Specify Longhorn share manager image tag | -| image.longhorn.supportBundleKit.repository | string | `"longhornio/support-bundle-kit"` | Specify Longhorn support bundle manager image repository | -| image.longhorn.supportBundleKit.tag | string | `"v0.0.33"` | Specify Longhorn support bundle manager image tag | -| image.longhorn.ui.repository | string | `"longhornio/longhorn-ui"` | Specify Longhorn ui image repository | -| image.longhorn.ui.tag | string | `"master-head"` | Specify Longhorn ui image tag | -| image.openshift.oauthProxy.repository | string | `"quay.io/openshift/origin-oauth-proxy"` | For openshift user. Specify oauth proxy image repository | -| image.openshift.oauthProxy.tag | float | `4.14` | For openshift user. Specify oauth proxy image tag. Note: Use your OCP/OKD 4.X Version, Current Stable is 4.14 | -| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy which applies to all Longhorn user-deployed components. E.g., Longhorn manager, Longhorn driver, Longhorn UI | +| image.csi.attacher.repository | string | `"longhornio/csi-attacher"` | Repository for the CSI attacher image. When unspecified, Longhorn uses the default value. | +| image.csi.attacher.tag | string | `"v4.7.0-20241219"` | Tag for the CSI attacher image. When unspecified, Longhorn uses the default value. | +| image.csi.livenessProbe.repository | string | `"longhornio/livenessprobe"` | Repository for the CSI liveness probe image. When unspecified, Longhorn uses the default value. | +| image.csi.livenessProbe.tag | string | `"v2.14.0-20241219"` | Tag for the CSI liveness probe image. When unspecified, Longhorn uses the default value. | +| image.csi.nodeDriverRegistrar.repository | string | `"longhornio/csi-node-driver-registrar"` | Repository for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value. | +| image.csi.nodeDriverRegistrar.tag | string | `"v2.12.0-20241219"` | Tag for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value. | +| image.csi.provisioner.repository | string | `"longhornio/csi-provisioner"` | Repository for the CSI Provisioner image. When unspecified, Longhorn uses the default value. | +| image.csi.provisioner.tag | string | `"v3.6.4-20241219"` | Tag for the CSI Provisioner image. When unspecified, Longhorn uses the default value. | +| image.csi.resizer.repository | string | `"longhornio/csi-resizer"` | Repository for the CSI Resizer image. When unspecified, Longhorn uses the default value. | +| image.csi.resizer.tag | string | `"v1.12.0-20241219"` | Tag for the CSI Resizer image. When unspecified, Longhorn uses the default value. | +| image.csi.snapshotter.repository | string | `"longhornio/csi-snapshotter"` | Repository for the CSI Snapshotter image. When unspecified, Longhorn uses the default value. | +| image.csi.snapshotter.tag | string | `"v6.3.4-20241219"` | Tag for the CSI Snapshotter image. When unspecified, Longhorn uses the default value. | +| image.longhorn.backingImageManager.repository | string | `"longhornio/backing-image-manager"` | Repository for the Backing Image Manager image. When unspecified, Longhorn uses the default value. | +| image.longhorn.backingImageManager.tag | string | `"v1.6.4"` | Specify Longhorn backing image manager image tag | +| image.longhorn.engine.repository | string | `"longhornio/longhorn-engine"` | Repository for the Longhorn Engine image. | +| image.longhorn.engine.tag | string | `"v1.6.4"` | Specify Longhorn engine image tag | +| image.longhorn.instanceManager.repository | string | `"longhornio/longhorn-instance-manager"` | Repository for the Longhorn Instance Manager image. | +| image.longhorn.instanceManager.tag | string | `"v1.6.4"` | Specify Longhorn instance manager image tag | +| image.longhorn.manager.repository | string | `"longhornio/longhorn-manager"` | Repository for the Longhorn Manager image. | +| image.longhorn.manager.tag | string | `"v1.6.4"` | Specify Longhorn manager image tag | +| image.longhorn.shareManager.repository | string | `"longhornio/longhorn-share-manager"` | Repository for the Longhorn Share Manager image. | +| image.longhorn.shareManager.tag | string | `"v1.6.4"` | Specify Longhorn share manager image tag | +| image.longhorn.supportBundleKit.repository | string | `"longhornio/support-bundle-kit"` | Repository for the Longhorn Support Bundle Manager image. | +| image.longhorn.supportBundleKit.tag | string | `"v0.0.48"` | Tag for the Longhorn Support Bundle Manager image. | +| image.longhorn.ui.repository | string | `"longhornio/longhorn-ui"` | Repository for the Longhorn UI image. | +| image.longhorn.ui.tag | string | `"v1.6.4"` | Specify Longhorn ui image tag | +| image.openshift.oauthProxy.repository | string | `""` | Repository for the OAuth Proxy image. Specify the upstream image (for example, "quay.io/openshift/origin-oauth-proxy"). This setting applies only to OpenShift users. | +| image.openshift.oauthProxy.tag | float | `""` | Tag for the OAuth Proxy image. Specify OCP/OKD version 4.1 or later (including version 4.15, which is available at quay.io/openshift/origin-oauth-proxy:4.15). This setting applies only to OpenShift users. | +| image.pullPolicy | string | `"IfNotPresent"` | Image pull policy that applies to all user-deployed Longhorn components, such as Longhorn Manager, Longhorn driver, and Longhorn UI. | ### Service Settings | Key | Description | |-----|-------------| -| service.manager.nodePort | NodePort port number (to set explicitly, chooses port between 30000-32767) | -| service.manager.type | Define the Longhorn manager service type. | -| service.ui.nodePort | NodePort port number (to set explicitly, chooses port between 30000-32767) | -| service.ui.type | Define the Longhorn UI service type. Options: `ClusterIP`, `NodePort`, `LoadBalancer`, `Rancher-Proxy` | +| service.manager.nodePort | NodePort port number for Longhorn Manager. When unspecified, Longhorn selects a free port between 30000 and 32767. | +| service.manager.type | Service type for Longhorn Manager. | +| service.ui.nodePort | NodePort port number for Longhorn UI. When unspecified, Longhorn selects a free port between 30000 and 32767. | +| service.ui.type | Service type for Longhorn UI. (Options: "ClusterIP", "NodePort", "LoadBalancer", "Rancher-Proxy") | ### StorageClass Settings | Key | Type | Default | Description | |-----|------|---------|-------------| -| persistence.backingImage.dataSourceParameters | string | `nil` | Specify the data source parameters for the backing image used in Longhorn StorageClass. This option accepts a json string of a map. E.g., `'{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'`. | -| persistence.backingImage.dataSourceType | string | `nil` | Specify the data source type for the backing image used in Longhorn StorageClass. If the backing image does not exist, Longhorn will use this field to create a backing image. Otherwise, Longhorn will use it to verify the selected backing image. | -| persistence.backingImage.enable | bool | `false` | Set backing image for Longhorn StorageClass | -| persistence.backingImage.expectedChecksum | string | `nil` | Specify the expected SHA512 checksum of the selected backing image in Longhorn StorageClass | -| persistence.backingImage.name | string | `nil` | Specify a backing image that will be used by Longhorn volumes in Longhorn StorageClass. If not exists, the backing image data source type and backing image data source parameters should be specified so that Longhorn will create the backing image before using it | -| persistence.defaultClass | bool | `true` | Set Longhorn StorageClass as default | -| persistence.defaultClassReplicaCount | int | `3` | Set replica count for Longhorn StorageClass | -| persistence.defaultDataLocality | string | `"disabled"` | Set data locality for Longhorn StorageClass. Options: `disabled`, `best-effort` | -| persistence.defaultFsType | string | `"ext4"` | Set filesystem type for Longhorn StorageClass | -| persistence.defaultMkfsParams | string | `""` | Set mkfs options for Longhorn StorageClass | -| persistence.defaultNodeSelector.enable | bool | `false` | Enable Node selector for Longhorn StorageClass | -| persistence.defaultNodeSelector.selector | string | `""` | This selector enables only certain nodes having these tags to be used for the volume. E.g. `"storage,fast"` | -| persistence.migratable | bool | `false` | Set volume migratable for Longhorn StorageClass | +| persistence.backingImage.dataSourceParameters | string | `nil` | Data source parameters of a backing image used in a Longhorn StorageClass. You can specify a JSON string of a map. (Example: `'{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'`) | +| persistence.backingImage.dataSourceType | string | `nil` | Data source type of a backing image used in a Longhorn StorageClass. If the backing image exists in the cluster, Longhorn uses this setting to verify the image. If the backing image does not exist, Longhorn creates one using the specified data source type. | +| persistence.backingImage.enable | bool | `false` | Setting that allows you to use a backing image in a Longhorn StorageClass. | +| persistence.backingImage.expectedChecksum | string | `nil` | Expected SHA-512 checksum of a backing image used in a Longhorn StorageClass. | +| persistence.backingImage.name | string | `nil` | Backing image to be used for creating and restoring volumes in a Longhorn StorageClass. When no backing images are available, specify the data source type and parameters that Longhorn can use to create a backing image. | +| persistence.defaultClass | bool | `true` | Setting that allows you to specify the default Longhorn StorageClass. | +| persistence.defaultClassReplicaCount | int | `3` | Replica count of the default Longhorn StorageClass. | +| persistence.defaultDataLocality | string | `"disabled"` | Data locality of the default Longhorn StorageClass. (Options: "disabled", "best-effort") | +| persistence.defaultFsType | string | `"ext4"` | Filesystem type of the default Longhorn StorageClass. | +| persistence.defaultMkfsParams | string | `""` | mkfs parameters of the default Longhorn StorageClass. | +| persistence.defaultNodeSelector.enable | bool | `false` | Setting that allows you to enable the node selector for the default Longhorn StorageClass. | +| persistence.defaultNodeSelector.selector | string | `""` | Node selector for the default Longhorn StorageClass. Longhorn uses only nodes with the specified tags for storing volume data. (Examples: "storage,fast") | +| persistence.migratable | bool | `false` | Setting that allows you to enable live migration of a Longhorn volume from one node to another. | | persistence.nfsOptions | string | `""` | Set NFS mount options for Longhorn StorageClass for RWX volumes | -| persistence.reclaimPolicy | string | `"Delete"` | Define reclaim policy. Options: `Retain`, `Delete` | -| persistence.recurringJobSelector.enable | bool | `false` | Enable recurring job selector for Longhorn StorageClass | -| persistence.recurringJobSelector.jobList | list | `[]` | Recurring job selector list for Longhorn StorageClass. Please be careful of quotes of input. E.g., `[{"name":"backup", "isGroup":true}]` | -| persistence.removeSnapshotsDuringFilesystemTrim | string | `"ignored"` | Allow automatically removing snapshots during filesystem trim for Longhorn StorageClass. Options: `ignored`, `enabled`, `disabled` | +| persistence.reclaimPolicy | string | `"Delete"` | Reclaim policy that provides instructions for handling of a volume after its claim is released. (Options: "Retain", "Delete") | +| persistence.recurringJobSelector.enable | bool | `false` | Setting that allows you to enable the recurring job selector for a Longhorn StorageClass. | +| persistence.recurringJobSelector.jobList | list | `[]` | Recurring job selector for a Longhorn StorageClass. Ensure that quotes are used correctly when specifying job parameters. (Example: `[{"name":"backup", "isGroup":true}]`) | +| persistence.removeSnapshotsDuringFilesystemTrim | string | `"ignored"` | Setting that allows you to enable automatic snapshot removal during filesystem trim for a Longhorn StorageClass. (Options: "ignored", "enabled", "disabled") | ### CSI Settings | Key | Description | |-----|-------------| -| csi.attacherReplicaCount | Specify replica count of CSI Attacher. Leave blank to use default count: 3 | -| csi.kubeletRootDir | Specify kubelet root-dir. Leave blank to autodetect | -| csi.provisionerReplicaCount | Specify replica count of CSI Provisioner. Leave blank to use default count: 3 | -| csi.resizerReplicaCount | Specify replica count of CSI Resizer. Leave blank to use default count: 3 | -| csi.snapshotterReplicaCount | Specify replica count of CSI Snapshotter. Leave blank to use default count: 3 | +| csi.attacherReplicaCount | Replica count of the CSI Attacher. When unspecified, Longhorn uses the default value ("3"). | +| csi.kubeletRootDir | kubelet root directory. When unspecified, Longhorn uses the default value. | +| csi.provisionerReplicaCount | Replica count of the CSI Provisioner. When unspecified, Longhorn uses the default value ("3"). | +| csi.resizerReplicaCount | Replica count of the CSI Resizer. When unspecified, Longhorn uses the default value ("3"). | +| csi.snapshotterReplicaCount | Replica count of the CSI Snapshotter. When unspecified, Longhorn uses the default value ("3"). | ### Longhorn Manager Settings -Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). -These settings only apply to Longhorn manager component. +Longhorn consists of user-deployed components (for example, Longhorn Manager, Longhorn Driver, and Longhorn UI) and system-managed components (for example, Instance Manager, Backing Image Manager, Share Manager, CSI Driver, and Engine Image). The following settings only apply to Longhorn Manager. | Key | Type | Default | Description | |-----|------|---------|-------------| -| longhornManager.log.format | string | `"plain"` | Options: `plain`, `json` | -| longhornManager.nodeSelector | object | `{}` | Select nodes to run Longhorn manager | -| longhornManager.priorityClass | string | `"longhorn-critical"` | Priority class for longhorn manager | -| longhornManager.serviceAnnotations | object | `{}` | Annotation used in Longhorn manager service | -| longhornManager.tolerations | list | `[]` | Tolerate nodes to run Longhorn manager | +| longhornManager.log.format | string | `"plain"` | Format of Longhorn Manager logs. (Options: "plain", "json") | +| longhornManager.nodeSelector | object | `{}` | Node selector for Longhorn Manager. Specify the nodes allowed to run Longhorn Manager. | +| longhornManager.priorityClass | string | `"longhorn-critical"` | PriorityClass for Longhorn Manager. | +| longhornManager.serviceAnnotations | object | `{}` | Annotation for the Longhorn Manager service. | +| longhornManager.tolerations | list | `[]` | Toleration for Longhorn Manager on nodes allowed to run Longhorn components. | ### Longhorn Driver Settings -Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). -These settings only apply to Longhorn driver component. +Longhorn consists of user-deployed components (for example, Longhorn Manager, Longhorn Driver, and Longhorn UI) and system-managed components (for example, Instance Manager, Backing Image Manager, Share Manager, CSI Driver, and Engine Image). The following settings only apply to Longhorn Driver. | Key | Type | Default | Description | |-----|------|---------|-------------| -| longhornDriver.nodeSelector | object | `{}` | Select nodes to run the Longhorn CSI driver | -| longhornDriver.priorityClass | string | `"longhorn-critical"` | Priority class for the Longhorn CSI driver | -| longhornDriver.tolerations | list | `[]` | Tolerate nodes to run the Longhorn CSI driver | +| longhornDriver.log.format | string | `"plain"` | Format of Longhorn Driver logs. (Options: "plain", "json") | +| longhornDriver.nodeSelector | object | `{}` | Node selector for Longhorn Driver. Specify the nodes allowed to run Longhorn Driver. | +| longhornDriver.priorityClass | string | `"longhorn-critical"` | PriorityClass for Longhorn Driver. | +| longhornDriver.tolerations | list | `[]` | Toleration for Longhorn Driver on nodes allowed to run Longhorn components. | ### Longhorn UI Settings -Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). -These settings only apply to Longhorn UI component. +Longhorn consists of user-deployed components (for example, Longhorn Manager, Longhorn Driver, and Longhorn UI) and system-managed components (for example, Instance Manager, Backing Image Manager, Share Manager, CSI Driver, and Engine Image). The following settings only apply to Longhorn UI. | Key | Type | Default | Description | |-----|------|---------|-------------| -| longhornUI.nodeSelector | object | `{}` | Select nodes to run Longhorn UI | -| longhornUI.priorityClass | string | `"longhorn-critical"` | Priority class count for Longhorn UI | -| longhornUI.replicas | int | `2` | Replica count for longhorn UI | -| longhornUI.tolerations | list | `[]` | Tolerate nodes to run Longhorn UI | +| longhornUI.nodeSelector | object | `{}` | Node selector for Longhorn UI. Specify the nodes allowed to run Longhorn UI. | +| longhornUI.priorityClass | string | `"longhorn-critical"` | PriorityClass for Longhorn UI. | +| longhornUI.replicas | int | `2` | Replica count for Longhorn UI. | +| longhornUI.tolerations | list | `[]` | Toleration for Longhorn UI on nodes allowed to run Longhorn components. | ### Ingress Settings | Key | Type | Default | Description | |-----|------|---------|-------------| -| ingress.annotations | string | `nil` | Ingress annotations done as key:value pairs | -| ingress.enabled | bool | `false` | Set to true to enable ingress record generation | -| ingress.host | string | `"sslip.io"` | Layer 7 Load Balancer hostname | -| ingress.ingressClassName | string | `nil` | Add ingressClassName to the Ingress Can replace the kubernetes.io/ingress.class annotation on v1.18+ | -| ingress.path | string | `"/"` | If ingress is enabled, you can set the default ingress path then you can access the UI by using the following full path {{host}}+{{path}} | -| ingress.secrets | string | `nil` | If you're providing your own certificates, please use this to add the certificates as secrets | -| ingress.secureBackends | bool | `false` | Enable this to enable that the backend service will be connected at port 443 | -| ingress.tls | bool | `false` | Set this to true to enable TLS on the ingress record | -| ingress.tlsSecret | string | `"longhorn.local-tls"` | If TLS is set to true, you must declare what secret will store the key/certificate for TLS | +| ingress.annotations | string | `nil` | Ingress annotations in the form of key-value pairs. | +| ingress.enabled | bool | `false` | Setting that allows Longhorn to generate ingress records for the Longhorn UI service. | +| ingress.host | string | `"sslip.io"` | Hostname of the Layer 7 load balancer. | +| ingress.ingressClassName | string | `nil` | IngressClass resource that contains ingress configuration, including the name of the Ingress controller. ingressClassName can replace the kubernetes.io/ingress.class annotation used in earlier Kubernetes releases. | +| ingress.path | string | `"/"` | Default ingress path. You can access the Longhorn UI by following the full ingress path {{host}}+{{path}}. | +| ingress.secrets | string | `nil` | Secret that contains a TLS private key and certificate. Use secrets if you want to use your own certificates to secure ingresses. | +| ingress.secureBackends | bool | `false` | Setting that allows you to enable secure connections to the Longhorn UI service via port 443. | +| ingress.tls | bool | `false` | Setting that allows you to enable TLS on ingress records. | +| ingress.tlsSecret | string | `"longhorn.local-tls"` | TLS secret that contains the private key and certificate to be used for TLS. This setting applies only when TLS is enabled on ingress records. | ### Private Registry Settings -Longhorn can be installed in an air gapped environment with private registry settings. Please refer to **Air Gap Installation** in our official site [link](https://longhorn.io/docs) +You can install Longhorn in an air-gapped environment with a private registry. For more information, see the **Air Gap Installation** section of the [documentation](https://longhorn.io/docs). | Key | Description | |-----|-------------| -| privateRegistry.createSecret | Set `true` to create a new private registry secret | -| privateRegistry.registryPasswd | Password used to authenticate to private registry | -| privateRegistry.registrySecret | If create a new private registry secret is true, create a Kubernetes secret with this name; else use the existing secret of this name. Use it to pull images from your private registry | -| privateRegistry.registryUrl | URL of private registry. Leave blank to apply system default registry | -| privateRegistry.registryUser | User used to authenticate to private registry | +| privateRegistry.createSecret | Setting that allows you to create a private registry secret. | +| privateRegistry.registryPasswd | Password for authenticating with a private registry. | +| privateRegistry.registrySecret | Kubernetes secret that allows you to pull images from a private registry. This setting applies only when creation of private registry secrets is enabled. You must include the private registry name in the secret name. | +| privateRegistry.registryUrl | URL of a private registry. When unspecified, Longhorn uses the default system registry. | +| privateRegistry.registryUser | User account used for authenticating with a private registry. | + +### Metrics Settings + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +| metrics.serviceMonitor.additionalLabels | object | `{}` | Additional labels for the Prometheus ServiceMonitor resource. | +| metrics.serviceMonitor.annotations | object | `{}` | Annotations for the Prometheus ServiceMonitor resource. | +| metrics.serviceMonitor.enabled | bool | `false` | Setting that allows the creation of a Prometheus ServiceMonitor resource for Longhorn Manager components. | +| metrics.serviceMonitor.interval | string | `""` | Interval at which Prometheus scrapes the metrics from the target. | +| metrics.serviceMonitor.metricRelabelings | list | `[]` | Configures the relabeling rules to apply to the samples before ingestion. See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.Endpoint) for formatting details. | +| metrics.serviceMonitor.relabelings | list | `[]` | Configures the relabeling rules to apply the target’s metadata labels. See the [Prometheus Operator documentation](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.Endpoint) for formatting details. | +| metrics.serviceMonitor.scrapeTimeout | string | `""` | Timeout after which Prometheus considers the scrape to be failed. | ### OS/Kubernetes Distro Settings -#### Opensift Settings +#### OpenShift Settings -Please also refer to this document [ocp-readme](https://github.com/longhorn/longhorn/blob/master/chart/ocp-readme.md) for more details +For more details, see the [ocp-readme](https://github.com/longhorn/longhorn/blob/master/chart/ocp-readme.md). | Key | Type | Default | Description | |-----|------|---------|-------------| -| openshift.enabled | bool | `false` | Enable when using openshift | -| openshift.ui.port | int | `443` | UI port in openshift environment | -| openshift.ui.proxy | int | `8443` | UI proxy in openshift environment | -| openshift.ui.route | string | `"longhorn-ui"` | UI route in openshift environment | +| openshift.enabled | bool | `false` | Setting that allows Longhorn to integrate with OpenShift. | +| openshift.ui.port | int | `443` | Port for accessing the OpenShift web console. | +| openshift.ui.proxy | int | `8443` | Port for proxy that provides access to the OpenShift web console. | +| openshift.ui.route | string | `"longhorn-ui"` | Route for connections between Longhorn and the OpenShift web console. | ### Other Settings | Key | Default | Description | |-----|---------|-------------| -| annotations | `{}` | Annotations to add to the Longhorn Manager DaemonSet Pods. Optional. | -| enableGoCoverDir | `false` | Enable this to allow Longhorn to generate code coverage profiles | -| enablePSP | `false` | For Kubernetes < v1.25, if your cluster enables Pod Security Policy admission controller, set this to `true` to ship a built-in longhorn-psp PodSecurityPolicy which allow privileged Longhorn pods to start | -| metrics.serviceMonitor.enabled | `false` | Setting that allows the creation of a Prometheus ServiceMonitor resource for Longhorn Manager components. | -| preUpgradeChecker.jobEnabled | `true` | Setting that allows Longhorn to perform pre-upgrade checks before starting the Longhorn Manager DaemonSet Pods. Disable this setting when installing Longhorn using Argo CD or other GitOps solutions. | -| preUpgradeChecker.upgradeVersionCheck | `true` | Setting that allows Longhorn to perform upgrade version checks after starting the Longhorn Manager DaemonSet Pods. Disabling this setting also disables `preUpgradeChecker.jobEnabled`, but it's not recommended to disable it. | +| annotations | `{}` | Annotation for the Longhorn Manager DaemonSet pods. This setting is optional. | +| enableGoCoverDir | `false` | Setting that allows Longhorn to generate code coverage profiles. | +| enablePSP | `false` | Setting that allows you to enable pod security policies (PSPs) that allow privileged Longhorn pods to start. This setting applies only to clusters running Kubernetes 1.25 and earlier, and with the built-in Pod Security admission controller enabled. | +| namespaceOverride | `""` | Specify override namespace, specifically this is useful for using longhorn as sub-chart and its release namespace is not the `longhorn-system`. | +| preUpgradeChecker.jobEnabled | `true` | Setting that allows Longhorn to perform pre-upgrade checks. Disable this setting when installing Longhorn using Argo CD or other GitOps solutions. | +| preUpgradeChecker.upgradeVersionCheck | `true` | Setting that allows Longhorn to perform upgrade version checks after starting the Longhorn Manager DaemonSet Pods. Disabling this setting also disables `preUpgradeChecker.jobEnabled`. Longhorn recommends keeping this setting enabled. | ### System Default Settings -For system default settings, you can first leave blank to use default values which will be applied when installing Longhorn. -You can then change them through UI after installation. -For more details like types or options, you can refer to **Settings Reference** in our official site [link](https://longhorn.io/docs) +During installation, you can either allow Longhorn to use the default system settings or use specific flags to modify the default values. After installation, you can modify the settings using the Longhorn UI. For more information, see the **Settings Reference** section of the [documentation](https://longhorn.io/docs). | Key | Description | |-----|-------------| -| defaultSettings.allowCollectingLonghornUsageMetrics | Enabling this setting will allow Longhorn to provide additional usage metrics to https://metrics.longhorn.io/. This information will help us better understand how Longhorn is being used, which will ultimately contribute to future improvements. | -| defaultSettings.allowEmptyDiskSelectorVolume | Allow Scheduling Empty Disk Selector Volumes To Any Disk | -| defaultSettings.allowEmptyNodeSelectorVolume | Allow Scheduling Empty Node Selector Volumes To Any Node | -| defaultSettings.allowRecurringJobWhileVolumeDetached | If this setting is enabled, Longhorn will automatically attach the volume and takes snapshot/backup when it is the time to do recurring snapshot/backup. | -| defaultSettings.allowVolumeCreationWithDegradedAvailability | This setting allows user to create and attach a volume that doesn't have all the replicas scheduled at the time of creation. | -| defaultSettings.autoCleanupRecurringJobBackupSnapshot | This setting enables Longhorn to automatically cleanup the snapshot generated by a recurring backup job. | -| defaultSettings.autoCleanupSystemGeneratedSnapshot | This setting enables Longhorn to automatically clean up the system-generated snapshot after replica rebuild is done. | -| defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedly | If enabled, Longhorn will automatically delete the workload pod managed by a controller (e.g., Deployment, StatefulSet, DaemonSet, etc...) when Longhorn volume is detached unexpectedly (e.g., during Kubernetes upgrade, Docker reboot, or network disconnect). By deleting the pod, its controller restarts the pod and Kubernetes handles volume reattachment and remount. | -| defaultSettings.autoSalvage | If enabled, volumes will be automatically salvaged when all the replicas become faulty, e.g., due to network disconnection. Longhorn will try to figure out which replica(s) are usable, then use them for the volume. By default, true. | -| defaultSettings.backingImageCleanupWaitInterval | This interval in minutes determines how long Longhorn will wait before cleaning up the backing image file when there is no replica in the disk using it. | -| defaultSettings.backingImageRecoveryWaitInterval | This interval in seconds determines how long Longhorn will wait before re-downloading the backing image file when all disk files of this backing image become failed or unknown. | -| defaultSettings.backupCompressionMethod | This setting allows users to specify backup compression method. | -| defaultSettings.backupConcurrentLimit | This setting controls how many worker threads per backup concurrently. | -| defaultSettings.backupTarget | The endpoint used to access the backupstore. Available: NFS, CIFS, AWS, GCP, AZURE. | -| defaultSettings.backupTargetCredentialSecret | The name of the Kubernetes secret associated with the backup target. | -| defaultSettings.backupstorePollInterval | In seconds. The backup store poll interval determines how often Longhorn checks the backup store for new backups. Set to 0 to disable the polling. By default, 300. | -| defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimit | This setting controls how Longhorn automatically upgrades volumes' engines to the new default engine image after upgrading Longhorn manager. The value of this setting specifies the maximum number of engines per node that are allowed to upgrade to the default engine image at the same time. If the value is 0, Longhorn will not automatically upgrade volumes' engines to the default version of engine image. | -| defaultSettings.concurrentReplicaRebuildPerNodeLimit | This setting controls how many replicas on a node can be rebuilt simultaneously. | -| defaultSettings.concurrentVolumeBackupRestorePerNodeLimit | This setting controls how many volumes on a node can restore the backup concurrently. Set the value to **0** to disable backup restore. | -| defaultSettings.createDefaultDiskLabeledNodes | Create default Disk automatically only on Nodes with the label "node.longhorn.io/create-default-disk=true" if no other disks exist. If disabled, the default disk will be created on all new nodes when each node is first added. | -| defaultSettings.defaultDataLocality | Longhorn volume has data locality if there is a local replica of the volume on the same node as the pod which is using the volume. | -| defaultSettings.defaultDataPath | Default path to use for storing data on a host. By default, "/var/lib/longhorn/" | -| defaultSettings.defaultLonghornStaticStorageClass | The 'storageClassName' is given to PVs and PVCs that are created for an existing Longhorn volume. The StorageClass name can also be used as a label, so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. By default, 'longhorn-static'. | -| defaultSettings.defaultReplicaCount | The default number of replicas when a volume is created from the Longhorn UI. For Kubernetes configuration, update the `numberOfReplicas` in the StorageClass. By default, 3. | -| defaultSettings.deletingConfirmationFlag | This flag is designed to prevent Longhorn from being accidentally uninstalled which will lead to data lost. | -| defaultSettings.detachManuallyAttachedVolumesWhenCordoned | Automatically detach volumes that are attached manually when the node is cordoned. | -| defaultSettings.disableRevisionCounter | This setting is only for volumes created by UI. By default, this is false, meaning there will be a revision counter file to track every write to the volume. During salvage-recovering, Longhorn will pick the replica with the largest revision counter as a candidate to recover the whole volume. If the revision counter is disabled, Longhorn will not track every write to the volume. During the salvage recovering, Longhorn will use the 'volume-head-xxx.img' file last modification time and file size to pick the replica candidate to recover the whole volume. | -| defaultSettings.disableSchedulingOnCordonedNode | Disable Longhorn manager to schedule replica on Kubernetes cordoned node. By default, true. | -| defaultSettings.disableSnapshotPurge | Temporarily prevent all attempts to purge volume snapshots. | -| defaultSettings.engineReplicaTimeout | In seconds. The setting specifies the timeout between the engine and replica(s), and the value should be between 8 and 30 seconds. The default value is 8 seconds. | -| defaultSettings.failedBackupTTL | In minutes. This setting determines how long Longhorn will keep the backup resource that was failed. Set to 0 to disable the auto-deletion. | -| defaultSettings.fastReplicaRebuildEnabled | This feature supports the fast replica rebuilding. It relies on the checksum of snapshot disk files, so setting the snapshot-data-integrity to **enable** or **fast-check** is a prerequisite. | -| defaultSettings.guaranteedInstanceManagerCPU | Percentage of the total allocatable CPU resources on each node to be reserved for each instance manager pod when the V1 Data Engine is enabled. The default value is 12 percent. | +| defaultSettings.allowCollectingLonghornUsageMetrics | Setting that allows Longhorn to periodically collect anonymous usage data for product improvement purposes. Longhorn sends collected data to the [Upgrade Responder](https://github.com/longhorn/upgrade-responder) server, which is the data source of the Longhorn Public Metrics Dashboard (https://metrics.longhorn.io). The Upgrade Responder server does not store data that can be used to identify clients, including IP addresses. | +| defaultSettings.allowEmptyDiskSelectorVolume | Setting that allows scheduling of empty disk selector volumes to any disk. | +| defaultSettings.allowEmptyNodeSelectorVolume | Setting that allows scheduling of empty node selector volumes to any node. | +| defaultSettings.allowRecurringJobWhileVolumeDetached | Setting that allows Longhorn to automatically attach a volume and create snapshots or backups when recurring jobs are run. | +| defaultSettings.allowVolumeCreationWithDegradedAvailability | Setting that allows you to create and attach a volume without having all replicas scheduled at the time of creation. | +| defaultSettings.autoCleanupRecurringJobBackupSnapshot | Setting that allows Longhorn to automatically clean up the snapshot generated by a recurring backup job. | +| defaultSettings.autoCleanupSystemGeneratedSnapshot | Setting that allows Longhorn to automatically clean up the system-generated snapshot after replica rebuilding is completed. | +| defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedly | Setting that allows Longhorn to automatically delete a workload pod that is managed by a controller (for example, daemonset) whenever a Longhorn volume is detached unexpectedly (for example, during Kubernetes upgrades). After deletion, the controller restarts the pod and then Kubernetes handles volume reattachment and remounting. | +| defaultSettings.autoSalvage | Setting that allows Longhorn to automatically salvage volumes when all replicas become faulty (for example, when the network connection is interrupted). Longhorn determines which replicas are usable and then uses these replicas for the volume. This setting is enabled by default. | +| defaultSettings.backingImageCleanupWaitInterval | Number of minutes that Longhorn waits before cleaning up the backing image file when no replicas in the disk are using it. | +| defaultSettings.backingImageRecoveryWaitInterval | Number of seconds that Longhorn waits before downloading a backing image file again when the status of all image disk files changes to "failed" or "unknown". | +| defaultSettings.backupCompressionMethod | Setting that allows you to specify a backup compression method. | +| defaultSettings.backupConcurrentLimit | Maximum number of worker threads that can concurrently run for each backup. | +| defaultSettings.backupTarget | Endpoint used to access the backupstore. (Options: "NFS", "CIFS", "AWS", "GCP", "AZURE") | +| defaultSettings.backupTargetCredentialSecret | Name of the Kubernetes secret associated with the backup target. | +| defaultSettings.backupstorePollInterval | Number of seconds that Longhorn waits before checking the backupstore for new backups. The default value is "300". When the value is "0", polling is disabled. | +| defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimit | Maximum number of engines that are allowed to concurrently upgrade on each node after Longhorn Manager is upgraded. When the value is "0", Longhorn does not automatically upgrade volume engines to the new default engine image version. | +| defaultSettings.concurrentReplicaRebuildPerNodeLimit | Maximum number of replicas that can be concurrently rebuilt on each node. | +| defaultSettings.concurrentVolumeBackupRestorePerNodeLimit | Maximum number of volumes that can be concurrently restored on each node using a backup. When the value is "0", restoration of volumes using a backup is disabled. | +| defaultSettings.createDefaultDiskLabeledNodes | Setting that allows Longhorn to automatically create a default disk only on nodes with the label "node.longhorn.io/create-default-disk=true" (if no other disks exist). When this setting is disabled, Longhorn creates a default disk on each node that is added to the cluster. | +| defaultSettings.defaultDataLocality | Default data locality. A Longhorn volume has data locality if a local replica of the volume exists on the same node as the pod that is using the volume. | +| defaultSettings.defaultDataPath | Default path for storing data on a host. The default value is "/var/lib/longhorn/". | +| defaultSettings.defaultLonghornStaticStorageClass | Default Longhorn StorageClass. "storageClassName" is assigned to PVs and PVCs that are created for an existing Longhorn volume. "storageClassName" can also be used as a label, so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. The default value is "longhorn-static". | +| defaultSettings.defaultReplicaCount | Default number of replicas for volumes created using the Longhorn UI. For Kubernetes configuration, modify the `numberOfReplicas` field in the StorageClass. The default value is "3". | +| defaultSettings.deletingConfirmationFlag | Flag that prevents accidental uninstallation of Longhorn. | +| defaultSettings.detachManuallyAttachedVolumesWhenCordoned | Setting that allows automatic detaching of manually-attached volumes when a node is cordoned. | +| defaultSettings.disableRevisionCounter | Setting that disables the revision counter and thereby prevents Longhorn from tracking all write operations to a volume. When salvaging a volume, Longhorn uses properties of the "volume-head-xxx.img" file (the last file size and the last time the file was modified) to select the replica to be used for volume recovery. This setting applies only to volumes created using the Longhorn UI. | +| defaultSettings.disableSchedulingOnCordonedNode | Setting that prevents Longhorn Manager from scheduling replicas on a cordoned Kubernetes node. This setting is enabled by default. | +| defaultSettings.disableSnapshotPurge | Setting that temporarily prevents all attempts to purge volume snapshots. | +| defaultSettings.engineReplicaTimeout | Timeout between the Longhorn Engine and replicas. Specify a value between "8" and "30" seconds. The default value is "8". | +| defaultSettings.failedBackupTTL | Number of minutes that Longhorn keeps a failed backup resource. When the value is "0", automatic deletion is disabled. | +| defaultSettings.fastReplicaRebuildEnabled | Setting that allows fast rebuilding of replicas using the checksum of snapshot disk files. Before enabling this setting, you must set the snapshot-data-integrity value to "enable" or "fast-check". | +| defaultSettings.guaranteedInstanceManagerCPU | Percentage of the total allocatable CPU resources on each node to be reserved for each instance manager pod when the V1 Data Engine is enabled. The default value is "12". | | defaultSettings.kubernetesClusterAutoscalerEnabled | Setting that notifies Longhorn that the cluster is using the Kubernetes Cluster Autoscaler. | -| defaultSettings.logLevel | The log level Panic, Fatal, Error, Warn, Info, Debug, Trace used in longhorn manager. Default to Info. | -| defaultSettings.nodeDownPodDeletionPolicy | Defines the Longhorn action when a Volume is stuck with a StatefulSet/Deployment Pod on a node that is down. | -| defaultSettings.nodeDrainPolicy | Define the policy to use when a node with the last healthy replica of a volume is drained. | -| defaultSettings.offlineReplicaRebuilding | This setting allows users to enable the offline replica rebuilding for volumes using v2 data engine. | -| defaultSettings.orphanAutoDeletion | This setting allows Longhorn to delete the orphan resource and its corresponding orphaned data automatically like stale replicas. Orphan resources on down or unknown nodes will not be cleaned up automatically. | -| defaultSettings.priorityClass | priorityClass for Longhorn system-managed components This setting can help prevent Longhorn components from being evicted under Node Pressure. Notice that this will be applied to Longhorn user-deployed components by default if there are no priority class values set yet, such as `longhornManager.priorityClass`. | -| defaultSettings.recurringFailedJobsHistoryLimit | This setting specifies how many failed backup or snapshot job histories should be retained. History will not be retained if the value is 0. | +| defaultSettings.logLevel | Log levels that indicate the type and severity of logs in Longhorn Manager. The default value is "Info". (Options: "Panic", "Fatal", "Error", "Warn", "Info", "Debug", "Trace") | +| defaultSettings.nodeDownPodDeletionPolicy | Policy that defines the action Longhorn takes when a volume is stuck with a StatefulSet or Deployment pod on a node that failed. | +| defaultSettings.nodeDrainPolicy | Policy that defines the action Longhorn takes when a node with the last healthy replica of a volume is drained. | +| defaultSettings.offlineReplicaRebuilding | Setting that allows rebuilding of offline replicas for volumes using the V2 Data Engine. | +| defaultSettings.orphanAutoDeletion | Setting that allows Longhorn to automatically delete an orphaned resource and the corresponding data (for example, stale replicas). Orphaned resources on failed or unknown nodes are not automatically cleaned up. | +| defaultSettings.priorityClass | PriorityClass for system-managed Longhorn components. This setting can help prevent Longhorn components from being evicted under Node Pressure. Notice that this will be applied to Longhorn user-deployed components by default if there are no priority class values set yet, such as `longhornManager.priorityClass`. | +| defaultSettings.recurringFailedJobsHistoryLimit | Maximum number of failed recurring backup and snapshot jobs to be retained. When the value is "0", a history of failed recurring jobs is not retained. | | defaultSettings.recurringJobMaxRetention | Maximum number of snapshots or backups to be retained. | -| defaultSettings.recurringSuccessfulJobsHistoryLimit | This setting specifies how many successful backup or snapshot job histories should be retained. History will not be retained if the value is 0. | -| defaultSettings.removeSnapshotsDuringFilesystemTrim | This setting allows Longhorn filesystem trim feature to automatically mark the latest snapshot and its ancestors as removed and stops at the snapshot containing multiple children. | -| defaultSettings.replicaAutoBalance | Enable this setting automatically re-balances replicas when discovered an available node. | -| defaultSettings.replicaDiskSoftAntiAffinity | Allow scheduling on disks with existing healthy replicas of the same volume. By default, true. | -| defaultSettings.replicaFileSyncHttpClientTimeout | In seconds. The setting specifies the HTTP client timeout to the file sync server. | -| defaultSettings.replicaReplenishmentWaitInterval | The interval in seconds determines how long Longhorn will at least wait to reuse the existing data on a failed replica rather than directly creating a new replica for a degraded volume. | -| defaultSettings.replicaSoftAntiAffinity | Allow scheduling on nodes with existing healthy replicas of the same volume. By default, false. | -| defaultSettings.replicaZoneSoftAntiAffinity | Allow scheduling new Replicas of Volume to the Nodes in the same Zone as existing healthy Replicas. Nodes don't belong to any Zone will be treated as in the same Zone. Notice that Longhorn relies on label `topology.kubernetes.io/zone=` in the Kubernetes node object to identify the zone. By default, true. | -| defaultSettings.restoreConcurrentLimit | This setting controls how many worker threads per restore concurrently. | -| defaultSettings.restoreVolumeRecurringJobs | Restore recurring jobs from the backup volume on the backup target and create recurring jobs if not exist during a backup restoration. | -| defaultSettings.snapshotDataIntegrity | This setting allows users to enable or disable snapshot hashing and data integrity checking. | -| defaultSettings.snapshotDataIntegrityCronjob | Unix-cron string format. The setting specifies when Longhorn checks the data integrity of snapshot disk files. | -| defaultSettings.snapshotDataIntegrityImmediateCheckAfterSnapshotCreation | Hashing snapshot disk files impacts the performance of the system. The immediate snapshot hashing and checking can be disabled to minimize the impact after creating a snapshot. | -| defaultSettings.storageMinimalAvailablePercentage | If the minimum available disk capacity exceeds the actual percentage of available disk capacity, the disk becomes unschedulable until more space is freed up. By default, 25. | -| defaultSettings.storageNetwork | Longhorn uses the storage network for in-cluster data traffic. Leave this blank to use the Kubernetes cluster network. | -| defaultSettings.storageOverProvisioningPercentage | Percentage of storage that can be allocated relative to hard drive capacity. The default value is 100. | -| defaultSettings.storageReservedPercentageForDefaultDisk | The reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node. | -| defaultSettings.supportBundleFailedHistoryLimit | This setting specifies how many failed support bundles can exist in the cluster. Set this value to **0** to have Longhorn automatically purge all failed support bundles. | -| defaultSettings.systemManagedComponentsNodeSelector | nodeSelector for Longhorn system-managed components | -| defaultSettings.systemManagedPodsImagePullPolicy | This setting defines the Image Pull Policy of Longhorn system managed pod. E.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system-managed pods restart. | -| defaultSettings.taintToleration | taintToleration for Longhorn system-managed components | -| defaultSettings.upgradeChecker | Upgrade Checker will check for a new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default, true. | -| defaultSettings.v1DataEngine | Setting that allows you to enable the V1 Data Engine. This setting is enabled by default. | +| defaultSettings.recurringSuccessfulJobsHistoryLimit | Maximum number of successful recurring backup and snapshot jobs to be retained. When the value is "0", a history of successful recurring jobs is not retained. | +| defaultSettings.removeSnapshotsDuringFilesystemTrim | Setting that allows Longhorn to automatically mark the latest snapshot and its parent files as removed during a filesystem trim. Longhorn does not remove snapshots containing multiple child files. | +| defaultSettings.replicaAutoBalance | Setting that automatically rebalances replicas when an available node is discovered. | +| defaultSettings.replicaDiskSoftAntiAffinity | Setting that allows scheduling on disks with existing healthy replicas of the same volume. This setting is enabled by default. | +| defaultSettings.replicaFileSyncHttpClientTimeout | Number of seconds that an HTTP client waits for a response from a File Sync server before considering the connection to have failed. | +| defaultSettings.replicaReplenishmentWaitInterval | Number of seconds that Longhorn waits before reusing existing data on a failed replica instead of creating a new replica of a degraded volume. | +| defaultSettings.replicaSoftAntiAffinity | Setting that allows scheduling on nodes with healthy replicas of the same volume. This setting is disabled by default. | +| defaultSettings.replicaZoneSoftAntiAffinity | Setting that allows Longhorn to schedule new replicas of a volume to nodes in the same zone as existing healthy replicas. Nodes that do not belong to any zone are treated as existing in the zone that contains healthy replicas. When identifying zones, Longhorn relies on the label "topology.kubernetes.io/zone=" in the Kubernetes node object. | +| defaultSettings.restoreConcurrentLimit | Maximum number of worker threads that can concurrently run for each restore operation. | +| defaultSettings.restoreVolumeRecurringJobs | Setting that restores recurring jobs from a backup volume on a backup target and creates recurring jobs if none exist during backup restoration. | +| defaultSettings.snapshotDataIntegrity | Setting that allows you to enable and disable snapshot hashing and data integrity checks. | +| defaultSettings.snapshotDataIntegrityCronjob | Setting that defines when Longhorn checks the integrity of data in snapshot disk files. You must use the Unix cron expression format. | +| defaultSettings.snapshotDataIntegrityImmediateCheckAfterSnapshotCreation | Setting that allows disabling of snapshot hashing after snapshot creation to minimize impact on system performance. | +| defaultSettings.snapshotMaxCount | Maximum snapshot count for a volume. The value should be between 2 to 250 | +| defaultSettings.storageMinimalAvailablePercentage | Percentage of minimum available disk capacity. When the minimum available capacity exceeds the total available capacity, the disk becomes unschedulable until more space is made available for use. The default value is "25". | +| defaultSettings.storageNetwork | Storage network for in-cluster traffic. When unspecified, Longhorn uses the Kubernetes cluster network. | +| defaultSettings.storageOverProvisioningPercentage | Percentage of storage that can be allocated relative to hard drive capacity. The default value is "100". | +| defaultSettings.storageReservedPercentageForDefaultDisk | Percentage of disk space that is not allocated to the default disk on each new Longhorn node. | +| defaultSettings.supportBundleFailedHistoryLimit | Maximum number of failed support bundles that can exist in the cluster. When the value is "0", Longhorn automatically purges all failed support bundles. | +| defaultSettings.systemManagedComponentsNodeSelector | Node selector for system-managed Longhorn components. | +| defaultSettings.systemManagedPodsImagePullPolicy | Image pull policy for system-managed pods, such as Instance Manager, engine images, and CSI Driver. Changes to the image pull policy are applied only after the system-managed pods restart. | +| defaultSettings.taintToleration | Taint or toleration for system-managed Longhorn components. Specify values using a semicolon-separated list in `kubectl taint` syntax (Example: key1=value1:effect; key2=value2:effect). | +| defaultSettings.upgradeChecker | Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default | +| defaultSettings.v1DataEngine | Setting that allows you to enable the V1 Data Engine. | | defaultSettings.v2DataEngine | Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. | -| defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU | Number of millicpus on each node to be reserved for each instance manager pod when the V2 Data Engine is enabled. The default value is 1250 millicpus. | +| defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU | Number of millicpus on each node to be reserved for each Instance Manager pod when the V2 Data Engine is enabled. The default value is "1250". | +| defaultSettings.v2DataEngineHugepageLimit | Setting that allows you to configure maximum huge page size (in MiB) for the V2 Data Engine. | --- Please see [link](https://github.com/longhorn/longhorn) for more information. diff --git a/chart/README.md.gotmpl b/chart/README.md.gotmpl index 1fa01f5bb6..6167301fad 100644 --- a/chart/README.md.gotmpl +++ b/chart/README.md.gotmpl @@ -131,8 +131,7 @@ The `values.yaml` contains items used to tweak a deployment of this chart. ### Longhorn Manager Settings -Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). -These settings only apply to Longhorn manager component. +Longhorn consists of user-deployed components (for example, Longhorn Manager, Longhorn Driver, and Longhorn UI) and system-managed components (for example, Instance Manager, Backing Image Manager, Share Manager, CSI Driver, and Engine Image). The following settings only apply to Longhorn Manager. | Key | Type | Default | Description | |-----|------|---------|-------------| @@ -144,8 +143,7 @@ These settings only apply to Longhorn manager component. ### Longhorn Driver Settings -Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). -These settings only apply to Longhorn driver component. +Longhorn consists of user-deployed components (for example, Longhorn Manager, Longhorn Driver, and Longhorn UI) and system-managed components (for example, Instance Manager, Backing Image Manager, Share Manager, CSI Driver, and Engine Image). The following settings only apply to Longhorn Driver. | Key | Type | Default | Description | |-----|------|---------|-------------| @@ -157,8 +155,7 @@ These settings only apply to Longhorn driver component. ### Longhorn UI Settings -Longhorn system contains user deployed components (e.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (e.g, instance manager, engine image, CSI driver, etc.). -These settings only apply to Longhorn UI component. +Longhorn consists of user-deployed components (for example, Longhorn Manager, Longhorn Driver, and Longhorn UI) and system-managed components (for example, Instance Manager, Backing Image Manager, Share Manager, CSI Driver, and Engine Image). The following settings only apply to Longhorn UI. | Key | Type | Default | Description | |-----|------|---------|-------------| @@ -180,7 +177,7 @@ These settings only apply to Longhorn UI component. ### Private Registry Settings -Longhorn can be installed in an air gapped environment with private registry settings. Please refer to **Air Gap Installation** in our official site [link](https://longhorn.io/docs) +You can install Longhorn in an air-gapped environment with a private registry. For more information, see the **Air Gap Installation** section of the [documentation](https://longhorn.io/docs). | Key | Description | |-----|-------------| @@ -190,11 +187,21 @@ Longhorn can be installed in an air gapped environment with private registry set {{- end }} {{- end }} +### Metrics Settings + +| Key | Type | Default | Description | +|-----|------|---------|-------------| +{{- range .Values }} + {{- if hasPrefix "metrics" .Key }} +| {{ .Key }} | {{ .Type }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | + {{- end }} +{{- end }} + ### OS/Kubernetes Distro Settings -#### Opensift Settings +#### OpenShift Settings -Please also refer to this document [ocp-readme](https://github.com/longhorn/longhorn/blob/master/chart/ocp-readme.md) for more details +For more details, see the [ocp-readme](https://github.com/longhorn/longhorn/blob/master/chart/ocp-readme.md). | Key | Type | Default | Description | |-----|------|---------|-------------| @@ -220,6 +227,7 @@ Please also refer to this document [ocp-readme](https://github.com/longhorn/long (hasPrefix "longhornUI" .Key) (hasPrefix "privateRegistry" .Key) (hasPrefix "ingress" .Key) + (hasPrefix "metrics" .Key) (hasPrefix "openshift" .Key) (hasPrefix "global" .Key)) }} | {{ .Key }} | {{ if .Default }}{{ .Default }}{{ else }}{{ .AutoDefault }}{{ end }} | {{ if .Description }}{{ .Description }}{{ else }}{{ .AutoDescription }}{{ end }} | @@ -228,9 +236,7 @@ Please also refer to this document [ocp-readme](https://github.com/longhorn/long ### System Default Settings -For system default settings, you can first leave blank to use default values which will be applied when installing Longhorn. -You can then change them through UI after installation. -For more details like types or options, you can refer to **Settings Reference** in our official site [link](https://longhorn.io/docs) +During installation, you can either allow Longhorn to use the default system settings or use specific flags to modify the default values. After installation, you can modify the settings using the Longhorn UI. For more information, see the **Settings Reference** section of the [documentation](https://longhorn.io/docs). | Key | Description | |-----|-------------| diff --git a/chart/ocp-readme.md b/chart/ocp-readme.md index f7638775b0..d2fb98e5f9 100644 --- a/chart/ocp-readme.md +++ b/chart/ocp-readme.md @@ -145,7 +145,7 @@ Minimum Adjustments Required openshift: oauthProxy: repository: quay.io/openshift/origin-oauth-proxy - tag: 4.14 # Use Your OCP/OKD 4.X Version, Current Stable is 4.14 + tag: 4.15 # Use Your OCP/OKD 4.X Version, Current Stable is 4.15 # defaultSettings: # Preparing nodes (Optional) # createDefaultDiskLabeledNodes: true diff --git a/chart/questions.yaml b/chart/questions.yaml index 5cab828964..1834d4ef4c 100644 --- a/chart/questions.yaml +++ b/chart/questions.yaml @@ -12,175 +12,175 @@ questions: subquestions: - variable: image.longhorn.manager.repository default: longhornio/longhorn-manager - description: "Specify Longhorn Manager Image Repository" + description: "Repository for the Longhorn Manager image." type: string label: Longhorn Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.manager.tag - default: master-head + default: v1.6.4 description: "Specify Longhorn Manager Image Tag" type: string label: Longhorn Manager Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.engine.repository default: longhornio/longhorn-engine - description: "Specify Longhorn Engine Image Repository" + description: "Repository for the Longhorn Engine image." type: string label: Longhorn Engine Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.engine.tag - default: master-head + default: v1.6.4 description: "Specify Longhorn Engine Image Tag" type: string label: Longhorn Engine Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.ui.repository default: longhornio/longhorn-ui - description: "Specify Longhorn UI Image Repository" + description: "Repository for the Longhorn UI image." type: string label: Longhorn UI Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.ui.tag - default: master-head + default: v1.6.4 description: "Specify Longhorn UI Image Tag" type: string label: Longhorn UI Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.instanceManager.repository default: longhornio/longhorn-instance-manager - description: "Specify Longhorn Instance Manager Image Repository" + description: "Repository for the Longhorn Instance Manager image." type: string label: Longhorn Instance Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.instanceManager.tag - default: v2_20221123 + default: v1.6.4 description: "Specify Longhorn Instance Manager Image Tag" type: string label: Longhorn Instance Manager Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.shareManager.repository default: longhornio/longhorn-share-manager - description: "Specify Longhorn Share Manager Image Repository" + description: "Repository for the Longhorn Share Manager image." type: string label: Longhorn Share Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.shareManager.tag - default: v1_20220914 + default: v1.6.4 description: "Specify Longhorn Share Manager Image Tag" type: string label: Longhorn Share Manager Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.backingImageManager.repository default: longhornio/backing-image-manager - description: "Specify Longhorn Backing Image Manager Image Repository" + description: "Repository for the Backing Image Manager image. When unspecified, Longhorn uses the default value." type: string label: Longhorn Backing Image Manager Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.backingImageManager.tag - default: v3_20220808 + default: v1.6.4 description: "Specify Longhorn Backing Image Manager Image Tag" type: string label: Longhorn Backing Image Manager Image Tag group: "Longhorn Images Settings" - variable: image.longhorn.supportBundleKit.repository default: longhornio/support-bundle-kit - description: "Specify Longhorn Support Bundle Manager Image Repository" + description: "Repository for the Longhorn Support Bundle Manager image." type: string label: Longhorn Support Bundle Kit Image Repository group: "Longhorn Images Settings" - variable: image.longhorn.supportBundleKit.tag - default: v0.0.33 - description: "Specify Longhorn Support Bundle Manager Image Tag" + default: v0.0.48 + description: "Tag for the Longhorn Support Bundle Manager image." type: string label: Longhorn Support Bundle Kit Image Tag group: "Longhorn Images Settings" - variable: image.csi.attacher.repository default: longhornio/csi-attacher - description: "Specify CSI attacher image repository. Leave blank to autodetect." + description: "Repository for the CSI attacher image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Attacher Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.attacher.tag - default: v4.4.2 - description: "Specify CSI attacher image tag. Leave blank to autodetect." + default: v4.7.0-20241219 + description: "Tag for the CSI attacher image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Attacher Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.provisioner.repository default: longhornio/csi-provisioner - description: "Specify CSI provisioner image repository. Leave blank to autodetect." + description: "Repository for the CSI Provisioner image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Provisioner Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.provisioner.tag - default: v3.6.2 - description: "Specify CSI provisioner image tag. Leave blank to autodetect." + default: v3.6.4-20241219 + description: "Tag for the CSI Provisioner image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Provisioner Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.nodeDriverRegistrar.repository default: longhornio/csi-node-driver-registrar - description: "Specify CSI Node Driver Registrar image repository. Leave blank to autodetect." + description: "Repository for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Node Driver Registrar Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.nodeDriverRegistrar.tag - default: v2.9.2 - description: "Specify CSI Node Driver Registrar image tag. Leave blank to autodetect." + default: v2.12.0-20241219 + description: "Tag for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Node Driver Registrar Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.resizer.repository default: longhornio/csi-resizer - description: "Specify CSI Driver Resizer image repository. Leave blank to autodetect." + description: "Repository for the CSI Resizer image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Driver Resizer Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.resizer.tag - default: v1.9.2 - description: "Specify CSI Driver Resizer image tag. Leave blank to autodetect." + default: v1.12.0-20241219 + description: "Tag for the CSI Resizer image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Driver Resizer Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.snapshotter.repository default: longhornio/csi-snapshotter - description: "Specify CSI Driver Snapshotter image repository. Leave blank to autodetect." + description: "Repository for the CSI Snapshotter image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Driver Snapshotter Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.snapshotter.tag - default: v6.3.2 - description: "Specify CSI Driver Snapshotter image tag. Leave blank to autodetect." + default: v6.3.4-20241219 + description: "Tag for the CSI Snapshotter image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Driver Snapshotter Image Tag group: "Longhorn CSI Driver Images" - variable: image.csi.livenessProbe.repository default: longhornio/livenessprobe - description: "Specify CSI liveness probe image repository. Leave blank to autodetect." + description: "Repository for the CSI liveness probe image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Liveness Probe Image Repository group: "Longhorn CSI Driver Images" - variable: image.csi.livenessProbe.tag - default: v2.11.0 - description: "Specify CSI liveness probe image tag. Leave blank to autodetect." + default: v2.14.0-20241219 + description: "Tag for the CSI liveness probe image. When unspecified, Longhorn uses the default value." type: string label: Longhorn CSI Liveness Probe Image Tag group: "Longhorn CSI Driver Images" - variable: privateRegistry.registryUrl label: Private registry URL - description: "URL of private registry. Leave blank to apply system default registry." + description: "URL of a private registry. When unspecified, Longhorn uses the default system registry." group: "Private Registry Settings" type: string default: "" - variable: privateRegistry.registrySecret label: Private registry secret name - description: "If create a new private registry secret is true, create a Kubernetes secret with this name; else use the existing secret of this name. Use it to pull images from your private registry." + description: "Kubernetes secret that allows you to pull images from a private registry. This setting applies only when creation of private registry secrets is enabled. You must include the private registry name in the secret name." group: "Private Registry Settings" type: string default: "" - variable: privateRegistry.createSecret default: "true" - description: "Create a new private registry secret" + description: "Setting that allows you to create a private registry secret." type: boolean group: "Private Registry Settings" label: Create Secret for Private Registry Settings @@ -188,12 +188,12 @@ questions: subquestions: - variable: privateRegistry.registryUser label: Private registry user - description: "User used to authenticate to private registry." + description: "User account used for authenticating with a private registry." type: string default: "" - variable: privateRegistry.registryPasswd label: Private registry password - description: "Password used to authenticate to private registry." + description: "Password for authenticating with a private registry." type: password default: "" - variable: longhorn.default_setting @@ -206,7 +206,7 @@ questions: subquestions: - variable: csi.kubeletRootDir default: - description: "Specify kubelet root-dir. Leave blank to autodetect." + description: "kubelet root directory. When unspecified, Longhorn uses the default value." type: string label: Kubelet Root Directory group: "Longhorn CSI Driver Settings" @@ -215,7 +215,7 @@ questions: default: 3 min: 1 max: 10 - description: "Specify replica count of CSI Attacher. By default 3." + description: "Replica count of the CSI Attacher. When unspecified, Longhorn uses the default value (\"3\")." label: Longhorn CSI Attacher replica count group: "Longhorn CSI Driver Settings" - variable: csi.provisionerReplicaCount @@ -223,7 +223,7 @@ questions: default: 3 min: 1 max: 10 - description: "Specify replica count of CSI Provisioner. By default 3." + description: "Replica count of the CSI Provisioner. When unspecified, Longhorn uses the default value (\"3\")." label: Longhorn CSI Provisioner replica count group: "Longhorn CSI Driver Settings" - variable: csi.resizerReplicaCount @@ -231,7 +231,7 @@ questions: default: 3 min: 1 max: 10 - description: "Specify replica count of CSI Resizer. By default 3." + description: "Replica count of the CSI Resizer. When unspecified, Longhorn uses the default value (\"3\")." label: Longhorn CSI Resizer replica count group: "Longhorn CSI Driver Settings" - variable: csi.snapshotterReplicaCount @@ -239,42 +239,50 @@ questions: default: 3 min: 1 max: 10 - description: "Specify replica count of CSI Snapshotter. By default 3." + description: "Replica count of the CSI Snapshotter. When unspecified, Longhorn uses the default value (\"3\")." label: Longhorn CSI Snapshotter replica count group: "Longhorn CSI Driver Settings" - variable: defaultSettings.backupTarget label: Backup Target - description: "The endpoint used to access the backupstore. Available: NFS, CIFS, AWS, GCP, AZURE" + description: "Endpoint used to access the backupstore. (Options: \"NFS\", \"CIFS\", \"AWS\", \"GCP\", \"AZURE\")" group: "Longhorn Default Settings" type: string default: - variable: defaultSettings.backupTargetCredentialSecret label: Backup Target Credential Secret - description: "The name of the Kubernetes secret associated with the backup target." + description: "Name of the Kubernetes secret associated with the backup target." group: "Longhorn Default Settings" type: string default: - variable: defaultSettings.allowRecurringJobWhileVolumeDetached label: Allow Recurring Job While Volume Is Detached - description: 'If this setting is enabled, Longhorn will automatically attach the volume and takes snapshot/backup when it is the time to do recurring snapshot/backup.' + description: 'Setting that allows Longhorn to automatically attach a volume and create snapshots or backups when recurring jobs are run.' group: "Longhorn Default Settings" type: boolean default: "false" + - variable: defaultSettings.snapshotMaxCount + label: Snapshot Maximum Count + description: 'Maximum snapshot count for a volume. The value should be between 2 to 250.' + group: "Longhorn Default Settings" + type: int + min: 2 + max: 250 + default: 250 - variable: defaultSettings.createDefaultDiskLabeledNodes label: Create Default Disk on Labeled Nodes - description: 'Create default Disk automatically only on Nodes with the label "node.longhorn.io/create-default-disk=true" if no other disks exist. If disabled, the default disk will be created on all new nodes when each node is first added.' + description: 'Setting that allows Longhorn to automatically create a default disk only on nodes with the label "node.longhorn.io/create-default-disk=true" (if no other disks exist). When this setting is disabled, Longhorn creates a default disk on each node that is added to the cluster.' group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.defaultDataPath label: Default Data Path - description: 'Default path to use for storing data on a host. By default, "/var/lib/longhorn/"' + description: 'Default path for storing data on a host. The default value is "/var/lib/longhorn/".' group: "Longhorn Default Settings" type: string default: "/var/lib/longhorn/" - variable: defaultSettings.defaultDataLocality label: Default Data Locality - description: 'Longhorn volume has data locality if there is a local replica of the volume on the same node as the pod which is using the volume.' + description: 'Default data locality. A Longhorn volume has data locality if a local replica of the volume exists on the same node as the pod that is using the volume.' group: "Longhorn Default Settings" type: enum options: @@ -322,13 +330,13 @@ questions: default: 30 - variable: defaultSettings.upgradeChecker label: Enable Upgrade Checker - description: 'Upgrade Checker will check for a new Longhorn version periodically. When there is a new version available, a notification will appear in the UI. By default, true.' + description: 'Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default.' group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.defaultReplicaCount label: Default Replica Count - description: "The default number of replicas when a volume is created from the Longhorn UI. For Kubernetes configuration, update the `numberOfReplicas` in the StorageClass. By default, 3." + description: "Default number of replicas for volumes created using the Longhorn UI. For Kubernetes configuration, modify the `numberOfReplicas` field in the StorageClass. The default value is \"3\"." group: "Longhorn Default Settings" type: int min: 1 @@ -336,20 +344,20 @@ questions: default: 3 - variable: defaultSettings.defaultLonghornStaticStorageClass label: Default Longhorn Static StorageClass Name - description: "The 'storageClassName' is given to PVs and PVCs that are created for an existing Longhorn volume. The StorageClass name can also be used as a label, so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. By default, 'longhorn-static'." + description: "Default Longhorn StorageClass. \"storageClassName\" is assigned to PVs and PVCs that are created for an existing Longhorn volume. \"storageClassName\" can also be used as a label, so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. The default value is \"longhorn-static\"." group: "Longhorn Default Settings" type: string default: "longhorn-static" - variable: defaultSettings.backupstorePollInterval label: Backupstore Poll Interval - description: "In seconds. The backup store poll interval determines how often Longhorn checks the backup store for new backups. Set to 0 to disable the polling. By default, 300." + description: "Number of seconds that Longhorn waits before checking the backupstore for new backups. The default value is \"300\". When the value is \"0\", polling is disabled." group: "Longhorn Default Settings" type: int min: 0 default: 300 - variable: defaultSettings.failedBackupTTL label: Failed Backup Time to Live - description: "In minutes. This setting determines how long Longhorn will keep the backup resource that was failed. Set to 0 to disable the auto-deletion." + description: "Number of minutes that Longhorn keeps a failed backup resource. When the value is \"0\", automatic deletion is disabled." group: "Longhorn Default Settings" type: int min: 0 @@ -369,7 +377,7 @@ questions: default: 1 - variable: defaultSettings.recurringFailedJobsHistoryLimit label: Cronjob Failed Jobs History Limit - description: "This setting specifies how many failed backup or snapshot job histories should be retained. History will not be retained if the value is 0." + description: 'Maximum number of failed recurring backup and snapshot jobs to be retained. When the value is "0", a history of failed recurring jobs is not retained.' group: "Longhorn Default Settings" type: int min: 0 @@ -389,19 +397,19 @@ questions: default: 1 - variable: defaultSettings.autoSalvage label: Automatic salvage - description: "If enabled, volumes will be automatically salvaged when all the replicas become faulty, e.g. due to network disconnection. Longhorn will try to figure out which replica(s) are usable, then use them for the volume. By default, true." + description: "Setting that allows Longhorn to automatically salvage volumes when all replicas become faulty (for example, when the network connection is interrupted). Longhorn determines which replicas are usable and then uses these replicas for the volume. This setting is enabled by default." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.autoDeletePodWhenVolumeDetachedUnexpectedly label: Automatically Delete Workload Pod when The Volume Is Detached Unexpectedly - description: 'If enabled, Longhorn will automatically delete the workload pod managed by a controller (e.g. Deployment, Statefulset, Daemonset, etc...) when Longhorn volume is detached unexpectedly (e.g., during Kubernetes upgrade, Docker reboot, or network disconnect). By deleting the pod, its controller restarts the pod and Kubernetes handles volume reattachment and remount.' + description: 'Setting that allows Longhorn to automatically delete a workload pod that is managed by a controller (for example, daemonset) whenever a Longhorn volume is detached unexpectedly (for example, during Kubernetes upgrades). After deletion, the controller restarts the pod and then Kubernetes handles volume reattachment and remounting.' group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.disableSchedulingOnCordonedNode label: Disable Scheduling On Cordoned Node - description: "Disable Longhorn manager to schedule replica on Kubernetes cordoned node. By default, true." + description: "Setting that prevents Longhorn Manager from scheduling replicas on a cordoned Kubernetes node. This setting is enabled by default." group: "Longhorn Default Settings" type: boolean default: "true" @@ -419,19 +427,19 @@ questions: default: "true" - variable: defaultSettings.allowEmptyNodeSelectorVolume label: Allow Empty Node Selector Volume - description: "Allow Scheduling Empty Node Selector Volumes To Any Node" + description: "Setting that allows scheduling of empty node selector volumes to any node." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.allowEmptyDiskSelectorVolume label: Allow Empty Disk Selector Volume - description: "Allow Scheduling Empty Disk Selector Volumes To Any Disk" + description: "Setting that allows scheduling of empty disk selector volumes to any disk." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.nodeDownPodDeletionPolicy label: Pod Deletion Policy When Node is Down - description: "Defines the Longhorn action when a Volume is stuck with a StatefulSet/Deployment Pod on a node that is down." + description: "Policy that defines the action Longhorn takes when a volume is stuck with a StatefulSet or Deployment pod on a node that failed." group: "Longhorn Default Settings" type: enum options: @@ -442,7 +450,7 @@ questions: default: "do-nothing" - variable: defaultSettings.nodeDrainPolicy label: Node Drain Policy - description: "Define the policy to use when a node with the last healthy replica of a volume is drained." + description: "Policy that defines the action Longhorn takes when a node with the last healthy replica of a volume is drained." group: "Longhorn Default Settings" type: enum options: @@ -454,13 +462,13 @@ questions: default: "block-if-contains-last-replica" - variable: defaultSettings.detachManuallyAttachedVolumesWhenCordoned label: Detach Manually Attached Volumes When Cordoned - description: "Automatically detach volumes that are attached manually when the node is cordoned." + description: "Setting that allows automatic detaching of manually-attached volumes when a node is cordoned." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.priorityClass label: Priority Class - description: "The name of the Priority Class to set on the Longhorn components. This setting can help prevent Longhorn components from being evicted under Node Pressure. Longhorn system contains user deployed components (E.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (E.g, instance manager, engine image, CSI driver, etc.) Note that this will be applied to Longhorn user-deployed components by default if there are no priority class values set yet, such as `longhornManager.priorityClass`. WARNING: DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES." + description: "PriorityClass for system-managed Longhorn components. This setting can help prevent Longhorn components from being evicted under Node Pressure. Longhorn system contains user deployed components (E.g, Longhorn manager, Longhorn driver, Longhorn UI) and system managed components (E.g, instance manager, engine image, CSI driver, etc.) Note that this will be applied to Longhorn user-deployed components by default if there are no priority class values set yet, such as `longhornManager.priorityClass`. WARNING: DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES." group: "Longhorn Default Settings" type: string default: "longhorn-critical" @@ -473,27 +481,31 @@ questions: default: 600 - variable: defaultSettings.concurrentReplicaRebuildPerNodeLimit label: Concurrent Replica Rebuild Per Node Limit - description: "This setting controls how many replicas on a node can be rebuilt simultaneously." + description: "Maximum number of replicas that can be concurrently rebuilt on each node. + WARNING: + - The old setting \"Disable Replica Rebuild\" is replaced by this setting. + - Different from relying on replica starting delay to limit the concurrent rebuilding, if the rebuilding is disabled, replica object replenishment will be directly skipped. + - When the value is 0, the eviction and data locality feature won't work. But this shouldn't have any impact to any current replica rebuild and backup restore." group: "Longhorn Default Settings" type: int min: 0 default: 5 - variable: defaultSettings.concurrentVolumeBackupRestorePerNodeLimit label: Concurrent Volume Backup Restore Per Node Limit - description: "This setting controls how many volumes on a node can restore the backup concurrently. Set the value to **0** to disable backup restore." + description: "Maximum number of volumes that can be concurrently restored on each node using a backup. When the value is \"0\", restoration of volumes using a backup is disabled." group: "Longhorn Default Settings" type: int min: 0 default: 5 - variable: defaultSettings.disableRevisionCounter label: Disable Revision Counter - description: "This setting is only for volumes created by UI. By default, this is false, meaning there will be a revision counter file to track every write to the volume. During salvage-recovering, Longhorn will pick the replica with the largest revision counter as a candidate to recover the whole volume. If the revision counter is disabled, Longhorn will not track every write to the volume. During the salvage recovering, Longhorn will use the 'volume-head-xxx.img' file last modification time and file size to pick the replica candidate to recover the whole volume." + description: "Setting that disables the revision counter and thereby prevents Longhorn from tracking all write operations to a volume. When salvaging a volume, Longhorn uses properties of the \"volume-head-xxx.img\" file (the last file size and the last time the file was modified) to select the replica to be used for volume recovery. This setting applies only to volumes created using the Longhorn UI." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.systemManagedPodsImagePullPolicy label: System Managed Pod Image Pull Policy - description: "This setting defines the Image Pull Policy of Longhorn system-managed pods, E.g. instance manager, engine image, CSI driver, etc. The new Image Pull Policy will only apply after the system-managed pods restart." + description: "Image pull policy for system-managed pods, such as Instance Manager, engine images, and CSI Driver. Changes to the image pull policy are applied only after the system-managed pods restart." group: "Longhorn Default Settings" type: enum options: @@ -503,46 +515,52 @@ questions: default: "if-not-present" - variable: defaultSettings.allowVolumeCreationWithDegradedAvailability label: Allow Volume Creation with Degraded Availability - description: "This setting allows user to create and attach a volume that doesn't have all the replicas scheduled at the time of creation." + description: "Setting that allows you to create and attach a volume without having all replicas scheduled at the time of creation." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.autoCleanupSystemGeneratedSnapshot label: Automatically Cleanup System Generated Snapshot - description: "This setting enables Longhorn to automatically clean up the system-generated snapshot after replica rebuild is done." + description: "Setting that allows Longhorn to automatically clean up the system-generated snapshot after replica rebuilding is completed." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.autoCleanupRecurringJobBackupSnapshot label: Automatically Cleanup Recurring Job Backup Snapshot - description: "This setting enables Longhorn to automatically cleanup the snapshot generated by a recurring backup job." + description: "Setting that allows Longhorn to automatically clean up the snapshot generated by a recurring backup job." group: "Longhorn Default Settings" type: boolean default: "true" - variable: defaultSettings.concurrentAutomaticEngineUpgradePerNodeLimit label: Concurrent Automatic Engine Upgrade Per Node Limit - description: "This setting controls how Longhorn automatically upgrades volumes' engines to the new default engine image after upgrading Longhorn manager. The value of this setting specifies the maximum number of engines per node that are allowed to upgrade to the default engine image at the same time. If the value is 0, Longhorn will not automatically upgrade volumes' engines to the default version of engine image." + description: "Maximum number of engines that are allowed to concurrently upgrade on each node after Longhorn Manager is upgraded. When the value is \"0\", Longhorn does not automatically upgrade volume engines to the new default engine image version." group: "Longhorn Default Settings" type: int min: 0 default: 0 - variable: defaultSettings.backingImageCleanupWaitInterval label: Backing Image Cleanup Wait Interval - description: "This interval in minutes determines how long Longhorn will wait before cleaning up the backing image file when there is no replica in the disk using it." + description: "Number of minutes that Longhorn waits before cleaning up the backing image file when no replicas in the disk are using it." group: "Longhorn Default Settings" type: int min: 0 default: 60 - variable: defaultSettings.backingImageRecoveryWaitInterval label: Backing Image Recovery Wait Interval - description: "This interval in seconds determines how long Longhorn will wait before re-downloading the backing image file when all disk files of this backing image become failed or unknown." + description: "Number of seconds that Longhorn waits before downloading a backing image file again when the status of all image disk files changes to \"failed\" or \"unknown\"." group: "Longhorn Default Settings" type: int min: 0 default: 300 - variable: defaultSettings.guaranteedInstanceManagerCPU label: Guaranteed Instance Manager CPU - description: "Percentage of the total allocatable CPU resources on each node to be reserved for each instance manager pod when the V1 Data Engine is enabled. The default value is 12 percent." + description: "Percentage of the total allocatable CPU resources on each node to be reserved for each instance manager pod when the V1 Data Engine is enabled. The default value is \"12\". + WARNING: + - Value 0 means removing the CPU requests from spec of instance manager pods. + - Considering the possible number of new instance manager pods in a further system upgrade, this integer value ranges from 0 to 40. + - One more set of instance manager pods may need to be deployed when the Longhorn system is upgraded. If current available CPUs of the nodes are not enough for the new instance manager pods, you need to detach the volumes using the oldest instance manager pods so that Longhorn can clean up the old pods automatically and release the CPU resources. And the new pods with the latest instance manager image will be launched then. + - This global setting will be ignored for a node if the field \"InstanceManagerCPURequest\" on the node is set. + - After this setting is changed, all instance manager pods using this global setting on all the nodes will be automatically restarted. In other words, DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES." group: "Longhorn Default Settings" type: int min: 0 @@ -550,43 +568,47 @@ questions: default: 12 - variable: defaultSettings.logLevel label: Log Level - description: "The log level Panic, Fatal, Error, Warn, Info, Debug, Trace used in longhorn manager. Default to Info." + description: 'Log levels that indicate the type and severity of logs in Longhorn Manager. The default value is "Info". (Options: "Panic", "Fatal", "Error", "Warn", "Info", "Debug", "Trace")' group: "Longhorn Default Settings" type: string default: "Info" - variable: defaultSettings.disableSnapshotPurge label: Disable Snapshot Purge - description: "Temporarily prevent all attempts to purge volume snapshots." + description: "Setting that temporarily prevents all attempts to purge volume snapshots." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.kubernetesClusterAutoscalerEnabled label: Kubernetes Cluster Autoscaler Enabled (Experimental) - description: "Setting that notifies Longhorn that the cluster is using the Kubernetes Cluster Autoscaler." + description: "Setting that notifies Longhorn that the cluster is using the Kubernetes Cluster Autoscaler. + WARNING: + - Replica rebuilding could be expensive because nodes with reusable replicas could get removed by the Kubernetes Cluster Autoscaler." group: "Longhorn Default Settings" type: boolean default: false - variable: defaultSettings.orphanAutoDeletion label: Orphaned Data Cleanup - description: "This setting allows Longhorn to delete the orphan resource and its corresponding orphaned data automatically like stale replicas. Orphan resources on down or unknown nodes will not be cleaned up automatically." + description: "Setting that allows Longhorn to automatically delete an orphaned resource and the corresponding data (for example, stale replicas). Orphaned resources on failed or unknown nodes are not automatically cleaned up." group: "Longhorn Default Settings" type: boolean default: false - variable: defaultSettings.storageNetwork label: Storage Network - description: "Longhorn uses the storage network for in-cluster data traffic. Leave this blank to use the Kubernetes cluster network." + description: "Longhorn uses the storage network for in-cluster data traffic. Leave this blank to use the Kubernetes cluster network. + WARNING: + - This setting should change after detaching all Longhorn volumes, as some of the Longhorn system component pods will get recreated to apply the setting. Longhorn will try to block this setting update when there are attached volumes." group: "Longhorn Default Settings" type: string default: - variable: defaultSettings.deletingConfirmationFlag label: Deleting Confirmation Flag - description: "This flag is designed to prevent Longhorn from being accidentally uninstalled which will lead to data lost." + description: "Flag that prevents accidental uninstallation of Longhorn." group: "Longhorn Default Settings" type: boolean default: "false" - variable: defaultSettings.engineReplicaTimeout label: Timeout between Engine and Replica - description: "In seconds. The setting specifies the timeout between the engine and replica(s), and the value should be between 8 and 30 seconds. The default value is 8 seconds." + description: "Timeout between the Longhorn Engine and replicas. Specify a value between \"8\" and \"30\" seconds. The default value is \"8\"." group: "Longhorn Default Settings" type: int default: "8" @@ -616,7 +638,7 @@ questions: default: "false" - variable: defaultSettings.fastReplicaRebuildEnabled label: Fast Replica Rebuild Enabled - description: "This feature supports the fast replica rebuilding. It relies on the checksum of snapshot disk files, so setting the snapshot-data-integrity to **enable** or **fast-check** is a prerequisite." + description: "Setting that allows fast rebuilding of replicas using the checksum of snapshot disk files. Before enabling this setting, you must set the snapshot-data-integrity value to \"enable\" or \"fast-check\"." group: "Longhorn Default Settings" type: boolean default: false @@ -628,13 +650,13 @@ questions: default: "30" - variable: defaultSettings.backupCompressionMethod label: Backup Compression Method - description: "This setting allows users to specify backup compression method." + description: "Setting that allows you to specify a backup compression method." group: "Longhorn Default Settings" type: string default: "lz4" - variable: defaultSettings.backupConcurrentLimit label: Backup Concurrent Limit Per Backup - description: "This setting controls how many worker threads per backup concurrently." + description: "Maximum number of worker threads that can concurrently run for each backup." group: "Longhorn Default Settings" type: int min: 1 @@ -648,7 +670,7 @@ questions: default: 2 - variable: defaultSettings.allowCollectingLonghornUsageMetrics label: Allow Collecting Longhorn Usage Metrics - description: "Enabling this setting will allow Longhorn to provide additional usage metrics to https://metrics.longhorn.io/. This information will help us better understand how Longhorn is being used, which will ultimately contribute to future improvements." + description: "Setting that allows Longhorn to periodically collect anonymous usage data for product improvement purposes. Longhorn sends collected data to the [Upgrade Responder](https://github.com/longhorn/upgrade-responder) server, which is the data source of the Longhorn Public Metrics Dashboard (https://metrics.longhorn.io). The Upgrade Responder server does not store data that can be used to identify clients, including IP addresses." group: "Longhorn Default Settings" type: boolean default: true @@ -660,7 +682,10 @@ questions: default: true - variable: defaultSettings.v2DataEngine label: V2 Data Engine - description: "This allows users to activate v2 data engine based on SPDK. Currently, it is in the preview phase and should not be utilized in a production environment." + description: "Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. + WARNING: + - DO NOT CHANGE THIS SETTING WITH ATTACHED VOLUMES. Longhorn will block this setting update when there are attached volumes. + - When the V2 Data Engine is enabled, each instance-manager pod utilizes 1 CPU core. This high CPU usage is attributed to the spdk_tgt process running within each instance-manager pod. The spdk_tgt process is responsible for handling input/output (IO) operations and requires intensive polling. As a result, it consumes 100% of a dedicated CPU core to efficiently manage and process the IO requests, ensuring optimal performance and responsiveness for storage operations." group: "Longhorn V2 Data Engine (Preview Feature) Settings" type: boolean default: false @@ -672,7 +697,7 @@ questions: default: "2048" - variable: defaultSettings.offlineReplicaRebuilding label: Offline Replica Rebuilding - description: "This setting allows users to enable the offline replica rebuilding for volumes using v2 data engine." + description: "Setting that allows rebuilding of offline replicas for volumes using the V2 Data Engine." group: "Longhorn V2 Data Engine (Preview Feature) Settings" required: true type: enum @@ -682,14 +707,14 @@ questions: default: "enabled" - variable: persistence.defaultClass default: "true" - description: "Set as default StorageClass for Longhorn" + description: "Setting that allows you to specify the default Longhorn StorageClass." label: Default Storage Class group: "Longhorn Storage Class Settings" required: true type: boolean - variable: persistence.reclaimPolicy label: Storage Class Retain Policy - description: "Define reclaim policy. Options: `Retain`, `Delete`" + description: "Reclaim policy that provides instructions for handling of a volume after its claim is released. (Options: \"Retain\", \"Delete\")" group: "Longhorn Storage Class Settings" required: true type: enum @@ -698,7 +723,7 @@ questions: - "Retain" default: "Delete" - variable: persistence.defaultClassReplicaCount - description: "Set replica count for Longhorn StorageClass" + description: "Replica count of the default Longhorn StorageClass." label: Default Storage Class Replica Count group: "Longhorn Storage Class Settings" type: int @@ -706,7 +731,7 @@ questions: max: 10 default: 3 - variable: persistence.defaultDataLocality - description: "Set data locality for Longhorn StorageClass. Options: `disabled`, `best-effort`" + description: "Data locality of the default Longhorn StorageClass. (Options: \"disabled\", \"best-effort\")" label: Default Storage Class Data Locality group: "Longhorn Storage Class Settings" type: enum @@ -715,7 +740,7 @@ questions: - "best-effort" default: "disabled" - variable: persistence.recurringJobSelector.enable - description: "Enable recurring job selector for Longhorn StorageClass" + description: "Setting that allows you to enable the recurring job selector for a Longhorn StorageClass." group: "Longhorn Storage Class Settings" label: Enable Storage Class Recurring Job Selector type: boolean @@ -723,13 +748,13 @@ questions: show_subquestion_if: true subquestions: - variable: persistence.recurringJobSelector.jobList - description: 'Recurring job selector list for Longhorn StorageClass. Please be careful of quotes of input. E.g., [{"name":"backup", "isGroup":true}]' + description: 'Recurring job selector for a Longhorn StorageClass. Ensure that quotes are used correctly when specifying job parameters. (Example: `[{"name":"backup", "isGroup":true}]`)' label: Storage Class Recurring Job Selector List group: "Longhorn Storage Class Settings" type: string default: - variable: persistence.defaultNodeSelector.enable - description: "Enable Node selector for Longhorn StorageClass" + description: "Setting that allows you to enable the node selector for the default Longhorn StorageClass." group: "Longhorn Storage Class Settings" label: Enable Storage Class Node Selector type: boolean @@ -738,12 +763,12 @@ questions: subquestions: - variable: persistence.defaultNodeSelector.selector label: Storage Class Node Selector - description: 'This selector enables only certain nodes having these tags to be used for the volume. E.g. `"storage,fast"`' + description: 'Node selector for the default Longhorn StorageClass. Longhorn uses only nodes with the specified tags for storing volume data. (Examples: "storage,fast")' group: "Longhorn Storage Class Settings" type: string default: - variable: persistence.backingImage.enable - description: "Set backing image for Longhorn StorageClass" + description: "Setting that allows you to use a backing image in a Longhorn StorageClass." group: "Longhorn Storage Class Settings" label: Default Storage Class Backing Image type: boolean @@ -751,13 +776,13 @@ questions: show_subquestion_if: true subquestions: - variable: persistence.backingImage.name - description: 'Specify a backing image that will be used by Longhorn volumes in Longhorn StorageClass. If not exists, the backing image data source type and backing image data source parameters should be specified so that Longhorn will create the backing image before using it.' + description: 'Backing image to be used for creating and restoring volumes in a Longhorn StorageClass. When no backing images are available, specify the data source type and parameters that Longhorn can use to create a backing image.' label: Storage Class Backing Image Name group: "Longhorn Storage Class Settings" type: string default: - variable: persistence.backingImage.expectedChecksum - description: 'Specify the expected SHA512 checksum of the selected backing image in Longhorn StorageClass. + description: 'Expected SHA-512 checksum of a backing image used in a Longhorn StorageClass. WARNING: - If the backing image name is not specified, setting this field is meaningless. - It is not recommended to set this field if the data source type is \"export-from-volume\".' @@ -766,8 +791,7 @@ questions: type: string default: - variable: persistence.backingImage.dataSourceType - description: 'Specify the data source type for the backing image used in Longhorn StorageClass. - If the backing image does not exists, Longhorn will use this field to create a backing image. Otherwise, Longhorn will use it to verify the selected backing image. + description: 'Data source type of a backing image used in a Longhorn StorageClass. If the backing image exists in the cluster, Longhorn uses this setting to verify the image. If the backing image does not exist, Longhorn creates one using the specified data source type. WARNING: - If the backing image name is not specified, setting this field is meaningless. - As for backing image creation with data source type \"upload\", it is recommended to do it via UI rather than StorageClass here. Uploading requires file data sending to the Longhorn backend after the object creation, which is complicated if you want to handle it manually.' @@ -781,9 +805,7 @@ questions: - "export-from-volume" default: "" - variable: persistence.backingImage.dataSourceParameters - description: "Specify the data source parameters for the backing image used in Longhorn StorageClass. - If the backing image does not exists, Longhorn will use this field to create a backing image. Otherwise, Longhorn will use it to verify the selected backing image. - This option accepts a json string of a map. E.g., '{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'. + description: "Data source parameters of a backing image used in a Longhorn StorageClass. You can specify a JSON string of a map. (Example: `'{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'`) WARNING: - If the backing image name is not specified, setting this field is meaningless. - Be careful of the quotes here." @@ -792,7 +814,7 @@ questions: type: string default: - variable: persistence.removeSnapshotsDuringFilesystemTrim - description: "Allow automatically removing snapshots during filesystem trim for Longhorn StorageClass. Options: `ignored`, `enabled`, `disabled`" + description: "Setting that allows you to enable automatic snapshot removal during filesystem trim for a Longhorn StorageClass. (Options: \"ignored\", \"enabled\", \"disabled\")" label: Default Storage Class Remove Snapshots During Filesystem Trim group: "Longhorn Storage Class Settings" type: enum @@ -811,19 +833,19 @@ questions: subquestions: - variable: ingress.host default: "xip.io" - description: "layer 7 Load Balancer hostname" + description: "Hostname of the Layer 7 load balancer." type: hostname required: true label: Layer 7 Load Balancer Hostname - variable: ingress.path default: "/" - description: "If ingress is enabled you can set the default ingress path" + description: "Default ingress path. You can access the Longhorn UI by following the full ingress path {{host}}+{{path}}." type: string required: true label: Ingress Path - variable: service.ui.type default: "Rancher-Proxy" - description: "Define the Longhorn UI service type. Options: `ClusterIP`, `NodePort`, `LoadBalancer`, `Rancher-Proxy`" + description: "Service type for Longhorn UI. (Options: \"ClusterIP\", \"NodePort\", \"LoadBalancer\", \"Rancher-Proxy\")" type: enum options: - "ClusterIP" @@ -837,7 +859,7 @@ questions: subquestions: - variable: service.ui.nodePort default: "" - description: "NodePort port number(to set explicitly, chooses port between 30000-32767)" + description: "NodePort port number for Longhorn UI. When unspecified, Longhorn selects a free port between 30000 and 32767." type: int min: 30000 max: 32767 @@ -845,18 +867,18 @@ questions: label: UI Service NodePort number - variable: enablePSP default: "false" - description: "Setup a pod security policy for Longhorn workloads." + description: "Setting that allows you to enable pod security policies (PSPs) that allow privileged Longhorn pods to start. This setting applies only to clusters running Kubernetes 1.25 and earlier, and with the built-in Pod Security admission controller enabled." label: Pod Security Policy type: boolean group: "Other Settings" - variable: global.cattle.windowsCluster.enabled default: "false" - description: "Enable this to allow Longhorn to run on the Rancher-deployed Windows cluster." + description: "Setting that allows Longhorn to run on a Rancher Windows cluster." label: Rancher Windows Cluster type: boolean group: "Other Settings" - variable: networkPolicies.enabled - description: "Enable NetworkPolicies to limit access to the longhorn pods. + description: "Setting that allows you to enable network policies that control access to Longhorn pods. Warning: The Rancher Proxy will not work if this feature is enabled and a custom NetworkPolicy must be added." group: "Other Settings" label: Network Policies @@ -865,7 +887,7 @@ questions: subquestions: - variable: networkPolicies.type label: Network Policies for Ingress - description: "Create the policy based on your distribution to allow access for the ingress. Options: `k3s`, `rke2`, `rke1`" + description: "Distribution that determines the policy for allowing access for an ingress. (Options: \"k3s\", \"rke2\", \"rke1\")" show_if: "networkPolicies.enabled=true&&ingress.enabled=true" type: enum default: "rke2" @@ -875,8 +897,11 @@ questions: - "k3s" - variable: defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU label: Guaranteed Instance Manager CPU for V2 Data Engine - description: "Number of millicpus on each node to be reserved for each instance manager pod when the V2 Data Engine is enabled. By default, the Storage Performance Development Kit (SPDK) target daemon within each instance manager pod uses 1 CPU core. Configuring a minimum CPU usage value is essential for maintaining engine and replica stability, especially during periods of high node workload. The default value is 1250 millicpus." - group: "Longhorn Default Settings" + description: 'Number of millicpus on each node to be reserved for each Instance Manager pod when the V2 Data Engine is enabled. The default value is "1250". + WARNING: + - Specifying a value of 0 disables CPU requests for instance manager pods. You must specify an integer between 1000 and 8000. + - This is a global setting. Modifying the value triggers an automatic restart of the instance manager pods. Do not modify the value while volumes are still attached." + group: "Longhorn Default Settings' type: int min: 1000 max: 8000 diff --git a/chart/templates/_helpers.tpl b/chart/templates/_helpers.tpl index a5c7f4bcb4..3fbc2ac02f 100644 --- a/chart/templates/_helpers.tpl +++ b/chart/templates/_helpers.tpl @@ -58,5 +58,9 @@ app.kubernetes.io/version: {{ .Chart.AppVersion }} define the longhorn release namespace */ -}} {{- define "release_namespace" -}} +{{- if .Values.namespaceOverride -}} +{{- .Values.namespaceOverride -}} +{{- else -}} {{- .Release.Namespace -}} {{- end -}} +{{- end -}} diff --git a/chart/templates/crds.yaml b/chart/templates/crds.yaml index 7c16301ccd..47d07b69f7 100644 --- a/chart/templates/crds.yaml +++ b/chart/templates/crds.yaml @@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -44,10 +44,19 @@ spec: description: BackingImageDataSource is where Longhorn stores backing image data source 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 @@ -94,10 +103,19 @@ spec: description: BackingImageDataSource is where Longhorn stores backing image data source 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 @@ -159,18 +177,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -216,10 +228,19 @@ spec: description: BackingImageManager is where Longhorn stores backing image manager 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 @@ -262,10 +283,19 @@ spec: description: BackingImageManager is where Longhorn stores backing image manager 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 @@ -314,6 +344,9 @@ spec: type: string uuid: type: string + virtualSize: + format: int64 + type: integer type: object nullable: true type: object @@ -331,18 +364,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -384,10 +411,19 @@ spec: description: BackingImage is where Longhorn stores backing image 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 @@ -413,6 +449,10 @@ spec: jsonPath: .status.size name: Size type: string + - description: The virtual size of the image (may be larger than file size) + jsonPath: .status.virtualSize + name: VirtualSize + type: string - jsonPath: .metadata.creationTimestamp name: Age type: date @@ -422,10 +462,19 @@ spec: description: BackingImage is where Longhorn stores backing image 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 @@ -481,24 +530,22 @@ spec: type: integer uuid: type: string + virtualSize: + description: Virtual size of image, which may be larger than physical size. Will be zero until known (e.g. while a backing image is uploading) + format: int64 + type: integer type: object type: object served: true storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: longhorn-manager: "" @@ -541,10 +588,19 @@ spec: description: BackupBackingImage is where Longhorn stores backing image backup 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 @@ -562,7 +618,9 @@ spec: nullable: true type: string userCreated: - description: Is this CR created by user through API or UI. Required + description: |- + Is this CR created by user through API or UI. + Required type: boolean required: - userCreated @@ -616,7 +674,9 @@ spec: format: int64 type: integer state: - description: The backing image backup creation state. Can be "", "InProgress", "Completed", "Error", "Unknown". + description: |- + The backing image backup creation state. + Can be "", "InProgress", "Completed", "Error", "Unknown". type: string url: description: The backing image backup URL. @@ -627,18 +687,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -681,10 +735,19 @@ spec: description: Backup is where Longhorn stores backup 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 @@ -724,10 +787,19 @@ spec: description: Backup is where Longhorn stores backup 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 @@ -796,7 +868,9 @@ spec: description: The snapshot name. type: string state: - description: The backup creation state. Can be "", "InProgress", "Completed", "Error", "Unknown". + description: |- + The backup creation state. + Can be "", "InProgress", "Completed", "Error", "Unknown". type: string url: description: The snapshot backup URL. @@ -819,18 +893,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -885,10 +953,19 @@ spec: description: BackupTarget is where Longhorn stores backup target 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 @@ -928,10 +1005,19 @@ spec: description: BackupTarget is where Longhorn stores backup target 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 @@ -976,7 +1062,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -998,18 +1086,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -1048,10 +1130,19 @@ spec: description: BackupVolume is where Longhorn stores backup volume 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 @@ -1087,10 +1178,19 @@ spec: description: BackupVolume is where Longhorn stores backup volume 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 @@ -1161,18 +1261,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -1227,10 +1321,19 @@ spec: description: EngineImage is where Longhorn stores engine image 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 @@ -1244,6 +1347,10 @@ spec: subresources: status: {} - additionalPrinterColumns: + - description: Compatibility of the engine image + jsonPath: .status.incompatible + name: Incompatible + type: boolean - description: State of the engine image jsonPath: .status.state name: State @@ -1269,10 +1376,19 @@ spec: description: EngineImage is where Longhorn stores engine image 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 @@ -1310,7 +1426,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -1351,19 +1469,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" name: engines.longhorn.io @@ -1376,6 +1487,7 @@ spec: shortNames: - lhe singular: engine + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -1404,10 +1516,19 @@ spec: description: Engine is where Longhorn stores engine 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 @@ -1450,10 +1571,19 @@ spec: description: Engine is where Longhorn stores engine 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 @@ -1463,7 +1593,7 @@ spec: active: type: boolean backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string backupVolume: type: string @@ -1576,7 +1706,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -1651,6 +1783,14 @@ spec: type: string nullable: true type: object + replicaTransitionTimeMap: + additionalProperties: + type: string + description: |- + ReplicaTransitionTimeMap records the time a replica in ReplicaModeMap transitions from one mode to another (or + from not being in the ReplicaModeMap to being in it). This information is sometimes required by other controllers + (e.g. the volume controller uses it to determine the correct value for replica.Spec.lastHealthyAt). + type: object restoreStatus: additionalProperties: properties: @@ -1722,19 +1862,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" name: instancemanagers.longhorn.io @@ -1747,6 +1880,7 @@ spec: shortNames: - lhim singular: instancemanager + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -1771,10 +1905,19 @@ spec: description: InstanceManager is where Longhorn stores instance manager 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 @@ -1813,10 +1956,19 @@ spec: description: InstanceManager is where Longhorn stores instance manager 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 @@ -1843,10 +1995,6 @@ spec: type: integer apiVersion: type: integer - proxyApiMinVersion: - type: integer - proxyApiVersion: - type: integer currentState: type: string instanceEngines: @@ -1855,7 +2003,7 @@ spec: spec: properties: backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string dataEngine: type: string @@ -1867,6 +2015,7 @@ spec: conditions: additionalProperties: type: boolean + nullable: true type: object endpoint: type: string @@ -1897,7 +2046,7 @@ spec: spec: properties: backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string dataEngine: type: string @@ -1909,6 +2058,7 @@ spec: conditions: additionalProperties: type: boolean + nullable: true type: object endpoint: type: string @@ -1939,7 +2089,7 @@ spec: spec: properties: backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string dataEngine: type: string @@ -1951,6 +2101,7 @@ spec: conditions: additionalProperties: type: boolean + nullable: true type: object endpoint: type: string @@ -1973,31 +2124,29 @@ spec: type: string type: object type: object - nullable: true description: 'Deprecated: Replaced by InstanceEngines and InstanceReplicas' + nullable: true type: object ip: type: string ownerID: type: string + proxyApiMinVersion: + type: integer + proxyApiVersion: + type: integer type: object type: object served: true storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -2048,10 +2197,19 @@ spec: description: Node is where Longhorn stores Longhorn 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 @@ -2086,10 +2244,19 @@ spec: description: Node is where Longhorn stores Longhorn 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 @@ -2097,7 +2264,6 @@ spec: description: NodeSpec defines the desired state of the Longhorn node properties: allowScheduling: - description: Allow scheduling replicas on the node. type: boolean disks: additionalProperties: @@ -2154,7 +2320,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2181,7 +2349,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2211,21 +2381,17 @@ spec: format: int64 type: integer type: object - description: The status of the disks on the node. nullable: true type: object region: - description: The Region of the node. type: string snapshotCheckStatus: - description: The status of the snapshot integrity check. properties: lastPeriodicCheckedAt: format: date-time type: string type: object zone: - description: The Zone of the node. type: string type: object type: object @@ -2233,18 +2399,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -2275,10 +2435,19 @@ spec: description: Orphan is where Longhorn stores orphan 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 @@ -2289,7 +2458,9 @@ spec: description: The node ID on which the controller is responsible to reconcile this orphan CR. type: string orphanType: - description: The type of the orphaned data. Can be "replica". + description: |- + The type of the orphaned data. + Can be "replica". type: string parameters: additionalProperties: @@ -2316,7 +2487,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2332,18 +2505,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: longhorn-manager: "" @@ -2393,10 +2560,19 @@ spec: description: RecurringJob is where Longhorn stores recurring job 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 @@ -2443,10 +2619,19 @@ spec: description: RecurringJob is where Longhorn stores recurring job 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 @@ -2476,7 +2661,9 @@ spec: description: The retain count of the snapshot/backup. type: integer task: - description: The recurring job task. Can be "snapshot", "snapshot-force-create", "snapshot-cleanup", "snapshot-delete", "backup", "backup-force-create" or "filesystem-trim" + description: |- + The recurring job task. + Can be "snapshot", "snapshot-force-create", "snapshot-cleanup", "snapshot-delete", "backup", "backup-force-create" or "filesystem-trim" enum: - snapshot - snapshot-force-create @@ -2499,19 +2686,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" name: replicas.longhorn.io @@ -2524,6 +2704,7 @@ spec: shortNames: - lhr singular: replica + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -2556,10 +2737,19 @@ spec: description: Replica is where Longhorn stores replica 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 @@ -2606,10 +2796,19 @@ spec: description: Replica is where Longhorn stores replica 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 @@ -2619,7 +2818,7 @@ spec: active: type: boolean backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string backingImage: type: string @@ -2644,13 +2843,44 @@ spec: evictionRequested: type: boolean failedAt: + description: |- + FailedAt is set when a running replica fails or when a running engine is unable to use a replica for any reason. + FailedAt indicates the time the failure occurred. When FailedAt is set, a replica is likely to have useful + (though possibly stale) data. A replica with FailedAt set must be rebuilt from a non-failed replica (or it can + be used in a salvage if all replicas are failed). FailedAt is cleared before a rebuild or salvage. FailedAt may + be later than the corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume + controller acknowledges the change. type: string hardNodeAffinity: type: string healthyAt: + description: |- + HealthyAt is set the first time a replica becomes read/write in an engine after creation or rebuild. HealthyAt + indicates the time the last successful rebuild occurred. When HealthyAt is set, a replica is likely to have + useful (though possibly stale) data. HealthyAt is cleared before a rebuild. HealthyAt may be later than the + corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume controller + acknowledges the change. type: string image: type: string + lastFailedAt: + description: |- + LastFailedAt is always set at the same time as FailedAt. Unlike FailedAt, LastFailedAt is never cleared. + LastFailedAt is not a reliable indicator of the state of a replica's data. For example, a replica with + LastFailedAt may already be healthy and in use again. However, because it is never cleared, it can be compared to + LastHealthyAt to help prevent dangerous replica deletion in some corner cases. LastFailedAt may be later than the + corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume controller + acknowledges the change. + type: string + lastHealthyAt: + description: |- + LastHealthyAt is set every time a replica becomes read/write in an engine. Unlike HealthyAt, LastHealthyAt is + never cleared. LastHealthyAt is not a reliable indicator of the state of a replica's data. For example, a + replica with LastHealthyAt set may be in the middle of a rebuild. However, because it is never cleared, it can be + compared to LastFailedAt to help prevent dangerous replica deletion in some corner cases. LastHealthyAt may be + later than the corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume + controller acknowledges the change. + type: string logRequested: type: boolean nodeID: @@ -2693,7 +2923,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2730,19 +2962,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" name: settings.longhorn.io @@ -2755,6 +2980,7 @@ spec: shortNames: - lhs singular: setting + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -2771,10 +2997,19 @@ spec: description: Setting is where Longhorn stores setting 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 @@ -2801,10 +3036,19 @@ spec: description: Setting is where Longhorn stores setting 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 @@ -2818,18 +3062,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -2863,10 +3101,19 @@ spec: description: ShareManager is where Longhorn stores share manager 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 @@ -2897,10 +3144,19 @@ spec: description: ShareManager is where Longhorn stores share manager 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 @@ -2929,18 +3185,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -2986,10 +3236,19 @@ spec: description: Snapshot is the Schema for the snapshots API 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 @@ -3006,7 +3265,10 @@ spec: nullable: true type: object volume: - description: the volume that this snapshot belongs to. This field is immutable after creation. Required + description: |- + the volume that this snapshot belongs to. + This field is immutable after creation. + Required type: string required: - volume @@ -3052,18 +3314,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -3101,10 +3357,19 @@ spec: description: SupportBundle is where Longhorn stores support bundle 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 @@ -3143,7 +3408,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3174,18 +3441,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -3224,10 +3485,19 @@ spec: description: SystemBackup is where Longhorn stores system backup 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 @@ -3235,7 +3505,9 @@ spec: description: SystemBackupSpec defines the desired state of the Longhorn SystemBackup properties: volumeBackupPolicy: - description: The create volume backup policy Can be "if-not-present", "always" or "disabled" + description: |- + The create volume backup policy + Can be "if-not-present", "always" or "disabled" nullable: true type: string type: object @@ -3258,7 +3530,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3298,18 +3572,12 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" @@ -3339,10 +3607,19 @@ spec: description: SystemRestore is where Longhorn stores system restore 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 @@ -3374,7 +3651,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3397,18 +3676,148 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 + creationTimestamp: null + labels: {{- include "longhorn.labels" . | nindent 4 }} + longhorn-manager: "" + name: volumeattachments.longhorn.io +spec: + group: longhorn.io + names: + kind: VolumeAttachment + listKind: VolumeAttachmentList + plural: volumeattachments + shortNames: + - lhva + singular: volumeattachment + scope: Namespaced + versions: + - additionalPrinterColumns: + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1beta2 + schema: + openAPIV3Schema: + description: VolumeAttachment stores attachment information of a Longhorn volume + properties: + apiVersion: + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + type: string + kind: + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + type: string + metadata: + type: object + spec: + description: VolumeAttachmentSpec defines the desired state of Longhorn VolumeAttachment + properties: + attachmentTickets: + additionalProperties: + properties: + generation: + description: |- + A sequence number representing a specific generation of the desired state. + Populated by the system. Read-only. + format: int64 + type: integer + id: + description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. + type: string + nodeID: + description: The node that this attachment is requesting + type: string + parameters: + additionalProperties: + type: string + description: Optional additional parameter for this attachment + type: object + type: + type: string + type: object + type: object + volume: + description: The name of Longhorn volume of this VolumeAttachment + type: string + required: + - volume + type: object + status: + description: VolumeAttachmentStatus defines the observed state of Longhorn VolumeAttachment + properties: + attachmentTicketStatuses: + additionalProperties: + properties: + conditions: + description: Record any error when trying to fulfill this attachment + items: + properties: + lastProbeTime: + description: Last time we probed the condition. + type: string + lastTransitionTime: + description: Last time the condition transitioned from one status to another. + type: string + message: + description: Human-readable message indicating details about last transition. + type: string + reason: + description: Unique, one-word, CamelCase reason for the condition's last transition. + type: string + status: + description: |- + Status is the status of the condition. + Can be True, False, Unknown. + type: string + type: + description: Type is the type of the condition. + type: string + type: object + nullable: true + type: array + generation: + description: |- + A sequence number representing a specific generation of the desired state. + Populated by the system. Read-only. + format: int64 + type: integer + id: + description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. + type: string + satisfied: + description: Indicate whether this attachment ticket has been satisfied + type: boolean + required: + - conditions + - satisfied + type: object + type: object + type: object + type: object + served: true + storage: true + subresources: + status: {} +--- +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.15.0 labels: {{- include "longhorn.labels" . | nindent 4 }} longhorn-manager: "" name: volumes.longhorn.io @@ -3466,10 +3875,19 @@ spec: description: Volume is where Longhorn stores volume 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 @@ -3516,10 +3934,19 @@ spec: description: Volume is where Longhorn stores volume 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 @@ -3534,7 +3961,7 @@ spec: - rwx type: string backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`.' type: string backingImage: type: string @@ -3691,7 +4118,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3776,136 +4205,4 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null - labels: {{- include "longhorn.labels" . | nindent 4 }} - longhorn-manager: "" - name: volumeattachments.longhorn.io -spec: - group: longhorn.io - names: - kind: VolumeAttachment - listKind: VolumeAttachmentList - plural: volumeattachments - shortNames: - - lhva - singular: volumeattachment - scope: Namespaced - versions: - - additionalPrinterColumns: - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta2 - schema: - openAPIV3Schema: - description: VolumeAttachment stores attachment information of a Longhorn volume - properties: - apiVersion: - description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' - type: string - kind: - description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - metadata: - type: object - spec: - description: VolumeAttachmentSpec defines the desired state of Longhorn VolumeAttachment - properties: - attachmentTickets: - additionalProperties: - properties: - generation: - description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - format: int64 - type: integer - id: - description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. - type: string - nodeID: - description: The node that this attachment is requesting - type: string - parameters: - additionalProperties: - type: string - description: Optional additional parameter for this attachment - type: object - type: - type: string - type: object - type: object - volume: - description: The name of Longhorn volume of this VolumeAttachment - type: string - required: - - volume - type: object - status: - description: VolumeAttachmentStatus defines the observed state of Longhorn VolumeAttachment - properties: - attachmentTicketStatuses: - additionalProperties: - properties: - conditions: - description: Record any error when trying to fulfill this attachment - items: - properties: - lastProbeTime: - description: Last time we probed the condition. - type: string - lastTransitionTime: - description: Last time the condition transitioned from one status to another. - type: string - message: - description: Human-readable message indicating details about last transition. - type: string - reason: - description: Unique, one-word, CamelCase reason for the condition's last transition. - type: string - status: - description: Status is the status of the condition. Can be True, False, Unknown. - type: string - type: - description: Type is the type of the condition. - type: string - type: object - nullable: true - type: array - generation: - description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - format: int64 - type: integer - id: - description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. - type: string - satisfied: - description: Indicate whether this attachment ticket has been satisfied - type: boolean - required: - - conditions - - satisfied - type: object - type: object - type: object - type: object - served: true - storage: true - subresources: - status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] + diff --git a/chart/templates/daemonset-sa.yaml b/chart/templates/daemonset-sa.yaml index cb0714747c..bbcd59fd1e 100644 --- a/chart/templates/daemonset-sa.yaml +++ b/chart/templates/daemonset-sa.yaml @@ -120,22 +120,22 @@ spec: {{- if .Values.longhornManager.priorityClass }} priorityClassName: {{ .Values.longhornManager.priorityClass | quote }} {{- end }} - {{- if or .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} tolerations: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.tolerations }} {{ toYaml .Values.global.cattle.windowsCluster.tolerations | indent 6 }} {{- end }} - {{- if .Values.longhornManager.tolerations }} -{{ toYaml .Values.longhornManager.tolerations | indent 6 }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations }} +{{ default .Values.global.tolerations .Values.longhornManager.tolerations | toYaml | indent 6 }} {{- end }} {{- end }} - {{- if or .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} nodeSelector: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.nodeSelector }} {{ toYaml .Values.global.cattle.windowsCluster.nodeSelector | indent 8 }} {{- end }} - {{- if .Values.longhornManager.nodeSelector }} -{{ toYaml .Values.longhornManager.nodeSelector | indent 8 }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector }} +{{ default .Values.global.nodeSelector .Values.longhornManager.nodeSelector | toYaml | indent 8 }} {{- end }} {{- end }} serviceAccountName: longhorn-service-account @@ -156,7 +156,6 @@ metadata: {{- end }} spec: type: {{ .Values.service.manager.type }} - sessionAffinity: ClientIP selector: app: longhorn-manager ports: diff --git a/chart/templates/default-setting.yaml b/chart/templates/default-setting.yaml index 112873595b..5261f7fef8 100644 --- a/chart/templates/default-setting.yaml +++ b/chart/templates/default-setting.yaml @@ -223,4 +223,7 @@ data: {{- end }} {{- if not (kindIs "invalid" .Values.defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU) }} v2-data-engine-guaranteed-instance-manager-cpu: {{ .Values.defaultSettings.v2DataEngineGuaranteedInstanceManagerCPU }} + {{- end }} + {{- if not (kindIs "invalid" .Values.defaultSettings.snapshotMaxCount) }} + snapshot-max-count: {{ .Values.defaultSettings.snapshotMaxCount }} {{- end }} \ No newline at end of file diff --git a/chart/templates/deployment-driver.yaml b/chart/templates/deployment-driver.yaml index cd2ab3a344..5683c759e7 100644 --- a/chart/templates/deployment-driver.yaml +++ b/chart/templates/deployment-driver.yaml @@ -25,6 +25,9 @@ spec: command: - longhorn-manager - -d + {{- if eq .Values.longhornDriver.log.format "json" }} + - -j + {{- end }} - deploy-driver - --manager-image - "{{ template "registry_url" . }}{{ .Values.image.longhorn.manager.repository }}:{{ .Values.image.longhorn.manager.tag }}" @@ -102,22 +105,22 @@ spec: {{- if .Values.longhornDriver.priorityClass }} priorityClassName: {{ .Values.longhornDriver.priorityClass | quote }} {{- end }} - {{- if or .Values.longhornDriver.tolerations .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.tolerations .Values.longhornDriver.tolerations .Values.global.cattle.windowsCluster.enabled }} tolerations: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.tolerations }} {{ toYaml .Values.global.cattle.windowsCluster.tolerations | indent 6 }} {{- end }} - {{- if .Values.longhornDriver.tolerations }} -{{ toYaml .Values.longhornDriver.tolerations | indent 6 }} + {{- if or .Values.global.tolerations .Values.longhornDriver.tolerations }} +{{ default .Values.global.tolerations .Values.longhornDriver.tolerations | toYaml | indent 6 }} {{- end }} {{- end }} - {{- if or .Values.longhornDriver.nodeSelector .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.nodeSelector .Values.longhornDriver.nodeSelector .Values.global.cattle.windowsCluster.enabled }} nodeSelector: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.nodeSelector }} {{ toYaml .Values.global.cattle.windowsCluster.nodeSelector | indent 8 }} {{- end }} - {{- if .Values.longhornDriver.nodeSelector }} -{{ toYaml .Values.longhornDriver.nodeSelector | indent 8 }} + {{- if or .Values.global.nodeSelector .Values.longhornDriver.nodeSelector }} +{{ default .Values.global.nodeSelector .Values.longhornDriver.nodeSelector | toYaml | indent 8 }} {{- end }} {{- end }} serviceAccountName: longhorn-service-account diff --git a/chart/templates/deployment-ui.yaml b/chart/templates/deployment-ui.yaml index 0ee86c7904..e4f3e0f8f7 100644 --- a/chart/templates/deployment-ui.yaml +++ b/chart/templates/deployment-ui.yaml @@ -70,7 +70,11 @@ spec: {{- if .Values.openshift.enabled }} {{- if .Values.openshift.ui.route }} - name: oauth-proxy + {{- if .Values.image.openshift.oauthProxy.repository }} image: {{ template "registry_url" . }}{{ .Values.image.openshift.oauthProxy.repository }}:{{ .Values.image.openshift.oauthProxy.tag }} + {{- else }} + image: "" + {{- end }} imagePullPolicy: IfNotPresent ports: - containerPort: {{ .Values.openshift.ui.proxy | default 8443 }} @@ -128,22 +132,22 @@ spec: {{- if .Values.longhornUI.priorityClass }} priorityClassName: {{ .Values.longhornUI.priorityClass | quote }} {{- end }} - {{- if or .Values.longhornUI.tolerations .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.tolerations .Values.longhornUI.tolerations .Values.global.cattle.windowsCluster.enabled }} tolerations: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.tolerations }} {{ toYaml .Values.global.cattle.windowsCluster.tolerations | indent 6 }} {{- end }} - {{- if .Values.longhornUI.tolerations }} -{{ toYaml .Values.longhornUI.tolerations | indent 6 }} + {{- if or .Values.global.tolerations .Values.longhornUI.tolerations }} +{{ default .Values.global.tolerations .Values.longhornUI.tolerations | toYaml | indent 6 }} {{- end }} {{- end }} - {{- if or .Values.longhornUI.nodeSelector .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.nodeSelector .Values.longhornUI.nodeSelector .Values.global.cattle.windowsCluster.enabled }} nodeSelector: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.nodeSelector }} {{ toYaml .Values.global.cattle.windowsCluster.nodeSelector | indent 8 }} {{- end }} - {{- if .Values.longhornUI.nodeSelector }} -{{ toYaml .Values.longhornUI.nodeSelector | indent 8 }} + {{- if or .Values.global.nodeSelector .Values.longhornUI.nodeSelector }} +{{ default .Values.global.nodeSelector .Values.longhornUI.nodeSelector | toYaml | indent 8 }} {{- end }} {{- end }} --- diff --git a/chart/templates/ingress.yaml b/chart/templates/ingress.yaml index ee47f8b8d9..9038ff0cc1 100644 --- a/chart/templates/ingress.yaml +++ b/chart/templates/ingress.yaml @@ -1,9 +1,5 @@ {{- if .Values.ingress.enabled }} -{{- if semverCompare ">=1.19-0" .Capabilities.KubeVersion.GitVersion -}} apiVersion: networking.k8s.io/v1 -{{- else -}} -apiVersion: networking.k8s.io/v1beta1 -{{- end }} kind: Ingress metadata: name: longhorn-ingress @@ -18,7 +14,7 @@ metadata: {{ $key }}: {{ $value | quote }} {{- end }} spec: - {{- if and .Values.ingress.ingressClassName (semverCompare ">=1.18-0" .Capabilities.KubeVersion.GitVersion) }} + {{- if .Values.ingress.ingressClassName }} ingressClassName: {{ .Values.ingress.ingressClassName }} {{- end }} rules: @@ -26,19 +22,12 @@ spec: http: paths: - path: {{ default "" .Values.ingress.path }} - {{- if (semverCompare ">=1.18-0" $.Capabilities.KubeVersion.GitVersion) }} pathType: ImplementationSpecific - {{- end }} backend: - {{- if semverCompare ">=1.19-0" $.Capabilities.KubeVersion.GitVersion }} service: name: longhorn-frontend port: number: 80 - {{- else }} - serviceName: longhorn-frontend - servicePort: 80 - {{- end }} {{- if .Values.ingress.tls }} tls: - hosts: diff --git a/chart/templates/postupgrade-job.yaml b/chart/templates/postupgrade-job.yaml index bb25a54d4e..56efd38e9b 100644 --- a/chart/templates/postupgrade-job.yaml +++ b/chart/templates/postupgrade-job.yaml @@ -36,21 +36,21 @@ spec: priorityClassName: {{ .Values.longhornManager.priorityClass | quote }} {{- end }} serviceAccountName: longhorn-service-account - {{- if or .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} tolerations: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.tolerations }} {{ toYaml .Values.global.cattle.windowsCluster.tolerations | indent 6 }} {{- end }} - {{- if .Values.longhornManager.tolerations }} -{{ toYaml .Values.longhornManager.tolerations | indent 6 }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations }} +{{ default .Values.global.tolerations .Values.longhornManager.tolerations | toYaml | indent 6 }} {{- end }} {{- end }} - {{- if or .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} nodeSelector: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.nodeSelector }} {{ toYaml .Values.global.cattle.windowsCluster.nodeSelector | indent 8 }} {{- end }} - {{- if .Values.longhornManager.nodeSelector }} -{{ toYaml .Values.longhornManager.nodeSelector | indent 8 }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector }} +{{ default .Values.global.nodeSelector .Values.longhornManager.nodeSelector | toYaml | indent 8 }} {{- end }} {{- end }} diff --git a/chart/templates/preupgrade-job.yaml b/chart/templates/preupgrade-job.yaml index ef0fe02f43..2b8333d89e 100644 --- a/chart/templates/preupgrade-job.yaml +++ b/chart/templates/preupgrade-job.yaml @@ -34,22 +34,22 @@ spec: - name: {{ .Values.privateRegistry.registrySecret }} {{- end }} serviceAccountName: longhorn-service-account - {{- if or .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} tolerations: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.tolerations }} {{ toYaml .Values.global.cattle.windowsCluster.tolerations | indent 6 }} {{- end }} - {{- if .Values.longhornManager.tolerations }} -{{ toYaml .Values.longhornManager.tolerations | indent 6 }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations }} +{{ default .Values.global.tolerations .Values.longhornManager.tolerations | toYaml | indent 6 }} {{- end }} {{- end }} - {{- if or .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} nodeSelector: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.nodeSelector }} {{ toYaml .Values.global.cattle.windowsCluster.nodeSelector | indent 8 }} {{- end }} - {{- if .Values.longhornManager.nodeSelector }} -{{ toYaml .Values.longhornManager.nodeSelector | indent 8 }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector }} +{{ default .Values.global.nodeSelector .Values.longhornManager.nodeSelector | toYaml | indent 8 }} {{- end }} {{- end }} {{- end }} diff --git a/chart/templates/servicemonitor.yaml b/chart/templates/servicemonitor.yaml index fd11fe9d47..3f32961332 100644 --- a/chart/templates/servicemonitor.yaml +++ b/chart/templates/servicemonitor.yaml @@ -7,6 +7,13 @@ metadata: labels: {{- include "longhorn.labels" . | nindent 4 }} name: longhorn-prometheus-servicemonitor + {{- with .Values.metrics.serviceMonitor.additionalLabels }} + {{- toYaml . | nindent 4 }} + {{- end }} + {{- with .Values.metrics.serviceMonitor.annotations }} + annotations: + {{- toYaml . | nindent 4 }} + {{- end }} spec: selector: matchLabels: @@ -16,4 +23,18 @@ spec: - {{ include "release_namespace" . }} endpoints: - port: manager + {{- with .Values.metrics.serviceMonitor.interval }} + interval: {{ . }} + {{- end }} + {{- with .Values.metrics.serviceMonitor.scrapeTimeout }} + scrapeTimeout: {{ . }} + {{- end }} + {{- with .Values.metrics.serviceMonitor.relabelings }} + relabelings: + {{- toYaml . | nindent 8 }} + {{- end }} + {{- with .Values.metrics.serviceMonitor.metricRelabelings }} + metricRelabelings: + {{- toYaml . | nindent 8 }} + {{- end }} {{- end }} \ No newline at end of file diff --git a/chart/templates/services.yaml b/chart/templates/services.yaml index 7da9d1892f..9523cabcab 100644 --- a/chart/templates/services.yaml +++ b/chart/templates/services.yaml @@ -7,7 +7,6 @@ metadata: namespace: {{ include "release_namespace" . }} spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: @@ -24,7 +23,6 @@ metadata: namespace: {{ include "release_namespace" . }} spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: @@ -41,34 +39,9 @@ metadata: namespace: {{ include "release_namespace" . }} spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: - name: recovery-backend port: 9503 targetPort: recov-backend ---- -apiVersion: v1 -kind: Service -metadata: - labels: {{- include "longhorn.labels" . | nindent 4 }} - name: longhorn-engine-manager - namespace: {{ include "release_namespace" . }} -spec: - clusterIP: None - selector: - longhorn.io/component: instance-manager - longhorn.io/instance-manager-type: engine ---- -apiVersion: v1 -kind: Service -metadata: - labels: {{- include "longhorn.labels" . | nindent 4 }} - name: longhorn-replica-manager - namespace: {{ include "release_namespace" . }} -spec: - clusterIP: None - selector: - longhorn.io/component: instance-manager - longhorn.io/instance-manager-type: replica diff --git a/chart/templates/storageclass.yaml b/chart/templates/storageclass.yaml index 5f61f62421..f79699f5e0 100644 --- a/chart/templates/storageclass.yaml +++ b/chart/templates/storageclass.yaml @@ -45,3 +45,6 @@ data: {{- if .Values.persistence.defaultNodeSelector.enable }} nodeSelector: "{{ .Values.persistence.defaultNodeSelector.selector }}" {{- end }} + {{- if .Values.persistence.removeSnapshotsDuringFilesystemTrim }} + unmapMarkSnapChainRemoved: "{{ .Values.persistence.removeSnapshotsDuringFilesystemTrim }}" + {{- end }} diff --git a/chart/templates/uninstall-job.yaml b/chart/templates/uninstall-job.yaml index 968f420616..1ab46207c3 100644 --- a/chart/templates/uninstall-job.yaml +++ b/chart/templates/uninstall-job.yaml @@ -37,21 +37,21 @@ spec: priorityClassName: {{ .Values.longhornManager.priorityClass | quote }} {{- end }} serviceAccountName: longhorn-service-account - {{- if or .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations .Values.global.cattle.windowsCluster.enabled }} tolerations: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.tolerations }} {{ toYaml .Values.global.cattle.windowsCluster.tolerations | indent 6 }} {{- end }} - {{- if .Values.longhornManager.tolerations }} -{{ toYaml .Values.longhornManager.tolerations | indent 6 }} + {{- if or .Values.global.tolerations .Values.longhornManager.tolerations }} +{{ default .Values.global.tolerations .Values.longhornManager.tolerations | toYaml | indent 6 }} {{- end }} {{- end }} - {{- if or .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector .Values.global.cattle.windowsCluster.enabled }} nodeSelector: {{- if and .Values.global.cattle.windowsCluster.enabled .Values.global.cattle.windowsCluster.nodeSelector }} {{ toYaml .Values.global.cattle.windowsCluster.nodeSelector | indent 8 }} {{- end }} - {{- if or .Values.longhornManager.nodeSelector }} -{{ toYaml .Values.longhornManager.nodeSelector | indent 8 }} + {{- if or .Values.global.nodeSelector .Values.longhornManager.nodeSelector }} +{{ default .Values.global.nodeSelector .Values.longhornManager.nodeSelector | toYaml | indent 8 }} {{- end }} {{- end }} diff --git a/chart/values.yaml b/chart/values.yaml index e574f0cea8..5c2a655a72 100644 --- a/chart/values.yaml +++ b/chart/values.yaml @@ -2,377 +2,350 @@ # This is a YAML-formatted file. # Declare variables to be passed into your templates. global: + # -- Toleration for nodes allowed to run user-deployed components such as Longhorn Manager, Longhorn UI, and Longhorn Driver Deployer. + tolerations: [] + # -- Node selector for nodes allowed to run user-deployed components such as Longhorn Manager, Longhorn UI, and Longhorn Driver Deployer. + nodeSelector: {} cattle: - # -- System default registry + # -- Default system registry. systemDefaultRegistry: "" windowsCluster: - # -- Enable this to allow Longhorn to run on the Rancher-deployed Windows cluster + # -- Setting that allows Longhorn to run on a Rancher Windows cluster. enabled: false - # -- Tolerate Linux nodes to run Longhorn user deployed components + # -- Toleration for Linux nodes that can run user-deployed Longhorn components. tolerations: - key: "cattle.io/os" value: "linux" effect: "NoSchedule" operator: "Equal" - # -- Select Linux nodes to run Longhorn user deployed components + # -- Node selector for Linux nodes that can run user-deployed Longhorn components. nodeSelector: kubernetes.io/os: "linux" defaultSetting: - # -- Toleration for Longhorn system managed components + # -- Toleration for system-managed Longhorn components. taintToleration: cattle.io/os=linux:NoSchedule - # -- Node selector for Longhorn system managed components + # -- Node selector for system-managed Longhorn components. systemManagedComponentsNodeSelector: kubernetes.io/os:linux networkPolicies: - # -- Enable NetworkPolicies to limit access to the Longhorn pods + # -- Setting that allows you to enable network policies that control access to Longhorn pods. enabled: false - # -- Create the policy based on your distribution to allow access for the ingress. Options: `k3s`, `rke2`, `rke1` + # -- Distribution that determines the policy for allowing access for an ingress. (Options: "k3s", "rke2", "rke1") type: "k3s" image: longhorn: engine: - # -- Specify Longhorn engine image repository + # -- Repository for the Longhorn Engine image. repository: longhornio/longhorn-engine # -- Specify Longhorn engine image tag - tag: master-head + tag: v1.6.4 manager: - # -- Specify Longhorn manager image repository + # -- Repository for the Longhorn Manager image. repository: longhornio/longhorn-manager # -- Specify Longhorn manager image tag - tag: master-head + tag: v1.6.4 ui: - # -- Specify Longhorn ui image repository + # -- Repository for the Longhorn UI image. repository: longhornio/longhorn-ui # -- Specify Longhorn ui image tag - tag: master-head + tag: v1.6.4 instanceManager: - # -- Specify Longhorn instance manager image repository + # -- Repository for the Longhorn Instance Manager image. repository: longhornio/longhorn-instance-manager # -- Specify Longhorn instance manager image tag - tag: master-head + tag: v1.6.4 shareManager: - # -- Specify Longhorn share manager image repository + # -- Repository for the Longhorn Share Manager image. repository: longhornio/longhorn-share-manager # -- Specify Longhorn share manager image tag - tag: master-head + tag: v1.6.4 backingImageManager: - # -- Specify Longhorn backing image manager image repository + # -- Repository for the Backing Image Manager image. When unspecified, Longhorn uses the default value. repository: longhornio/backing-image-manager # -- Specify Longhorn backing image manager image tag - tag: master-head + tag: v1.6.4 supportBundleKit: - # -- Specify Longhorn support bundle manager image repository + # -- Repository for the Longhorn Support Bundle Manager image. repository: longhornio/support-bundle-kit - # -- Specify Longhorn support bundle manager image tag - tag: v0.0.33 + # -- Tag for the Longhorn Support Bundle Manager image. + tag: v0.0.48 csi: attacher: - # -- Specify CSI attacher image repository. Leave blank to autodetect + # -- Repository for the CSI attacher image. When unspecified, Longhorn uses the default value. repository: longhornio/csi-attacher - # -- Specify CSI attacher image tag. Leave blank to autodetect - tag: v4.4.2 + # -- Tag for the CSI attacher image. When unspecified, Longhorn uses the default value. + tag: v4.7.0-20241219 provisioner: - # -- Specify CSI provisioner image repository. Leave blank to autodetect + # -- Repository for the CSI Provisioner image. When unspecified, Longhorn uses the default value. repository: longhornio/csi-provisioner - # -- Specify CSI provisioner image tag. Leave blank to autodetect - tag: v3.6.2 + # -- Tag for the CSI Provisioner image. When unspecified, Longhorn uses the default value. + tag: v3.6.4-20241219 nodeDriverRegistrar: - # -- Specify CSI node driver registrar image repository. Leave blank to autodetect + # -- Repository for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value. repository: longhornio/csi-node-driver-registrar - # -- Specify CSI node driver registrar image tag. Leave blank to autodetect - tag: v2.9.2 + # -- Tag for the CSI Node Driver Registrar image. When unspecified, Longhorn uses the default value. + tag: v2.12.0-20241219 resizer: - # -- Specify CSI driver resizer image repository. Leave blank to autodetect + # -- Repository for the CSI Resizer image. When unspecified, Longhorn uses the default value. repository: longhornio/csi-resizer - # -- Specify CSI driver resizer image tag. Leave blank to autodetect - tag: v1.9.2 + # -- Tag for the CSI Resizer image. When unspecified, Longhorn uses the default value. + tag: v1.12.0-20241219 snapshotter: - # -- Specify CSI driver snapshotter image repository. Leave blank to autodetect + # -- Repository for the CSI Snapshotter image. When unspecified, Longhorn uses the default value. repository: longhornio/csi-snapshotter - # -- Specify CSI driver snapshotter image tag. Leave blank to autodetect. - tag: v6.3.2 + # -- Tag for the CSI Snapshotter image. When unspecified, Longhorn uses the default value. + tag: v6.3.4-20241219 livenessProbe: - # -- Specify CSI liveness probe image repository. Leave blank to autodetect + # -- Repository for the CSI liveness probe image. When unspecified, Longhorn uses the default value. repository: longhornio/livenessprobe - # -- Specify CSI liveness probe image tag. Leave blank to autodetect - tag: v2.11.0 + # -- Tag for the CSI liveness probe image. When unspecified, Longhorn uses the default value. + tag: v2.14.0-20241219 openshift: oauthProxy: - # -- For openshift user. Specify oauth proxy image repository - repository: quay.io/openshift/origin-oauth-proxy - # -- For openshift user. Specify oauth proxy image tag. Note: Use your OCP/OKD 4.X Version, Current Stable is 4.14 - tag: 4.14 - # -- Image pull policy which applies to all Longhorn user-deployed components. E.g., Longhorn manager, Longhorn driver, Longhorn UI + # -- Repository for the OAuth Proxy image. Specify the upstream image (for example, "quay.io/openshift/origin-oauth-proxy"). This setting applies only to OpenShift users. + repository: "" + # -- Tag for the OAuth Proxy image. Specify OCP/OKD version 4.1 or later (including version 4.15, which is available at quay.io/openshift/origin-oauth-proxy:4.15). This setting applies only to OpenShift users. + tag: "" + # -- Image pull policy that applies to all user-deployed Longhorn components, such as Longhorn Manager, Longhorn driver, and Longhorn UI. pullPolicy: IfNotPresent service: ui: - # -- Define the Longhorn UI service type. Options: `ClusterIP`, `NodePort`, `LoadBalancer`, `Rancher-Proxy` + # -- Service type for Longhorn UI. (Options: "ClusterIP", "NodePort", "LoadBalancer", "Rancher-Proxy") type: ClusterIP - # -- NodePort port number (to set explicitly, chooses port between 30000-32767) + # -- NodePort port number for Longhorn UI. When unspecified, Longhorn selects a free port between 30000 and 32767. nodePort: null manager: - # -- Define the Longhorn manager service type. + # -- Service type for Longhorn Manager. type: ClusterIP - # -- NodePort port number (to set explicitly, chooses port between 30000-32767) + # -- NodePort port number for Longhorn Manager. When unspecified, Longhorn selects a free port between 30000 and 32767. nodePort: "" persistence: - # -- Set Longhorn StorageClass as default + # -- Setting that allows you to specify the default Longhorn StorageClass. defaultClass: true - # -- Set filesystem type for Longhorn StorageClass + # -- Filesystem type of the default Longhorn StorageClass. defaultFsType: ext4 - # -- Set mkfs options for Longhorn StorageClass + # -- mkfs parameters of the default Longhorn StorageClass. defaultMkfsParams: "" - # -- Set replica count for Longhorn StorageClass + # -- Replica count of the default Longhorn StorageClass. defaultClassReplicaCount: 3 - # -- Set data locality for Longhorn StorageClass. Options: `disabled`, `best-effort` + # -- Data locality of the default Longhorn StorageClass. (Options: "disabled", "best-effort") defaultDataLocality: disabled - # -- Define reclaim policy. Options: `Retain`, `Delete` + # -- Reclaim policy that provides instructions for handling of a volume after its claim is released. (Options: "Retain", "Delete") reclaimPolicy: Delete - # -- Set volume migratable for Longhorn StorageClass + # -- Setting that allows you to enable live migration of a Longhorn volume from one node to another. migratable: false # -- Set NFS mount options for Longhorn StorageClass for RWX volumes nfsOptions: "" recurringJobSelector: - # -- Enable recurring job selector for Longhorn StorageClass + # -- Setting that allows you to enable the recurring job selector for a Longhorn StorageClass. enable: false - # -- Recurring job selector list for Longhorn StorageClass. Please be careful of quotes of input. E.g., `[{"name":"backup", "isGroup":true}]` + # -- Recurring job selector for a Longhorn StorageClass. Ensure that quotes are used correctly when specifying job parameters. (Example: `[{"name":"backup", "isGroup":true}]`) jobList: [] backingImage: - # -- Set backing image for Longhorn StorageClass + # -- Setting that allows you to use a backing image in a Longhorn StorageClass. enable: false - # -- Specify a backing image that will be used by Longhorn volumes in Longhorn StorageClass. If not exists, the backing image data source type and backing image data source parameters should be specified so that Longhorn will create the backing image before using it + # -- Backing image to be used for creating and restoring volumes in a Longhorn StorageClass. When no backing images are available, specify the data source type and parameters that Longhorn can use to create a backing image. name: ~ - # -- Specify the data source type for the backing image used in Longhorn StorageClass. - # If the backing image does not exist, Longhorn will use this field to create a backing image. - # Otherwise, Longhorn will use it to verify the selected backing image. + # -- Data source type of a backing image used in a Longhorn StorageClass. + # If the backing image exists in the cluster, Longhorn uses this setting to verify the image. + # If the backing image does not exist, Longhorn creates one using the specified data source type. dataSourceType: ~ - # -- Specify the data source parameters for the backing image used in Longhorn StorageClass. - # This option accepts a json string of a map. E.g., `'{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'`. + # -- Data source parameters of a backing image used in a Longhorn StorageClass. + # You can specify a JSON string of a map. (Example: `'{\"url\":\"https://backing-image-example.s3-region.amazonaws.com/test-backing-image\"}'`) dataSourceParameters: ~ - # -- Specify the expected SHA512 checksum of the selected backing image in Longhorn StorageClass + # -- Expected SHA-512 checksum of a backing image used in a Longhorn StorageClass. expectedChecksum: ~ defaultNodeSelector: - # -- Enable Node selector for Longhorn StorageClass + # -- Setting that allows you to enable the node selector for the default Longhorn StorageClass. enable: false - # -- This selector enables only certain nodes having these tags to be used for the volume. E.g. `"storage,fast"` + # -- Node selector for the default Longhorn StorageClass. Longhorn uses only nodes with the specified tags for storing volume data. (Examples: "storage,fast") selector: "" - # -- Allow automatically removing snapshots during filesystem trim for Longhorn StorageClass. Options: `ignored`, `enabled`, `disabled` + # -- Setting that allows you to enable automatic snapshot removal during filesystem trim for a Longhorn StorageClass. (Options: "ignored", "enabled", "disabled") removeSnapshotsDuringFilesystemTrim: ignored preUpgradeChecker: - # -- Setting that allows Longhorn to perform pre-upgrade checks before starting the Longhorn Manager DaemonSet Pods. Disable this setting when installing Longhorn using Argo CD or other GitOps solutions. + # -- Setting that allows Longhorn to perform pre-upgrade checks. Disable this setting when installing Longhorn using Argo CD or other GitOps solutions. jobEnabled: true - # -- Setting that allows Longhorn to perform upgrade version checks after starting the Longhorn Manager DaemonSet Pods. Disabling this setting also disables `preUpgradeChecker.jobEnabled`, but it's not recommended to disable it. + # -- Setting that allows Longhorn to perform upgrade version checks after starting the Longhorn Manager DaemonSet Pods. Disabling this setting also disables `preUpgradeChecker.jobEnabled`. Longhorn recommends keeping this setting enabled. upgradeVersionCheck: true csi: - # -- Specify kubelet root-dir. Leave blank to autodetect + # -- kubelet root directory. When unspecified, Longhorn uses the default value. kubeletRootDir: ~ - # -- Specify replica count of CSI Attacher. Leave blank to use default count: 3 + # -- Replica count of the CSI Attacher. When unspecified, Longhorn uses the default value ("3"). attacherReplicaCount: ~ - # -- Specify replica count of CSI Provisioner. Leave blank to use default count: 3 + # -- Replica count of the CSI Provisioner. When unspecified, Longhorn uses the default value ("3"). provisionerReplicaCount: ~ - # -- Specify replica count of CSI Resizer. Leave blank to use default count: 3 + # -- Replica count of the CSI Resizer. When unspecified, Longhorn uses the default value ("3"). resizerReplicaCount: ~ - # -- Specify replica count of CSI Snapshotter. Leave blank to use default count: 3 + # -- Replica count of the CSI Snapshotter. When unspecified, Longhorn uses the default value ("3"). snapshotterReplicaCount: ~ defaultSettings: - # -- The endpoint used to access the backupstore. Available: NFS, CIFS, AWS, GCP, AZURE. + # -- Endpoint used to access the backupstore. (Options: "NFS", "CIFS", "AWS", "GCP", "AZURE") backupTarget: ~ - # -- The name of the Kubernetes secret associated with the backup target. + # -- Name of the Kubernetes secret associated with the backup target. backupTargetCredentialSecret: ~ - # -- If this setting is enabled, Longhorn will automatically attach the volume and takes snapshot/backup - # when it is the time to do recurring snapshot/backup. + # -- Setting that allows Longhorn to automatically attach a volume and create snapshots or backups when recurring jobs are run. allowRecurringJobWhileVolumeDetached: ~ - # -- Create default Disk automatically only on Nodes with the label "node.longhorn.io/create-default-disk=true" if no other disks exist. - # If disabled, the default disk will be created on all new nodes when each node is first added. + # -- Setting that allows Longhorn to automatically create a default disk only on nodes with the label "node.longhorn.io/create-default-disk=true" (if no other disks exist). When this setting is disabled, Longhorn creates a default disk on each node that is added to the cluster. createDefaultDiskLabeledNodes: ~ - # -- Default path to use for storing data on a host. By default, "/var/lib/longhorn/" + # -- Default path for storing data on a host. The default value is "/var/lib/longhorn/". defaultDataPath: ~ - # -- Longhorn volume has data locality if there is a local replica of the volume on the same node as the pod which is using the volume. + # -- Default data locality. A Longhorn volume has data locality if a local replica of the volume exists on the same node as the pod that is using the volume. defaultDataLocality: ~ - # -- Allow scheduling on nodes with existing healthy replicas of the same volume. By default, false. + # -- Setting that allows scheduling on nodes with healthy replicas of the same volume. This setting is disabled by default. replicaSoftAntiAffinity: ~ - # -- Enable this setting automatically re-balances replicas when discovered an available node. + # -- Setting that automatically rebalances replicas when an available node is discovered. replicaAutoBalance: ~ - # -- Percentage of storage that can be allocated relative to hard drive capacity. The default value is 100. + # -- Percentage of storage that can be allocated relative to hard drive capacity. The default value is "100". storageOverProvisioningPercentage: ~ - # -- If the minimum available disk capacity exceeds the actual percentage of available disk capacity, - # the disk becomes unschedulable until more space is freed up. By default, 25. + # -- Percentage of minimum available disk capacity. When the minimum available capacity exceeds the total available capacity, the disk becomes unschedulable until more space is made available for use. The default value is "25". storageMinimalAvailablePercentage: ~ - # -- The reserved percentage specifies the percentage of disk space that will not be allocated to the default disk on each new Longhorn node. + # -- Percentage of disk space that is not allocated to the default disk on each new Longhorn node. storageReservedPercentageForDefaultDisk: ~ - # -- Upgrade Checker will check for a new Longhorn version periodically. - # When there is a new version available, a notification will appear in the UI. By default, true. + # -- Upgrade Checker that periodically checks for new Longhorn versions. When a new version is available, a notification appears on the Longhorn UI. This setting is enabled by default upgradeChecker: ~ - # -- The default number of replicas when a volume is created from the Longhorn UI. - # For Kubernetes configuration, update the `numberOfReplicas` in the StorageClass. By default, 3. + # -- Default number of replicas for volumes created using the Longhorn UI. For Kubernetes configuration, modify the `numberOfReplicas` field in the StorageClass. The default value is "3". defaultReplicaCount: ~ - # -- The 'storageClassName' is given to PVs and PVCs that are created for an existing Longhorn volume. The StorageClass name can also be used as a label, - # so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. - # By default, 'longhorn-static'. + # -- Default Longhorn StorageClass. "storageClassName" is assigned to PVs and PVCs that are created for an existing Longhorn volume. "storageClassName" can also be used as a label, so it is possible to use a Longhorn StorageClass to bind a workload to an existing PV without creating a Kubernetes StorageClass object. The default value is "longhorn-static". defaultLonghornStaticStorageClass: ~ - # -- In seconds. The backup store poll interval determines how often Longhorn checks the backup store for new backups. - # Set to 0 to disable the polling. By default, 300. + # -- Number of seconds that Longhorn waits before checking the backupstore for new backups. The default value is "300". When the value is "0", polling is disabled. backupstorePollInterval: ~ - # -- In minutes. This setting determines how long Longhorn will keep the backup resource that was failed. Set to 0 to disable the auto-deletion. + # -- Number of minutes that Longhorn keeps a failed backup resource. When the value is "0", automatic deletion is disabled. failedBackupTTL: ~ - # -- Restore recurring jobs from the backup volume on the backup target and create recurring jobs if not exist during a backup restoration. + # -- Setting that restores recurring jobs from a backup volume on a backup target and creates recurring jobs if none exist during backup restoration. restoreVolumeRecurringJobs: ~ - # -- This setting specifies how many successful backup or snapshot job histories should be retained. History will not be retained if the value is 0. + # -- Maximum number of successful recurring backup and snapshot jobs to be retained. When the value is "0", a history of successful recurring jobs is not retained. recurringSuccessfulJobsHistoryLimit: ~ - # -- This setting specifies how many failed backup or snapshot job histories should be retained. History will not be retained if the value is 0. + # -- Maximum number of failed recurring backup and snapshot jobs to be retained. When the value is "0", a history of failed recurring jobs is not retained. recurringFailedJobsHistoryLimit: ~ # -- Maximum number of snapshots or backups to be retained. recurringJobMaxRetention: ~ - # -- This setting specifies how many failed support bundles can exist in the cluster. - # Set this value to **0** to have Longhorn automatically purge all failed support bundles. + # -- Maximum number of failed support bundles that can exist in the cluster. When the value is "0", Longhorn automatically purges all failed support bundles. supportBundleFailedHistoryLimit: ~ - # -- taintToleration for Longhorn system-managed components + # -- Taint or toleration for system-managed Longhorn components. + # Specify values using a semicolon-separated list in `kubectl taint` syntax (Example: key1=value1:effect; key2=value2:effect). taintToleration: ~ - # -- nodeSelector for Longhorn system-managed components + # -- Node selector for system-managed Longhorn components. systemManagedComponentsNodeSelector: ~ - # -- priorityClass for Longhorn system-managed components + # -- PriorityClass for system-managed Longhorn components. # This setting can help prevent Longhorn components from being evicted under Node Pressure. # Notice that this will be applied to Longhorn user-deployed components by default if there are no priority class values set yet, such as `longhornManager.priorityClass`. priorityClass: &defaultPriorityClassNameRef "longhorn-critical" - # -- If enabled, volumes will be automatically salvaged when all the replicas become faulty, e.g., due to network disconnection. - # Longhorn will try to figure out which replica(s) are usable, then use them for the volume. By default, true. + # -- Setting that allows Longhorn to automatically salvage volumes when all replicas become faulty (for example, when the network connection is interrupted). Longhorn determines which replicas are usable and then uses these replicas for the volume. This setting is enabled by default. autoSalvage: ~ - # -- If enabled, Longhorn will automatically delete the workload pod managed by a controller (e.g., Deployment, StatefulSet, DaemonSet, etc...) - # when Longhorn volume is detached unexpectedly (e.g., during Kubernetes upgrade, Docker reboot, or network disconnect). - # By deleting the pod, its controller restarts the pod and Kubernetes handles volume reattachment and remount. + # -- Setting that allows Longhorn to automatically delete a workload pod that is managed by a controller (for example, daemonset) whenever a Longhorn volume is detached unexpectedly (for example, during Kubernetes upgrades). After deletion, the controller restarts the pod and then Kubernetes handles volume reattachment and remounting. autoDeletePodWhenVolumeDetachedUnexpectedly: ~ - # -- Disable Longhorn manager to schedule replica on Kubernetes cordoned node. By default, true. + # -- Setting that prevents Longhorn Manager from scheduling replicas on a cordoned Kubernetes node. This setting is enabled by default. disableSchedulingOnCordonedNode: ~ - # -- Allow scheduling new Replicas of Volume to the Nodes in the same Zone as existing healthy Replicas. - # Nodes don't belong to any Zone will be treated as in the same Zone. - # Notice that Longhorn relies on label `topology.kubernetes.io/zone=` in the Kubernetes node object to identify the zone. - # By default, true. + # -- Setting that allows Longhorn to schedule new replicas of a volume to nodes in the same zone as existing healthy replicas. Nodes that do not belong to any zone are treated as existing in the zone that contains healthy replicas. When identifying zones, Longhorn relies on the label "topology.kubernetes.io/zone=" in the Kubernetes node object. replicaZoneSoftAntiAffinity: ~ - # -- Allow scheduling on disks with existing healthy replicas of the same volume. By default, true. + # -- Setting that allows scheduling on disks with existing healthy replicas of the same volume. This setting is enabled by default. replicaDiskSoftAntiAffinity: ~ - # -- Defines the Longhorn action when a Volume is stuck with a StatefulSet/Deployment Pod on a node that is down. + # -- Policy that defines the action Longhorn takes when a volume is stuck with a StatefulSet or Deployment pod on a node that failed. nodeDownPodDeletionPolicy: ~ - # -- Define the policy to use when a node with the last healthy replica of a volume is drained. + # -- Policy that defines the action Longhorn takes when a node with the last healthy replica of a volume is drained. nodeDrainPolicy: ~ - # -- Automatically detach volumes that are attached manually when the node is cordoned. + # -- Setting that allows automatic detaching of manually-attached volumes when a node is cordoned. detachManuallyAttachedVolumesWhenCordoned: ~ - # -- The interval in seconds determines how long Longhorn will at least wait to reuse the existing data on a failed replica - # rather than directly creating a new replica for a degraded volume. + # -- Number of seconds that Longhorn waits before reusing existing data on a failed replica instead of creating a new replica of a degraded volume. replicaReplenishmentWaitInterval: ~ - # -- This setting controls how many replicas on a node can be rebuilt simultaneously. + # -- Maximum number of replicas that can be concurrently rebuilt on each node. concurrentReplicaRebuildPerNodeLimit: ~ - # -- This setting controls how many volumes on a node can restore the backup concurrently. Set the value to **0** to disable backup restore. + # -- Maximum number of volumes that can be concurrently restored on each node using a backup. When the value is "0", restoration of volumes using a backup is disabled. concurrentVolumeBackupRestorePerNodeLimit: ~ - # -- This setting is only for volumes created by UI. - # By default, this is false, meaning there will be a revision counter file to track every write to the volume. - # During salvage-recovering, Longhorn will pick the replica with the largest revision counter as a candidate to recover the whole volume. - # If the revision counter is disabled, Longhorn will not track every write to the volume. - # During the salvage recovering, Longhorn will use the 'volume-head-xxx.img' file last modification time and - # file size to pick the replica candidate to recover the whole volume. + # -- Setting that disables the revision counter and thereby prevents Longhorn from tracking all write operations to a volume. When salvaging a volume, Longhorn uses properties of the "volume-head-xxx.img" file (the last file size and the last time the file was modified) to select the replica to be used for volume recovery. This setting applies only to volumes created using the Longhorn UI. disableRevisionCounter: ~ - # -- This setting defines the Image Pull Policy of Longhorn system managed pod. - # E.g. instance manager, engine image, CSI driver, etc. - # The new Image Pull Policy will only apply after the system-managed pods restart. + # -- Image pull policy for system-managed pods, such as Instance Manager, engine images, and CSI Driver. Changes to the image pull policy are applied only after the system-managed pods restart. systemManagedPodsImagePullPolicy: ~ - # -- This setting allows user to create and attach a volume that doesn't have all the replicas scheduled at the time of creation. + # -- Setting that allows you to create and attach a volume without having all replicas scheduled at the time of creation. allowVolumeCreationWithDegradedAvailability: ~ - # -- This setting enables Longhorn to automatically clean up the system-generated snapshot after replica rebuild is done. + # -- Setting that allows Longhorn to automatically clean up the system-generated snapshot after replica rebuilding is completed. autoCleanupSystemGeneratedSnapshot: ~ - # -- This setting enables Longhorn to automatically cleanup the snapshot generated by a recurring backup job. + # -- Setting that allows Longhorn to automatically clean up the snapshot generated by a recurring backup job. autoCleanupRecurringJobBackupSnapshot: ~ - # -- This setting controls how Longhorn automatically upgrades volumes' engines to the new default engine image after upgrading Longhorn manager. - # The value of this setting specifies the maximum number of engines per node that are allowed to upgrade to the default engine image at the same time. - # If the value is 0, Longhorn will not automatically upgrade volumes' engines to the default version of engine image. + # -- Maximum number of engines that are allowed to concurrently upgrade on each node after Longhorn Manager is upgraded. When the value is "0", Longhorn does not automatically upgrade volume engines to the new default engine image version. concurrentAutomaticEngineUpgradePerNodeLimit: ~ - # -- This interval in minutes determines how long Longhorn will wait before cleaning up the backing image file when there is no replica in the disk using it. + # -- Number of minutes that Longhorn waits before cleaning up the backing image file when no replicas in the disk are using it. backingImageCleanupWaitInterval: ~ - # -- This interval in seconds determines how long Longhorn will wait before re-downloading the backing image file - # when all disk files of this backing image become failed or unknown. + # -- Number of seconds that Longhorn waits before downloading a backing image file again when the status of all image disk files changes to "failed" or "unknown". backingImageRecoveryWaitInterval: ~ - # -- Percentage of the total allocatable CPU resources on each node to be reserved for each instance manager pod when the V1 Data Engine is enabled. - # The default value is 12 percent. + # -- Percentage of the total allocatable CPU resources on each node to be reserved for each instance manager pod when the V1 Data Engine is enabled. The default value is "12". guaranteedInstanceManagerCPU: ~ # -- Setting that notifies Longhorn that the cluster is using the Kubernetes Cluster Autoscaler. kubernetesClusterAutoscalerEnabled: ~ - # -- This setting allows Longhorn to delete the orphan resource and its corresponding orphaned data automatically like stale replicas. - # Orphan resources on down or unknown nodes will not be cleaned up automatically. + # -- Setting that allows Longhorn to automatically delete an orphaned resource and the corresponding data (for example, stale replicas). Orphaned resources on failed or unknown nodes are not automatically cleaned up. orphanAutoDeletion: ~ - # -- Longhorn uses the storage network for in-cluster data traffic. Leave this blank to use the Kubernetes cluster network. + # -- Storage network for in-cluster traffic. When unspecified, Longhorn uses the Kubernetes cluster network. storageNetwork: ~ - # -- This flag is designed to prevent Longhorn from being accidentally uninstalled which will lead to data lost. + # -- Flag that prevents accidental uninstallation of Longhorn. deletingConfirmationFlag: ~ - # -- In seconds. The setting specifies the timeout between the engine and replica(s), and the value should be between 8 and 30 seconds. - # The default value is 8 seconds. + # -- Timeout between the Longhorn Engine and replicas. Specify a value between "8" and "30" seconds. The default value is "8". engineReplicaTimeout: ~ - # -- This setting allows users to enable or disable snapshot hashing and data integrity checking. + # -- Setting that allows you to enable and disable snapshot hashing and data integrity checks. snapshotDataIntegrity: ~ - # -- Hashing snapshot disk files impacts the performance of the system. - # The immediate snapshot hashing and checking can be disabled to minimize the impact after creating a snapshot. + # -- Setting that allows disabling of snapshot hashing after snapshot creation to minimize impact on system performance. snapshotDataIntegrityImmediateCheckAfterSnapshotCreation: ~ - # -- Unix-cron string format. The setting specifies when Longhorn checks the data integrity of snapshot disk files. + # -- Setting that defines when Longhorn checks the integrity of data in snapshot disk files. You must use the Unix cron expression format. snapshotDataIntegrityCronjob: ~ - # -- This setting allows Longhorn filesystem trim feature to automatically mark the latest snapshot and - # its ancestors as removed and stops at the snapshot containing multiple children. + # -- Setting that allows Longhorn to automatically mark the latest snapshot and its parent files as removed during a filesystem trim. Longhorn does not remove snapshots containing multiple child files. removeSnapshotsDuringFilesystemTrim: ~ - # -- This feature supports the fast replica rebuilding. - # It relies on the checksum of snapshot disk files, so setting the snapshot-data-integrity to **enable** or **fast-check** is a prerequisite. + # -- Setting that allows fast rebuilding of replicas using the checksum of snapshot disk files. Before enabling this setting, you must set the snapshot-data-integrity value to "enable" or "fast-check". fastReplicaRebuildEnabled: ~ - # -- In seconds. The setting specifies the HTTP client timeout to the file sync server. + # -- Number of seconds that an HTTP client waits for a response from a File Sync server before considering the connection to have failed. replicaFileSyncHttpClientTimeout: ~ - # -- The log level Panic, Fatal, Error, Warn, Info, Debug, Trace used in longhorn manager. Default to Info. + # -- Log levels that indicate the type and severity of logs in Longhorn Manager. The default value is "Info". (Options: "Panic", "Fatal", "Error", "Warn", "Info", "Debug", "Trace") logLevel: ~ - # -- This setting allows users to specify backup compression method. + # -- Setting that allows you to specify a backup compression method. backupCompressionMethod: ~ - # -- This setting controls how many worker threads per backup concurrently. + # -- Maximum number of worker threads that can concurrently run for each backup. backupConcurrentLimit: ~ - # -- This setting controls how many worker threads per restore concurrently. + # -- Maximum number of worker threads that can concurrently run for each restore operation. restoreConcurrentLimit: ~ - # -- Setting that allows you to enable the V1 Data Engine. This setting is enabled by default. + # -- Setting that allows you to enable the V1 Data Engine. v1DataEngine: ~ - # -- Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). - # The V2 Data Engine is a preview feature and should not be used in production environments. + # -- Setting that allows you to enable the V2 Data Engine, which is based on the Storage Performance Development Kit (SPDK). The V2 Data Engine is a preview feature and should not be used in production environments. v2DataEngine: ~ - # -- Setting that allows you to configure maximum huge page size (in MiB) for the V2 Data Engine. + # -- Setting that allows you to configure maximum huge page size (in MiB) for the V2 Data Engine. v2DataEngineHugepageLimit: ~ - # -- This setting allows users to enable the offline replica rebuilding for volumes using v2 data engine. + # -- Setting that allows rebuilding of offline replicas for volumes using the V2 Data Engine. offlineReplicaRebuilding: ~ - # -- Number of millicpus on each node to be reserved for each instance manager pod when the V2 Data Engine is enabled. - # The default value is 1250 millicpus. + # -- Number of millicpus on each node to be reserved for each Instance Manager pod when the V2 Data Engine is enabled. The default value is "1250". v2DataEngineGuaranteedInstanceManagerCPU: ~ - # -- Allow Scheduling Empty Node Selector Volumes To Any Node + # -- Setting that allows scheduling of empty node selector volumes to any node. allowEmptyNodeSelectorVolume: ~ - # -- Allow Scheduling Empty Disk Selector Volumes To Any Disk + # -- Setting that allows scheduling of empty disk selector volumes to any disk. allowEmptyDiskSelectorVolume: ~ - # -- Enabling this setting will allow Longhorn to provide additional usage metrics to https://metrics.longhorn.io/. This information will help us better understand how Longhorn is being used, which will ultimately contribute to future improvements. + # -- Setting that allows Longhorn to periodically collect anonymous usage data for product improvement purposes. Longhorn sends collected data to the [Upgrade Responder](https://github.com/longhorn/upgrade-responder) server, which is the data source of the Longhorn Public Metrics Dashboard (https://metrics.longhorn.io). The Upgrade Responder server does not store data that can be used to identify clients, including IP addresses. allowCollectingLonghornUsageMetrics: ~ - # -- Temporarily prevent all attempts to purge volume snapshots. + # -- Setting that temporarily prevents all attempts to purge volume snapshots. disableSnapshotPurge: ~ + # -- Maximum snapshot count for a volume. The value should be between 2 to 250 + snapshotMaxCount: ~ privateRegistry: - # -- Set `true` to create a new private registry secret + # -- Setting that allows you to create a private registry secret. createSecret: ~ - # -- URL of private registry. Leave blank to apply system default registry + # -- URL of a private registry. When unspecified, Longhorn uses the default system registry. registryUrl: ~ - # -- User used to authenticate to private registry + # -- User account used for authenticating with a private registry. registryUser: ~ - # -- Password used to authenticate to private registry + # -- Password for authenticating with a private registry. registryPasswd: ~ - # -- If create a new private registry secret is true, create a Kubernetes secret with this name; else use the existing secret of this name. Use it to pull images from your private registry + # -- Kubernetes secret that allows you to pull images from a private registry. This setting applies only when creation of private registry secrets is enabled. You must include the private registry name in the secret name. registrySecret: ~ longhornManager: log: - # -- Options: `plain`, `json` + # -- Format of Longhorn Manager logs. (Options: "plain", "json") format: plain - # -- Priority class for longhorn manager + # -- PriorityClass for Longhorn Manager. priorityClass: *defaultPriorityClassNameRef - # -- Tolerate nodes to run Longhorn manager + # -- Toleration for Longhorn Manager on nodes allowed to run Longhorn components. tolerations: [] ## If you want to set tolerations for Longhorn Manager DaemonSet, delete the `[]` in the line above ## and uncomment this example block @@ -380,13 +353,13 @@ longhornManager: # operator: "Equal" # value: "value" # effect: "NoSchedule" - # -- Select nodes to run Longhorn manager + # -- Node selector for Longhorn Manager. Specify the nodes allowed to run Longhorn Manager. nodeSelector: {} ## If you want to set node selector for Longhorn Manager DaemonSet, delete the `{}` in the line above ## and uncomment this example block # label-key1: "label-value1" # label-key2: "label-value2" - # -- Annotation used in Longhorn manager service + # -- Annotation for the Longhorn Manager service. serviceAnnotations: {} ## If you want to set annotations for the Longhorn Manager service, delete the `{}` in the line above ## and uncomment this example block @@ -394,9 +367,12 @@ longhornManager: # annotation-key2: "annotation-value2" longhornDriver: - # -- Priority class for the Longhorn CSI driver + log: + # -- Format of longhorn-driver logs. (Options: "plain", "json") + format: plain + # -- PriorityClass for Longhorn Driver. priorityClass: *defaultPriorityClassNameRef - # -- Tolerate nodes to run the Longhorn CSI driver + # -- Toleration for Longhorn Driver on nodes allowed to run Longhorn components. tolerations: [] ## If you want to set tolerations for Longhorn Driver Deployer Deployment, delete the `[]` in the line above ## and uncomment this example block @@ -404,7 +380,7 @@ longhornDriver: # operator: "Equal" # value: "value" # effect: "NoSchedule" - # -- Select nodes to run the Longhorn CSI driver + # -- Node selector for Longhorn Driver. Specify the nodes allowed to run Longhorn Driver. nodeSelector: {} ## If you want to set node selector for Longhorn Driver Deployer Deployment, delete the `{}` in the line above ## and uncomment this example block @@ -412,11 +388,11 @@ longhornDriver: # label-key2: "label-value2" longhornUI: - # -- Replica count for longhorn UI + # -- Replica count for Longhorn UI. replicas: 2 - # -- Priority class count for Longhorn UI + # -- PriorityClass for Longhorn UI. priorityClass: *defaultPriorityClassNameRef - # -- Tolerate nodes to run Longhorn UI + # -- Toleration for Longhorn UI on nodes allowed to run Longhorn components. tolerations: [] ## If you want to set tolerations for Longhorn UI Deployment, delete the `[]` in the line above ## and uncomment this example block @@ -424,7 +400,7 @@ longhornUI: # operator: "Equal" # value: "value" # effect: "NoSchedule" - # -- Select nodes to run Longhorn UI + # -- Node selector for Longhorn UI. Specify the nodes allowed to run Longhorn UI. nodeSelector: {} ## If you want to set node selector for Longhorn UI Deployment, delete the `{}` in the line above ## and uncomment this example block @@ -432,27 +408,26 @@ longhornUI: # label-key2: "label-value2" ingress: - # -- Set to true to enable ingress record generation + # -- Setting that allows Longhorn to generate ingress records for the Longhorn UI service. enabled: false - # -- Add ingressClassName to the Ingress - # Can replace the kubernetes.io/ingress.class annotation on v1.18+ + # -- IngressClass resource that contains ingress configuration, including the name of the Ingress controller. + # ingressClassName can replace the kubernetes.io/ingress.class annotation used in earlier Kubernetes releases. ingressClassName: ~ - # -- Layer 7 Load Balancer hostname + # -- Hostname of the Layer 7 load balancer. host: sslip.io - # -- Set this to true to enable TLS on the ingress record + # -- Setting that allows you to enable TLS on ingress records. tls: false - # -- Enable this to enable that the backend service will be connected at port 443 + # -- Setting that allows you to enable secure connections to the Longhorn UI service via port 443. secureBackends: false - # -- If TLS is set to true, you must declare what secret will store the key/certificate for TLS + # -- TLS secret that contains the private key and certificate to be used for TLS. This setting applies only when TLS is enabled on ingress records. tlsSecret: longhorn.local-tls - # -- If ingress is enabled, you can set the default ingress path - # then you can access the UI by using the following full path {{host}}+{{path}} + # -- Default ingress path. You can access the Longhorn UI by following the full ingress path {{host}}+{{path}}. path: / ## If you're using kube-lego, you will want to add: @@ -462,12 +437,12 @@ ingress: ## ref: https://github.com/kubernetes/ingress-nginx/blob/master/docs/annotations.md ## ## If tls is set to true, annotation ingress.kubernetes.io/secure-backends: "true" will automatically be set - # -- Ingress annotations done as key:value pairs + # -- Ingress annotations in the form of key-value pairs. annotations: # kubernetes.io/ingress.class: nginx # kubernetes.io/tls-acme: true - # -- If you're providing your own certificates, please use this to add the certificates as secrets + # -- Secret that contains a TLS private key and certificate. Use secrets if you want to use your own certificates to secure ingresses. secrets: ## If you're providing your own certificates, please use this to add the certificates as secrets ## key and certificate should start with -----BEGIN CERTIFICATE----- or @@ -482,11 +457,13 @@ ingress: # key: # certificate: -# -- For Kubernetes < v1.25, if your cluster enables Pod Security Policy admission controller, -# set this to `true` to ship a built-in longhorn-psp PodSecurityPolicy which allow privileged Longhorn pods to start +# -- Setting that allows you to enable pod security policies (PSPs) that allow privileged Longhorn pods to start. This setting applies only to clusters running Kubernetes 1.25 and earlier, and with the built-in Pod Security admission controller enabled. enablePSP: false -# -- Annotations to add to the Longhorn Manager DaemonSet Pods. Optional. +# -- Specify override namespace, specifically this is useful for using longhorn as sub-chart and its release namespace is not the `longhorn-system`. +namespaceOverride: "" + +# -- Annotation for the Longhorn Manager DaemonSet pods. This setting is optional. annotations: {} serviceAccount: @@ -497,18 +474,34 @@ metrics: serviceMonitor: # -- Setting that allows the creation of a Prometheus ServiceMonitor resource for Longhorn Manager components. enabled: false + # -- Additional labels for the Prometheus ServiceMonitor resource. + additionalLabels: {} + # -- Annotations for the Prometheus ServiceMonitor resource. + annotations: {} + # -- Interval at which Prometheus scrapes the metrics from the target. + interval: "" + # -- Timeout after which Prometheus considers the scrape to be failed. + scrapeTimeout: "" + # -- Configures the relabeling rules to apply the target’s metadata labels. See the [Prometheus Operator + # documentation](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.Endpoint) for + # formatting details. + relabelings: [] + # -- Configures the relabeling rules to apply to the samples before ingestion. See the [Prometheus Operator + # documentation](https://prometheus-operator.dev/docs/api-reference/api/#monitoring.coreos.com/v1.Endpoint) for + # formatting details. + metricRelabelings: [] ## openshift settings openshift: - # -- Enable when using openshift + # -- Setting that allows Longhorn to integrate with OpenShift. enabled: false ui: - # -- UI route in openshift environment + # -- Route for connections between Longhorn and the OpenShift web console. route: "longhorn-ui" - # -- UI port in openshift environment + # -- Port for accessing the OpenShift web console. port: 443 - # -- UI proxy in openshift environment + # -- Port for proxy that provides access to the OpenShift web console. proxy: 8443 -# -- Enable this to allow Longhorn to generate code coverage profiles +# -- Setting that allows Longhorn to generate code coverage profiles. enableGoCoverDir: false diff --git a/deploy/longhorn-images.txt b/deploy/longhorn-images.txt index b66be5687e..03aadd0a79 100644 --- a/deploy/longhorn-images.txt +++ b/deploy/longhorn-images.txt @@ -1,13 +1,13 @@ -longhornio/csi-attacher:v4.4.2 -longhornio/csi-provisioner:v3.6.2 -longhornio/csi-resizer:v1.9.2 -longhornio/csi-snapshotter:v6.3.2 -longhornio/csi-node-driver-registrar:v2.9.2 -longhornio/livenessprobe:v2.11.0 -longhornio/backing-image-manager:master-head -longhornio/longhorn-engine:master-head -longhornio/longhorn-instance-manager:master-head -longhornio/longhorn-manager:master-head -longhornio/longhorn-share-manager:master-head -longhornio/longhorn-ui:master-head -longhornio/support-bundle-kit:v0.0.33 +longhornio/csi-attacher:v4.7.0-20241219 +longhornio/csi-provisioner:v3.6.4-20241219 +longhornio/csi-resizer:v1.12.0-20241219 +longhornio/csi-snapshotter:v6.3.4-20241219 +longhornio/csi-node-driver-registrar:v2.12.0-20241219 +longhornio/livenessprobe:v2.14.0-20241219 +longhornio/backing-image-manager:v1.6.x-head +longhornio/longhorn-engine:v1.6.x-head +longhornio/longhorn-instance-manager:v1.6.x-head +longhornio/longhorn-manager:v1.6.x-head +longhornio/longhorn-share-manager:v1.6.x-head +longhornio/longhorn-ui:v1.6.x-head +longhornio/support-bundle-kit:v0.0.48 diff --git a/deploy/longhorn.yaml b/deploy/longhorn.yaml index d55523bc11..06746719b9 100644 --- a/deploy/longhorn.yaml +++ b/deploy/longhorn.yaml @@ -13,7 +13,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 description: "Ensure Longhorn pods have the highest priority to prevent any unexpected eviction by the Kubernetes scheduler under node pressure" globalDefault: false preemptionPolicy: PreemptLowerPriority @@ -28,7 +28,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 --- # Source: longhorn/templates/serviceaccount.yaml apiVersion: v1 @@ -39,7 +39,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 --- # Source: longhorn/templates/serviceaccount.yaml apiVersion: v1 @@ -50,7 +50,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 --- # Source: longhorn/templates/default-setting.yaml apiVersion: v1 @@ -61,7 +61,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 data: default-setting.yaml: |- priority-class: longhorn-critical @@ -75,7 +75,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 data: storageclass.yaml: | kind: StorageClass @@ -94,18 +94,19 @@ data: fromBackup: "" fsType: "ext4" dataLocality: "disabled" + unmapMarkSnapChainRemoved: "ignored" --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: backingimagedatasources.longhorn.io spec: @@ -145,10 +146,19 @@ spec: description: BackingImageDataSource is where Longhorn stores backing image data source 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 @@ -195,10 +205,19 @@ spec: description: BackingImageDataSource is where Longhorn stores backing image data source 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 @@ -260,24 +279,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: backingimagemanagers.longhorn.io spec: @@ -321,10 +334,19 @@ spec: description: BackingImageManager is where Longhorn stores backing image manager 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 @@ -367,10 +389,19 @@ spec: description: BackingImageManager is where Longhorn stores backing image manager 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 @@ -419,6 +450,9 @@ spec: type: string uuid: type: string + virtualSize: + format: int64 + type: integer type: object nullable: true type: object @@ -436,24 +470,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: backingimages.longhorn.io spec: @@ -493,10 +521,19 @@ spec: description: BackingImage is where Longhorn stores backing image 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 @@ -522,6 +559,10 @@ spec: jsonPath: .status.size name: Size type: string + - description: The virtual size of the image (may be larger than file size) + jsonPath: .status.virtualSize + name: VirtualSize + type: string - jsonPath: .metadata.creationTimestamp name: Age type: date @@ -531,10 +572,19 @@ spec: description: BackingImage is where Longhorn stores backing image 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 @@ -590,25 +640,23 @@ spec: type: integer uuid: type: string + virtualSize: + description: Virtual size of image, which may be larger than physical size. Will be zero until known (e.g. while a backing image is uploading) + format: int64 + type: integer type: object type: object served: true storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: longhorn-manager: "" @@ -651,10 +699,19 @@ spec: description: BackupBackingImage is where Longhorn stores backing image backup 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 @@ -672,7 +729,9 @@ spec: nullable: true type: string userCreated: - description: Is this CR created by user through API or UI. Required + description: |- + Is this CR created by user through API or UI. + Required type: boolean required: - userCreated @@ -726,7 +785,9 @@ spec: format: int64 type: integer state: - description: The backing image backup creation state. Can be "", "InProgress", "Completed", "Error", "Unknown". + description: |- + The backing image backup creation state. + Can be "", "InProgress", "Completed", "Error", "Unknown". type: string url: description: The backing image backup URL. @@ -737,24 +798,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: backups.longhorn.io spec: @@ -795,10 +850,19 @@ spec: description: Backup is where Longhorn stores backup 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 @@ -838,10 +902,19 @@ spec: description: Backup is where Longhorn stores backup 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 @@ -910,7 +983,9 @@ spec: description: The snapshot name. type: string state: - description: The backup creation state. Can be "", "InProgress", "Completed", "Error", "Unknown". + description: |- + The backup creation state. + Can be "", "InProgress", "Completed", "Error", "Unknown". type: string url: description: The snapshot backup URL. @@ -933,24 +1008,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: backuptargets.longhorn.io spec: @@ -1003,10 +1072,19 @@ spec: description: BackupTarget is where Longhorn stores backup target 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 @@ -1046,10 +1124,19 @@ spec: description: BackupTarget is where Longhorn stores backup target 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 @@ -1094,7 +1181,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -1116,24 +1205,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: backupvolumes.longhorn.io spec: @@ -1170,10 +1253,19 @@ spec: description: BackupVolume is where Longhorn stores backup volume 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 @@ -1209,10 +1301,19 @@ spec: description: BackupVolume is where Longhorn stores backup volume 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 @@ -1283,24 +1384,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: engineimages.longhorn.io spec: @@ -1353,10 +1448,19 @@ spec: description: EngineImage is where Longhorn stores engine image 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 @@ -1370,6 +1474,10 @@ spec: subresources: status: {} - additionalPrinterColumns: + - description: Compatibility of the engine image + jsonPath: .status.incompatible + name: Incompatible + type: boolean - description: State of the engine image jsonPath: .status.state name: State @@ -1395,10 +1503,19 @@ spec: description: EngineImage is where Longhorn stores engine image 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 @@ -1436,7 +1553,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -1477,24 +1596,17 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: engines.longhorn.io spec: @@ -1506,6 +1618,7 @@ spec: shortNames: - lhe singular: engine + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -1534,10 +1647,19 @@ spec: description: Engine is where Longhorn stores engine 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 @@ -1580,10 +1702,19 @@ spec: description: Engine is where Longhorn stores engine 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 @@ -1593,7 +1724,7 @@ spec: active: type: boolean backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string backupVolume: type: string @@ -1706,7 +1837,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -1781,6 +1914,14 @@ spec: type: string nullable: true type: object + replicaTransitionTimeMap: + additionalProperties: + type: string + description: |- + ReplicaTransitionTimeMap records the time a replica in ReplicaModeMap transitions from one mode to another (or + from not being in the ReplicaModeMap to being in it). This information is sometimes required by other controllers + (e.g. the volume controller uses it to determine the correct value for replica.Spec.lastHealthyAt). + type: object restoreStatus: additionalProperties: properties: @@ -1852,24 +1993,17 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: instancemanagers.longhorn.io spec: @@ -1881,6 +2015,7 @@ spec: shortNames: - lhim singular: instancemanager + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -1905,10 +2040,19 @@ spec: description: InstanceManager is where Longhorn stores instance manager 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 @@ -1947,10 +2091,19 @@ spec: description: InstanceManager is where Longhorn stores instance manager 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 @@ -1977,10 +2130,6 @@ spec: type: integer apiVersion: type: integer - proxyApiMinVersion: - type: integer - proxyApiVersion: - type: integer currentState: type: string instanceEngines: @@ -1989,7 +2138,7 @@ spec: spec: properties: backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string dataEngine: type: string @@ -2001,6 +2150,7 @@ spec: conditions: additionalProperties: type: boolean + nullable: true type: object endpoint: type: string @@ -2031,7 +2181,7 @@ spec: spec: properties: backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string dataEngine: type: string @@ -2043,6 +2193,7 @@ spec: conditions: additionalProperties: type: boolean + nullable: true type: object endpoint: type: string @@ -2073,7 +2224,7 @@ spec: spec: properties: backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string dataEngine: type: string @@ -2085,6 +2236,7 @@ spec: conditions: additionalProperties: type: boolean + nullable: true type: object endpoint: type: string @@ -2107,37 +2259,35 @@ spec: type: string type: object type: object - nullable: true description: 'Deprecated: Replaced by InstanceEngines and InstanceReplicas' + nullable: true type: object ip: type: string ownerID: type: string + proxyApiMinVersion: + type: integer + proxyApiVersion: + type: integer type: object type: object served: true storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: nodes.longhorn.io spec: @@ -2186,10 +2336,19 @@ spec: description: Node is where Longhorn stores Longhorn 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 @@ -2224,10 +2383,19 @@ spec: description: Node is where Longhorn stores Longhorn 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 @@ -2235,7 +2403,6 @@ spec: description: NodeSpec defines the desired state of the Longhorn node properties: allowScheduling: - description: Allow scheduling replicas on the node. type: boolean disks: additionalProperties: @@ -2292,7 +2459,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2319,7 +2488,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2349,21 +2520,17 @@ spec: format: int64 type: integer type: object - description: The status of the disks on the node. nullable: true type: object region: - description: The Region of the node. type: string snapshotCheckStatus: - description: The status of the snapshot integrity check. properties: lastPeriodicCheckedAt: format: date-time type: string type: object zone: - description: The Zone of the node. type: string type: object type: object @@ -2371,24 +2538,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: orphans.longhorn.io spec: @@ -2417,10 +2578,19 @@ spec: description: Orphan is where Longhorn stores orphan 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 @@ -2431,7 +2601,9 @@ spec: description: The node ID on which the controller is responsible to reconcile this orphan CR. type: string orphanType: - description: The type of the orphaned data. Can be "replica". + description: |- + The type of the orphaned data. + Can be "replica". type: string parameters: additionalProperties: @@ -2458,7 +2630,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2474,19 +2648,13 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: longhorn-manager: "" @@ -2536,10 +2704,19 @@ spec: description: RecurringJob is where Longhorn stores recurring job 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 @@ -2586,10 +2763,19 @@ spec: description: RecurringJob is where Longhorn stores recurring job 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 @@ -2619,7 +2805,9 @@ spec: description: The retain count of the snapshot/backup. type: integer task: - description: The recurring job task. Can be "snapshot", "snapshot-force-create", "snapshot-cleanup", "snapshot-delete", "backup", "backup-force-create" or "filesystem-trim" + description: |- + The recurring job task. + Can be "snapshot", "snapshot-force-create", "snapshot-cleanup", "snapshot-delete", "backup", "backup-force-create" or "filesystem-trim" enum: - snapshot - snapshot-force-create @@ -2642,24 +2830,17 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: replicas.longhorn.io spec: @@ -2671,6 +2852,7 @@ spec: shortNames: - lhr singular: replica + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -2703,10 +2885,19 @@ spec: description: Replica is where Longhorn stores replica 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 @@ -2753,10 +2944,19 @@ spec: description: Replica is where Longhorn stores replica 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 @@ -2766,7 +2966,7 @@ spec: active: type: boolean backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`. type: string backingImage: type: string @@ -2791,13 +2991,44 @@ spec: evictionRequested: type: boolean failedAt: + description: |- + FailedAt is set when a running replica fails or when a running engine is unable to use a replica for any reason. + FailedAt indicates the time the failure occurred. When FailedAt is set, a replica is likely to have useful + (though possibly stale) data. A replica with FailedAt set must be rebuilt from a non-failed replica (or it can + be used in a salvage if all replicas are failed). FailedAt is cleared before a rebuild or salvage. FailedAt may + be later than the corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume + controller acknowledges the change. type: string hardNodeAffinity: type: string healthyAt: + description: |- + HealthyAt is set the first time a replica becomes read/write in an engine after creation or rebuild. HealthyAt + indicates the time the last successful rebuild occurred. When HealthyAt is set, a replica is likely to have + useful (though possibly stale) data. HealthyAt is cleared before a rebuild. HealthyAt may be later than the + corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume controller + acknowledges the change. type: string image: type: string + lastFailedAt: + description: |- + LastFailedAt is always set at the same time as FailedAt. Unlike FailedAt, LastFailedAt is never cleared. + LastFailedAt is not a reliable indicator of the state of a replica's data. For example, a replica with + LastFailedAt may already be healthy and in use again. However, because it is never cleared, it can be compared to + LastHealthyAt to help prevent dangerous replica deletion in some corner cases. LastFailedAt may be later than the + corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume controller + acknowledges the change. + type: string + lastHealthyAt: + description: |- + LastHealthyAt is set every time a replica becomes read/write in an engine. Unlike HealthyAt, LastHealthyAt is + never cleared. LastHealthyAt is not a reliable indicator of the state of a replica's data. For example, a + replica with LastHealthyAt set may be in the middle of a rebuild. However, because it is never cleared, it can be + compared to LastFailedAt to help prevent dangerous replica deletion in some corner cases. LastHealthyAt may be + later than the corresponding entry in an engine's replicaTransitionTimeMap because it is set when the volume + controller acknowledges the change. + type: string logRequested: type: boolean nodeID: @@ -2840,7 +3071,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -2877,24 +3110,17 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null + controller-gen.kubebuilder.io/version: v0.15.0 labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: settings.longhorn.io spec: @@ -2906,6 +3132,7 @@ spec: shortNames: - lhs singular: setting + preserveUnknownFields: false scope: Namespaced versions: - additionalPrinterColumns: @@ -2922,10 +3149,19 @@ spec: description: Setting is where Longhorn stores setting 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 @@ -2952,10 +3188,19 @@ spec: description: Setting is where Longhorn stores setting 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 @@ -2969,24 +3214,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: sharemanagers.longhorn.io spec: @@ -3018,10 +3257,19 @@ spec: description: ShareManager is where Longhorn stores share manager 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 @@ -3052,10 +3300,19 @@ spec: description: ShareManager is where Longhorn stores share manager 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 @@ -3084,24 +3341,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: snapshots.longhorn.io spec: @@ -3145,10 +3396,19 @@ spec: description: Snapshot is the Schema for the snapshots API 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 @@ -3165,7 +3425,10 @@ spec: nullable: true type: object volume: - description: the volume that this snapshot belongs to. This field is immutable after creation. Required + description: |- + the volume that this snapshot belongs to. + This field is immutable after creation. + Required type: string required: - volume @@ -3211,24 +3474,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: supportbundles.longhorn.io spec: @@ -3264,10 +3521,19 @@ spec: description: SupportBundle is where Longhorn stores support bundle 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 @@ -3306,7 +3572,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3337,24 +3605,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: systembackups.longhorn.io spec: @@ -3391,10 +3653,19 @@ spec: description: SystemBackup is where Longhorn stores system backup 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 @@ -3402,7 +3673,9 @@ spec: description: SystemBackupSpec defines the desired state of the Longhorn SystemBackup properties: volumeBackupPolicy: - description: The create volume backup policy Can be "if-not-present", "always" or "disabled" + description: |- + The create volume backup policy + Can be "if-not-present", "always" or "disabled" nullable: true type: string type: object @@ -3425,7 +3698,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3465,24 +3740,18 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 creationTimestamp: null labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: systemrestores.longhorn.io spec: @@ -3510,10 +3779,19 @@ spec: description: SystemRestore is where Longhorn stores system restore 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 @@ -3545,7 +3823,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3568,23 +3848,157 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/crds.yaml apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.7.0 + controller-gen.kubebuilder.io/version: v0.15.0 + creationTimestamp: null + labels: + app.kubernetes.io/name: longhorn + app.kubernetes.io/instance: longhorn + app.kubernetes.io/version: v1.6.4 + longhorn-manager: "" + name: volumeattachments.longhorn.io +spec: + group: longhorn.io + names: + kind: VolumeAttachment + listKind: VolumeAttachmentList + plural: volumeattachments + shortNames: + - lhva + singular: volumeattachment + scope: Namespaced + versions: + - additionalPrinterColumns: + - jsonPath: .metadata.creationTimestamp + name: Age + type: date + name: v1beta2 + schema: + openAPIV3Schema: + description: VolumeAttachment stores attachment information of a Longhorn volume + properties: + apiVersion: + description: |- + APIVersion defines the versioned schema of this representation of an object. + Servers should convert recognized schemas to the latest internal value, and + may reject unrecognized values. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources + type: string + kind: + description: |- + Kind is a string value representing the REST resource this object represents. + Servers may infer this from the endpoint the client submits requests to. + Cannot be updated. + In CamelCase. + More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds + type: string + metadata: + type: object + spec: + description: VolumeAttachmentSpec defines the desired state of Longhorn VolumeAttachment + properties: + attachmentTickets: + additionalProperties: + properties: + generation: + description: |- + A sequence number representing a specific generation of the desired state. + Populated by the system. Read-only. + format: int64 + type: integer + id: + description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. + type: string + nodeID: + description: The node that this attachment is requesting + type: string + parameters: + additionalProperties: + type: string + description: Optional additional parameter for this attachment + type: object + type: + type: string + type: object + type: object + volume: + description: The name of Longhorn volume of this VolumeAttachment + type: string + required: + - volume + type: object + status: + description: VolumeAttachmentStatus defines the observed state of Longhorn VolumeAttachment + properties: + attachmentTicketStatuses: + additionalProperties: + properties: + conditions: + description: Record any error when trying to fulfill this attachment + items: + properties: + lastProbeTime: + description: Last time we probed the condition. + type: string + lastTransitionTime: + description: Last time the condition transitioned from one status to another. + type: string + message: + description: Human-readable message indicating details about last transition. + type: string + reason: + description: Unique, one-word, CamelCase reason for the condition's last transition. + type: string + status: + description: |- + Status is the status of the condition. + Can be True, False, Unknown. + type: string + type: + description: Type is the type of the condition. + type: string + type: object + nullable: true + type: array + generation: + description: |- + A sequence number representing a specific generation of the desired state. + Populated by the system. Read-only. + format: int64 + type: integer + id: + description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. + type: string + satisfied: + description: Indicate whether this attachment ticket has been satisfied + type: boolean + required: + - conditions + - satisfied + type: object + type: object + type: object + type: object + served: true + storage: true + subresources: + status: {} +--- +# Source: longhorn/templates/crds.yaml +apiVersion: apiextensions.k8s.io/v1 +kind: CustomResourceDefinition +metadata: + annotations: + controller-gen.kubebuilder.io/version: v0.15.0 labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 longhorn-manager: "" name: volumes.longhorn.io spec: @@ -3641,10 +4055,19 @@ spec: description: Volume is where Longhorn stores volume 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 @@ -3691,10 +4114,19 @@ spec: description: Volume is where Longhorn stores volume 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 @@ -3709,7 +4141,7 @@ spec: - rwx type: string backendStoreDriver: - description: 'Deprecated: Replaced by field `dataEngine`.' + description: Deprecated:Replaced by field `dataEngine`.' type: string backingImage: type: string @@ -3866,7 +4298,9 @@ spec: description: Unique, one-word, CamelCase reason for the condition's last transition. type: string status: - description: Status is the status of the condition. Can be True, False, Unknown. + description: |- + Status is the status of the condition. + Can be True, False, Unknown. type: string type: description: Type is the type of the condition. @@ -3951,143 +4385,6 @@ spec: storage: true subresources: status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] ---- -# Source: longhorn/templates/crds.yaml -apiVersion: apiextensions.k8s.io/v1 -kind: CustomResourceDefinition -metadata: - annotations: - controller-gen.kubebuilder.io/version: v0.7.0 - creationTimestamp: null - labels: - app.kubernetes.io/name: longhorn - app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev - longhorn-manager: "" - name: volumeattachments.longhorn.io -spec: - group: longhorn.io - names: - kind: VolumeAttachment - listKind: VolumeAttachmentList - plural: volumeattachments - shortNames: - - lhva - singular: volumeattachment - scope: Namespaced - versions: - - additionalPrinterColumns: - - jsonPath: .metadata.creationTimestamp - name: Age - type: date - name: v1beta2 - schema: - openAPIV3Schema: - description: VolumeAttachment stores attachment information of a Longhorn volume - properties: - apiVersion: - description: 'APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources' - type: string - kind: - description: 'Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds' - type: string - metadata: - type: object - spec: - description: VolumeAttachmentSpec defines the desired state of Longhorn VolumeAttachment - properties: - attachmentTickets: - additionalProperties: - properties: - generation: - description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - format: int64 - type: integer - id: - description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. - type: string - nodeID: - description: The node that this attachment is requesting - type: string - parameters: - additionalProperties: - type: string - description: Optional additional parameter for this attachment - type: object - type: - type: string - type: object - type: object - volume: - description: The name of Longhorn volume of this VolumeAttachment - type: string - required: - - volume - type: object - status: - description: VolumeAttachmentStatus defines the observed state of Longhorn VolumeAttachment - properties: - attachmentTicketStatuses: - additionalProperties: - properties: - conditions: - description: Record any error when trying to fulfill this attachment - items: - properties: - lastProbeTime: - description: Last time we probed the condition. - type: string - lastTransitionTime: - description: Last time the condition transitioned from one status to another. - type: string - message: - description: Human-readable message indicating details about last transition. - type: string - reason: - description: Unique, one-word, CamelCase reason for the condition's last transition. - type: string - status: - description: Status is the status of the condition. Can be True, False, Unknown. - type: string - type: - description: Type is the type of the condition. - type: string - type: object - nullable: true - type: array - generation: - description: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only. - format: int64 - type: integer - id: - description: The unique ID of this attachment. Used to differentiate different attachments of the same volume. - type: string - satisfied: - description: Indicate whether this attachment ticket has been satisfied - type: boolean - required: - - conditions - - satisfied - type: object - type: object - type: object - type: object - served: true - storage: true - subresources: - status: {} -status: - acceptedNames: - kind: "" - plural: "" - conditions: [] - storedVersions: [] --- # Source: longhorn/templates/clusterrole.yaml apiVersion: rbac.authorization.k8s.io/v1 @@ -4097,7 +4394,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 rules: - apiGroups: - apiextensions.k8s.io @@ -4163,7 +4460,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole @@ -4181,7 +4478,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 roleRef: apiGroup: rbac.authorization.k8s.io kind: ClusterRole @@ -4198,13 +4495,12 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-manager name: longhorn-backend namespace: longhorn-system spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: @@ -4219,7 +4515,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-ui name: longhorn-frontend namespace: longhorn-system @@ -4240,13 +4536,12 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-conversion-webhook name: longhorn-conversion-webhook namespace: longhorn-system spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: @@ -4261,13 +4556,12 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-admission-webhook name: longhorn-admission-webhook namespace: longhorn-system spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: @@ -4282,13 +4576,12 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-recovery-backend name: longhorn-recovery-backend namespace: longhorn-system spec: type: ClusterIP - sessionAffinity: ClientIP selector: app: longhorn-manager ports: @@ -4296,38 +4589,6 @@ spec: port: 9503 targetPort: recov-backend --- -# Source: longhorn/templates/services.yaml -apiVersion: v1 -kind: Service -metadata: - labels: - app.kubernetes.io/name: longhorn - app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev - name: longhorn-engine-manager - namespace: longhorn-system -spec: - clusterIP: None - selector: - longhorn.io/component: instance-manager - longhorn.io/instance-manager-type: engine ---- -# Source: longhorn/templates/services.yaml -apiVersion: v1 -kind: Service -metadata: - labels: - app.kubernetes.io/name: longhorn - app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev - name: longhorn-replica-manager - namespace: longhorn-system -spec: - clusterIP: None - selector: - longhorn.io/component: instance-manager - longhorn.io/instance-manager-type: replica ---- # Source: longhorn/templates/daemonset-sa.yaml apiVersion: apps/v1 kind: DaemonSet @@ -4335,7 +4596,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-manager name: longhorn-manager namespace: longhorn-system @@ -4348,12 +4609,12 @@ spec: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-manager spec: containers: - name: longhorn-manager - image: longhornio/longhorn-manager:master-head + image: longhornio/longhorn-manager:v1.6.4 imagePullPolicy: IfNotPresent securityContext: privileged: true @@ -4362,17 +4623,17 @@ spec: - -d - daemon - --engine-image - - "longhornio/longhorn-engine:master-head" + - "longhornio/longhorn-engine:v1.6.4" - --instance-manager-image - - "longhornio/longhorn-instance-manager:master-head" + - "longhornio/longhorn-instance-manager:v1.6.4" - --share-manager-image - - "longhornio/longhorn-share-manager:master-head" + - "longhornio/longhorn-share-manager:v1.6.4" - --backing-image-manager-image - - "longhornio/backing-image-manager:master-head" + - "longhornio/backing-image-manager:v1.6.4" - --support-bundle-manager-image - - "longhornio/support-bundle-kit:v0.0.33" + - "longhornio/support-bundle-kit:v0.0.48" - --manager-image - - "longhornio/longhorn-manager:master-head" + - "longhornio/longhorn-manager:v1.6.4" - --service-account - longhorn-service-account - --upgrade-version-check @@ -4442,7 +4703,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 spec: replicas: 1 selector: @@ -4453,23 +4714,23 @@ spec: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-driver-deployer spec: initContainers: - name: wait-longhorn-manager - image: longhornio/longhorn-manager:master-head + image: longhornio/longhorn-manager:v1.6.4 command: ['sh', '-c', 'while [ $(curl -m 1 -s -o /dev/null -w "%{http_code}" http://longhorn-backend:9500/v1) != "200" ]; do echo waiting; sleep 2; done'] containers: - name: longhorn-driver-deployer - image: longhornio/longhorn-manager:master-head + image: longhornio/longhorn-manager:v1.6.4 imagePullPolicy: IfNotPresent command: - longhorn-manager - -d - deploy-driver - --manager-image - - "longhornio/longhorn-manager:master-head" + - "longhornio/longhorn-manager:v1.6.4" - --manager-url - http://longhorn-backend:9500/v1 env: @@ -4486,17 +4747,17 @@ spec: fieldRef: fieldPath: spec.serviceAccountName - name: CSI_ATTACHER_IMAGE - value: "longhornio/csi-attacher:v4.4.2" + value: "longhornio/csi-attacher:v4.7.0-20241219" - name: CSI_PROVISIONER_IMAGE - value: "longhornio/csi-provisioner:v3.6.2" + value: "longhornio/csi-provisioner:v3.6.4-20241219" - name: CSI_NODE_DRIVER_REGISTRAR_IMAGE - value: "longhornio/csi-node-driver-registrar:v2.9.2" + value: "longhornio/csi-node-driver-registrar:v2.12.0-20241219" - name: CSI_RESIZER_IMAGE - value: "longhornio/csi-resizer:v1.9.2" + value: "longhornio/csi-resizer:v1.12.0-20241219" - name: CSI_SNAPSHOTTER_IMAGE - value: "longhornio/csi-snapshotter:v6.3.2" + value: "longhornio/csi-snapshotter:v6.3.4-20241219" - name: CSI_LIVENESS_PROBE_IMAGE - value: "longhornio/livenessprobe:v2.11.0" + value: "longhornio/livenessprobe:v2.14.0-20241219" priorityClassName: "longhorn-critical" serviceAccountName: longhorn-service-account securityContext: @@ -4509,7 +4770,7 @@ metadata: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-ui name: longhorn-ui namespace: longhorn-system @@ -4523,7 +4784,7 @@ spec: labels: app.kubernetes.io/name: longhorn app.kubernetes.io/instance: longhorn - app.kubernetes.io/version: v1.6.0-dev + app.kubernetes.io/version: v1.6.4 app: longhorn-ui spec: serviceAccountName: longhorn-ui-service-account @@ -4541,7 +4802,7 @@ spec: topologyKey: kubernetes.io/hostname containers: - name: longhorn-ui - image: longhornio/longhorn-ui:master-head + image: longhornio/longhorn-ui:v1.6.4 imagePullPolicy: IfNotPresent volumeMounts: - name : nginx-cache diff --git a/deploy/prerequisite/longhorn-spdk-setup.yaml b/deploy/prerequisite/longhorn-spdk-setup.yaml index 76d333b8b4..397fb3bd0c 100644 --- a/deploy/prerequisite/longhorn-spdk-setup.yaml +++ b/deploy/prerequisite/longhorn-spdk-setup.yaml @@ -5,7 +5,7 @@ metadata: labels: app: longhorn-spdk-setup annotations: - command: &cmd OS=$(grep -E "^ID_LIKE=" /etc/os-release | cut -d '=' -f 2); if [[ -z "${OS}" ]]; then OS=$(grep -E "^ID=" /etc/os-release | cut -d '=' -f 2); fi; if [[ "${OS}" == *"debian"* ]]; then sudo apt-get update -q -y && sudo apt-get install -q -y git; elif [[ "${OS}" == *"suse"* ]]; then sudo zypper --gpg-auto-import-keys -q refresh && sudo zypper --gpg-auto-import-keys -q install -y git; else sudo yum makecache -q -y && sudo yum --setopt=tsflags=noscripts install -q -y git; fi && if [ $? -eq 0 ]; then echo "git install successfully"; else echo "git install failed error code $?"; fi && rm -rf ${SPDK_DIR}; git clone -b longhorn https://github.com/longhorn/spdk.git ${SPDK_DIR} && bash ${SPDK_DIR}/scripts/setup.sh ${SPDK_OPTION}; if [ $? -eq 0 ]; then echo "vm.nr_hugepages=$((HUGEMEM/2))" >> /etc/sysctl.conf; echo "SPDK environment is configured successfully"; else echo "Failed to configure SPDK environment error code $?"; fi; rm -rf ${SPDK_DIR} + command: &cmd OS=$(grep -E "^ID_LIKE=" /etc/os-release | cut -d '=' -f 2); if [[ -z "${OS}" ]]; then OS=$(grep -E "^ID=" /etc/os-release | cut -d '=' -f 2); fi; if [[ "${OS}" == *"debian"* ]]; then sudo apt-get update -q -y && sudo apt-get install -q -y git; elif [[ "${OS}" == *"suse"* ]]; then sudo zypper --gpg-auto-import-keys -q refresh && sudo zypper --gpg-auto-import-keys -q install -y git; else sudo yum makecache -q -y && sudo yum --setopt=tsflags=noscripts install -q -y git; fi && if [ $? -eq 0 ]; then echo "git install successfully"; else echo "git install failed error code $?"; fi && rm -rf ${SPDK_DIR}; git clone -b longhorn-1.6 https://github.com/longhorn/spdk.git ${SPDK_DIR} && bash ${SPDK_DIR}/scripts/setup.sh ${SPDK_OPTION}; if [ $? -eq 0 ]; then echo "vm.nr_hugepages=$((HUGEMEM/2))" >> /etc/sysctl.conf; echo "SPDK environment is configured successfully"; else echo "Failed to configure SPDK environment error code $?"; fi; rm -rf ${SPDK_DIR} spec: selector: matchLabels: diff --git a/enhancements/20230417-extend-csi-snapshot-to-support-backingimage.md b/enhancements/20230417-extend-csi-snapshot-to-support-backingimage.md index ffc4866a3d..28483ebe66 100644 --- a/enhancements/20230417-extend-csi-snapshot-to-support-backingimage.md +++ b/enhancements/20230417-extend-csi-snapshot-to-support-backingimage.md @@ -309,7 +309,7 @@ https://longhorn.io/docs/1.4.1/snapshots-and-backups/csi-snapshot-support/enable type: bi ``` -#### Scenerios 1: Create VolumeSnapshot from a Volume +#### Scenarios 1: Create VolumeSnapshot from a Volume - Success 1. Create a Volume `test-vol` of 5GB. Create PV/PVC for the Volume. @@ -333,7 +333,7 @@ https://longhorn.io/docs/1.4.1/snapshots-and-backups/csi-snapshot-support/enable 5. Delete the VolumeSnapshot `test-snapshot-backing` 6. Verify the BacingImage is deleted -#### Scenerios 2: Create new Volume from CSI snapshot +#### Scenarios 2: Create new Volume from CSI snapshot 1. Create a Volume `test-vol` of 5GB. Create PV/PVC for the Volume. 2. Create a workload using the Volume. Write some data to the Volume. @@ -370,7 +370,7 @@ https://longhorn.io/docs/1.4.1/snapshots-and-backups/csi-snapshot-support/enable 5. Attach the PVC `test-restore-pvc` to a workload and verify the data 6. Delete the PVC -#### Scenerios 3: Restore pre-provisioned BackingImage +#### Scenarios 3: Restore pre-provisioned BackingImage 1. Create a BackingImage `test-bi` using longhorn test raw image `https://longhorn-backing-image.s3-us-west-1.amazonaws.com/parrot.qcow2` 2. Create a VolumeSnapshotContent with `snapshotHandle` pointing to BackingImage `test-bi` and provide the parameters. @@ -420,7 +420,7 @@ https://longhorn.io/docs/1.4.1/snapshots-and-backups/csi-snapshot-support/enable ``` 5. Attach the PVC `test-restore-existing-backing` to a workload and verify the data -#### Scenerios 4: Restore on-demand provisioning BackingImage +#### Scenarios 4: Restore on-demand provisioning BackingImage - Type `download` 1. Create a VolumeSnapshotContent with `snapshotHandle` providing the required parameters and BackingImage name `test-bi` diff --git a/examples/pod_with_gev.yaml b/examples/pod_with_gev.yaml new file mode 100644 index 0000000000..57cae3820a --- /dev/null +++ b/examples/pod_with_gev.yaml @@ -0,0 +1,34 @@ +apiVersion: v1 +kind: Pod +metadata: + name: volume-test + namespace: default +spec: + restartPolicy: Always + containers: + - name: volume-test + image: nginx:stable-alpine + imagePullPolicy: IfNotPresent + livenessProbe: + exec: + command: + - ls + - /data/lost+found + initialDelaySeconds: 5 + periodSeconds: 5 + volumeMounts: + - name: volv + mountPath: /data + ports: + - containerPort: 80 + volumes: + - name: volv + ephemeral: + volumeClaimTemplate: + spec: + accessModes: + - ReadWriteOnce + storageClassName: longhorn + resources: + requests: + storage: 2Gi diff --git a/scripts/environment_check.sh b/scripts/environment_check.sh index 7a60b1c0fd..84ec669f5b 100755 --- a/scripts/environment_check.sh +++ b/scripts/environment_check.sh @@ -79,23 +79,23 @@ set_packages_and_check_cmd() { case $OS in *"debian"* | *"ubuntu"* ) CHECK_CMD='dpkg -l | grep -w' - PACKAGES=(nfs-common open-iscsi) + PACKAGES=(nfs-common open-iscsi cryptsetup dmsetup) ;; *"centos"* | *"fedora"* | *"rocky"* | *"ol"* ) CHECK_CMD='rpm -q' - PACKAGES=(nfs-utils iscsi-initiator-utils) + PACKAGES=(nfs-utils iscsi-initiator-utils cryptsetup device-mapper) ;; *"suse"* ) CHECK_CMD='rpm -q' - PACKAGES=(nfs-client open-iscsi) + PACKAGES=(nfs-client open-iscsi cryptsetup device-mapper) ;; *"arch"* ) CHECK_CMD='pacman -Q' - PACKAGES=(nfs-utils open-iscsi) + PACKAGES=(nfs-utils open-iscsi cryptsetup device-mapper) ;; *"gentoo"* ) CHECK_CMD='qlist -I' - PACKAGES=(net-fs/nfs-utils sys-block/open-iscsi) + PACKAGES=(net-fs/nfs-utils sys-block/open-iscsi sys-fs/cryptsetup sys-fs/lvm2) ;; *) CHECK_CMD='' @@ -291,18 +291,33 @@ verlt() { ! verlte "$2" "$1" } +kernel_in_range() { + verlte "$2" "$1" && verlt "$1" "$3" +} + check_kernel_release() { local pod=$1 + local node=$(kubectl get ${pod} --no-headers -o=custom-columns=:.spec.nodeName) recommended_kernel_release="5.8" local kernel=$(detect_node_kernel_release ${pod}) if verlt "$kernel" "$recommended_kernel_release" ; then - local node=$(kubectl get ${pod} --no-headers -o=custom-columns=:.spec.nodeName) warn "Node $node has outdated kernel release: $kernel. Recommending kernel release >= $recommended_kernel_release" return 1 fi + + local broken_kernel=("5.15.0-94" "6.5.6") + local fixed_kernel=("5.15.0-100" "6.5.7") + + for i in ${!broken_kernel[@]}; do + if kernel_in_range "$kernel" "${broken_kernel[$i]}" "${fixed_kernel[$i]}" ; then + warn "Node $node has a kernel version $kernel known to have a breakage that affects Longhorn. See description and solution at https://longhorn.io/kb/troubleshooting-rwx-volume-fails-to-attached-caused-by-protocol-not-supported" + return 1 + fi + done + } check_iscsid() { @@ -313,10 +328,11 @@ check_iscsid() { kubectl exec ${pod} -- nsenter --mount=/proc/1/ns/mnt -- bash -c "systemctl status --no-pager iscsid.socket" > /dev/null 2>&1 if [ $? -ne 0 ]; then node=$(kubectl get ${pod} --no-headers -o=custom-columns=:.spec.nodeName) - error "Neither iscsid.service nor iscsid.socket is not running on ${node}" + error "Neither iscsid.service nor iscsid.socket is running on ${node}" return 1 fi fi + check_kernel_module ${pod} CONFIG_ISCSI_TCP iscsi_tcp } check_multipathd() { @@ -325,7 +341,7 @@ check_multipathd() { kubectl exec $pod -- nsenter --mount=/proc/1/ns/mnt -- bash -c "systemctl status --no-pager multipathd.service" > /dev/null 2>&1 if [ $? = 0 ]; then node=$(kubectl get ${pod} --no-headers -o=custom-columns=:.spec.nodeName) - warn "multipathd is running on ${node}" + warn "multipathd is running on ${node} known to have a breakage that affects Longhorn. See description and solution at https://longhorn.io/kb/troubleshooting-volume-with-multipath" return 1 fi } @@ -372,6 +388,7 @@ check_nfs_client() { return 1 fi + local nfs_module_not_found=1 for option in "${options[@]}"; do kubectl exec ${pod} -- nsenter --mount=/proc/1/ns/mnt -- bash -c "[ -f /boot/config-${kernel} ]" > /dev/null 2>&1 if [ $? -ne 0 ]; then @@ -380,13 +397,27 @@ check_nfs_client() { fi check_kernel_module ${pod} ${option} nfs - if [ $? = 0 ]; then - return 0 + nfs_module_not_found=$? + if [ $nfs_module_not_found = 0 ]; then + break fi done - error "NFS clients ${options[*]} should be enabled at least one." - return 1 + if [ $nfs_module_not_found -ne 0 ]; then + error "NFS clients ${options[*]} not found. At least one should be enabled" + return 1 + fi + + local nfs_ver_overriden=$(kubectl exec ${pod} -- nsenter --mount=/proc/1/ns/mnt -- bash -c "grep '^\s*Defaultvers=' /etc/nfsmount.conf" 2> /dev/null) + if [ "$nfs_ver_overriden" ]; then + echo "$nfs_ver_overriden" | grep -x '.*Defaultvers=4\(\.[0-2]\?\)\?\s*' + if [ $? -ne 0 ]; then + error "NFS4 is supported, but default protocol version (${nfs_ver_overriden}) is not 4, 4.1, or 4.2. Please refer to the NFS mount configuration manual page for more information: man 5 nfsmount.conf" + return 1 + fi + fi + + return 0 } check_kernel_module() { diff --git a/scripts/restore-backup-to-file.sh b/scripts/restore-backup-to-file.sh index 3756512e6a..199567006f 100755 --- a/scripts/restore-backup-to-file.sh +++ b/scripts/restore-backup-to-file.sh @@ -19,6 +19,8 @@ usage () { echo " -v, --version (Required) Longhorn version, e.g., v1.3.2" echo " --aws-access-key (Optional) AWS credentials access key" echo " --aws-secret-access-key (Optional) AWS credentials access secret key" + echo " --cifs-username (Optional) CIFS credentials username" + echo " --cifs-password (Optional) CIFS credentials password" echo " -b, --backing-file (Optional) backing image. e.g., /tmp/backingfile.qcow2" echo " -h, --help Usage message" } @@ -42,6 +44,16 @@ while [[ "$#" -gt 0 ]]; do shift # past argument shift # past value ;; + --cifs-username) + cifs_username="$2" + shift # past argument + shift # past value + ;; + --cifs-password) + cifs_password="$2" + shift # past argument + shift # past value + ;; -u|--backup-url) backup_url="$2" shift # past argument @@ -92,7 +104,10 @@ fi if [[ "${backup_url}" =~ ^[Ss]3 ]]; then CUSTOMIZED_ARGS="-e AWS_ACCESS_KEY_ID="${aws_access_key}" -e AWS_SECRET_ACCESS_KEY="${aws_secret_access_key}" " else - CUSTOMIZED_ARGS="--cap-add SYS_ADMIN --security-opt apparmor:unconfined" + CUSTOMIZED_ARGS="--cap-add SYS_ADMIN --security-opt apparmor:unconfined --cap-add DAC_READ_SEARCH" +fi +if [[ "${backup_url}" =~ ^cifs ]]; then + CUSTOMIZED_ARGS+=" -e CIFS_USERNAME=${cifs_username} -e CIFS_PASSWORD=${cifs_password} " fi # Start restoring a backup to an image file. diff --git a/uninstall/uninstall.yaml b/uninstall/uninstall.yaml index abeefe88d1..77ec258763 100644 --- a/uninstall/uninstall.yaml +++ b/uninstall/uninstall.yaml @@ -66,7 +66,7 @@ rules: - apiGroups: ["longhorn.io"] resources: ["volumes", "engines", "replicas", "settings", "engineimages", "nodes", "instancemanagers", "sharemanagers", "backingimages", "backingimagemanagers", "backingimagedatasources", "backuptargets", "backupvolumes", "backups", - "recurringjobs", "orphans", "snapshots", "supportbundles", "systembackups", "systemrestores", "volumeattachments"] + "recurringjobs", "orphans", "snapshots", "supportbundles", "systembackups", "systemrestores", "volumeattachments", "backupbackingimages"] verbs: ["*"] - apiGroups: ["coordination.k8s.io"] resources: ["leases"] @@ -106,7 +106,7 @@ spec: spec: containers: - name: longhorn-uninstall - image: longhornio/longhorn-manager:master-head + image: longhornio/longhorn-manager:v1.6.4 imagePullPolicy: IfNotPresent command: - longhorn-manager