Skip to content

deprecate: driver.spec.EnableMetadata field #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
iPraveenParihar wants to merge 2 commits into
base: main
Choose a base branch
from
Open

deprecate: driver.spec.EnableMetadata field #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0ce064
deprecate: mark EnableMetadata field as deprecated in DriverSpec API
iPraveenParihar Apr 21, 2026
dc6c4e3
cleanup: remove --setmetadata ceph-csi container flag
iPraveenParihar Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions api/v1/driver_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -291,9 +291,8 @@ type DriverSpec struct {
//+kubebuilder:validation:Optional
ClusterName *string `json:"clusterName,omitempty"`

// Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
// Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
// Hence enable metadata is false by default.
// Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
// It will be removed in a future release.
//+kubebuilder:validation:Optional
EnableMetadata *bool `json:"enableMetadata,omitempty"`
Copy link
Copy Markdown
Member

@travisn travisn Apr 17, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing CRD settings is a breaking change. Consider leaving this setting here, just deprecate it and only remove the internal code that calls the --setmetadata flag.

Copy link
Copy Markdown
Contributor Author

@iPraveenParihar iPraveenParihar Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking it is okay to remove since we are still at pre v1.0.0 release?

Copy link
Copy Markdown
Collaborator

@Madhu-1 Madhu-1 Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets not remove the CRD setting, we can mark this as deprecated and add a notice that the feature is enabled by default in csi now

Copy link
Copy Markdown
Member

@travisn travisn Apr 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking it is okay to remove since we are still at pre v1.0.0 release?

Since we are shipping already in stable upstream and downstream releases, we need to anyway treat it as v1.

Copy link
Copy Markdown
Contributor Author

@iPraveenParihar iPraveenParihar Apr 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

understood, will add deprecation notice and keep the field.


Expand Down
5 changes: 2 additions & 3 deletions config/crd/bases/csi.ceph.io_drivers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3650,9 +3650,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down
5 changes: 2 additions & 3 deletions config/crd/bases/csi.ceph.io_operatorconfigs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3688,9 +3688,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down
10 changes: 4 additions & 6 deletions deploy/all-in-one/install.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4201,9 +4201,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down Expand Up @@ -18584,9 +18583,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down
10 changes: 0 additions & 10 deletions deploy/charts/ceph-csi-drivers/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ operatorConfig:
name: ""
# -- Cluster name identifier (default: "")
clusterName: ""
# -- Flag to enable metadata (default: false)
enableMetadata: false
# -- gRPC timeout in seconds (default: 30)
grpcTimeout: 30
# -- Snapshot policy (options: none, volumeGroupSnapshot, volumeSnapshot) (default: "none")
Expand Down Expand Up @@ -141,8 +139,6 @@ drivers:
name: ""
# -- Cluster name identifier (default: "")
clusterName: ""
# -- Flag to enable metadata (default: false)
enableMetadata: false
# -- gRPC timeout in seconds (default: 30)
grpcTimeout: 30
# -- Snapshot policy (options: none, volumeGroupSnapshot, volumeSnapshot) (default: "none")
Expand Down Expand Up @@ -218,8 +214,6 @@ drivers:
name: ""
# -- Cluster name identifier (default: "")
clusterName: ""
# -- Flag to enable metadata (default: false)
enableMetadata: false
# -- gRPC timeout in seconds (default: 30)
grpcTimeout: 30
# -- Snapshot policy (options: none, volumeGroupSnapshot, volumeSnapshot) (default: "none")
Expand Down Expand Up @@ -295,8 +289,6 @@ drivers:
name: ""
# -- Cluster name identifier (default: "")
clusterName: ""
# -- Flag to enable metadata (default: false)
enableMetadata: false
# -- gRPC timeout in seconds (default: 30)
grpcTimeout: 30
# -- Snapshot policy (options: none, volumeGroupSnapshot, volumeSnapshot) (default: "volumeSnapshot")
Expand Down Expand Up @@ -372,8 +364,6 @@ drivers:
name: ""
# -- Cluster name identifier (default: "")
clusterName: ""
# -- Flag to enable metadata (default: false)
enableMetadata: false
# -- gRPC timeout in seconds (default: 30)
grpcTimeout: 30
# -- Snapshot policy (options: none, volumeGroupSnapshot, volumeSnapshot) (default: "volumeSnapshot")
Expand Down
5 changes: 2 additions & 3 deletions deploy/charts/ceph-csi-operator/templates/driver-crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3647,9 +3647,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down
5 changes: 2 additions & 3 deletions deploy/charts/ceph-csi-operator/templates/operatorconfig-crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3677,9 +3677,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down
10 changes: 4 additions & 6 deletions deploy/multifile/crd.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4192,9 +4192,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down Expand Up @@ -18575,9 +18574,8 @@ spec:
type: boolean
enableMetadata:
description: |-
Set to true to enable adding volume metadata on the CephFS subvolumes and RBD images.
Not all users might be interested in getting volume/snapshot details as metadata on CephFS subvolume and RBD images.
Hence enable metadata is false by default.
Deprecated: This field is no longer used by the ceph-csi driver and will be ignored.
It will be removed in a future release.
type: boolean
encryption:
description: Driver's encryption settings
Expand Down
5 changes: 0 additions & 5 deletions docs/helm-charts/drivers-chart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ The following table lists the configurable parameters of the ceph-csi-drivers ch
| `drivers.cephfs.controllerPlugin.resources` | Resource requirements for controller plugin containers (default: {}) | `{}` |
| `drivers.cephfs.controllerPlugin.tolerations` | List of tolerations for the controller plugin (default: []) | `[]` |
| `drivers.cephfs.deployCsiAddons` | Flag to deploy CSI Addons (default: false) | `false` |
| `drivers.cephfs.enableMetadata` | Flag to enable metadata (default: false) | `false` |
| `drivers.cephfs.enabled` | Enable the CephFS driver (default: true) | `true` |
| `drivers.cephfs.encryption.configMapRef.name` | Name of the ConfigMap for encryption settings (default: "") | `""` |
| `drivers.cephfs.fsGroupPolicy` | File system group policy (e.g., "None", "ReadWriteOnceWithFSType") (default: "None") | `"None"` |
Expand Down Expand Up @@ -100,7 +99,6 @@ The following table lists the configurable parameters of the ceph-csi-drivers ch
| `drivers.nfs.controllerPlugin.resources` | Resource requirements for controller plugin containers (default: {}) | `{}` |
| `drivers.nfs.controllerPlugin.tolerations` | List of tolerations for the controller plugin (default: []) | `[]` |
| `drivers.nfs.deployCsiAddons` | Flag to deploy CSI Addons (default: false) | `false` |
| `drivers.nfs.enableMetadata` | Flag to enable metadata (default: false) | `false` |
| `drivers.nfs.enabled` | Enable the NFS driver (default: true) | `true` |
| `drivers.nfs.encryption.configMapRef.name` | Name of the ConfigMap for encryption settings (default: "") | `""` |
| `drivers.nfs.fsGroupPolicy` | File system group policy (e.g., "None", "ReadWriteOnceWithFSType") (default: "None") | `"None"` |
Expand Down Expand Up @@ -134,7 +132,6 @@ The following table lists the configurable parameters of the ceph-csi-drivers ch
| `drivers.nvmeof.controllerPlugin.resources` | Resource requirements for controller plugin containers (default: {}) | `{}` |
| `drivers.nvmeof.controllerPlugin.tolerations` | List of tolerations for the controller plugin (default: []) | `[]` |
| `drivers.nvmeof.deployCsiAddons` | Flag to deploy CSI Addons (default: false) | `false` |
| `drivers.nvmeof.enableMetadata` | Flag to enable metadata (default: false) | `false` |
| `drivers.nvmeof.enabled` | Enable the NVMe-oF driver (default: true) | `true` |
| `drivers.nvmeof.encryption.configMapRef.name` | Name of the ConfigMap for encryption settings (default: "") | `""` |
| `drivers.nvmeof.fsGroupPolicy` | File system group policy (e.g., "None", "ReadWriteOnceWithFSType") (default: "File") | `"File"` |
Expand Down Expand Up @@ -167,7 +164,6 @@ The following table lists the configurable parameters of the ceph-csi-drivers ch
| `drivers.rbd.controllerPlugin.resources` | Resource requirements for controller plugin containers (default: {}) | `{}` |
| `drivers.rbd.controllerPlugin.tolerations` | List of tolerations for the controller plugin (default: []) | `[]` |
| `drivers.rbd.deployCsiAddons` | Flag to deploy CSI Addons (default: false) | `false` |
| `drivers.rbd.enableMetadata` | Flag to enable metadata (default: false) | `false` |
| `drivers.rbd.enabled` | Enable the RBD driver (default: true) | `true` |
| `drivers.rbd.encryption.configMapRef.name` | Name of the ConfigMap for encryption settings (default: "") | `""` |
| `drivers.rbd.fsGroupPolicy` | File system group policy (e.g., "None", "ReadWriteOnceWithFSType") (default: "File") | `"File"` |
Expand Down Expand Up @@ -204,7 +200,6 @@ The following table lists the configurable parameters of the ceph-csi-drivers ch
| `operatorConfig.driverSpecDefaults.controllerPlugin.resources` | Resource requirements for controller plugin containers (default: {}) | `{}` |
| `operatorConfig.driverSpecDefaults.controllerPlugin.tolerations` | List of tolerations for the controller plugin (default: []) | `[]` |
| `operatorConfig.driverSpecDefaults.deployCsiAddons` | Flag to deploy CSI Addons (default: false) | `false` |
| `operatorConfig.driverSpecDefaults.enableMetadata` | Flag to enable metadata (default: false) | `false` |
| `operatorConfig.driverSpecDefaults.encryption.configMapRef.name` | Name of the ConfigMap for encryption settings (default: "") | `""` |
| `operatorConfig.driverSpecDefaults.fsGroupPolicy` | File system group policy (e.g., "None", "ReadWriteOnceWithFSType") (default: "File") | `"File"` |
| `operatorConfig.driverSpecDefaults.fuseMountOptions` | FUSE mount options (default: {}) | `{}` |
Expand Down
5 changes: 0 additions & 5 deletions internal/controller/driver_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,6 @@ func (r *driverReconcile) reconcileControllerPluginDeployment() error {
utils.ControllerServerContainerArg,
utils.DriverNameContainerArg(r.driver.Name),
utils.PidlimitContainerArg,
utils.SetMetadataContainerArg(ptr.Deref(r.driver.Spec.EnableMetadata, false)),
utils.SetFencingContainerArg(ptr.Deref(r.driver.Spec.EnableFencing, false)),
utils.ClusterNameContainerArg(ptr.Deref(r.driver.Spec.ClusterName, "")),
utils.If(forceKernelClient, utils.ForceCephKernelClientContainerArg, ""),
Expand Down Expand Up @@ -881,7 +880,6 @@ func (r *driverReconcile) reconcileControllerPluginDeployment() error {
utils.TypeContainerArg("controller"),
utils.DriverNamespaceContainerArg,
utils.DriverNameContainerArg(r.driver.Name),
utils.SetMetadataContainerArg(ptr.Deref(r.driver.Spec.EnableMetadata, false)),
utils.ClusterNameContainerArg(ptr.Deref(r.driver.Spec.ClusterName, "")),
},
),
Expand Down Expand Up @@ -1704,9 +1702,6 @@ func mergeDriverSpecs(dest, src *csiv1.DriverSpec) {
if dest.ClusterName == nil {
dest.ClusterName = src.ClusterName
}
if dest.EnableMetadata == nil {
dest.EnableMetadata = src.EnableMetadata
}
if dest.GRpcTimeout == 0 {
dest.GRpcTimeout = src.GRpcTimeout
}
Expand Down
3 changes: 0 additions & 3 deletions internal/utils/csi.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -423,9 +423,6 @@ func TypeContainerArg(t string) string {
return ""
}
}
func SetMetadataContainerArg(on bool) string {
return fmt.Sprintf("--setmetadata=%t", on)
}
func SetFencingContainerArg(on bool) string {
return fmt.Sprintf("--enable-fencing=%t", on)
}
Expand Down
5 changes: 2 additions & 3 deletions vendor/github.com/ceph/ceph-csi-operator/api/v1/driver_types.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading