kcr_csi_ceph_io 3.20260603.122430

Kubernetes Custom Resource Bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177

// WARNING: generated by kopium - manual changes will be overwritten
// kopium command: kopium --docs --derive=Default --derive=PartialEq --smart-derive-elision --filename crd-catalog/ceph/ceph-csi-operator/csi.ceph.io/v1/clientprofiles.yaml
// kopium version: 0.23.0

#[allow(unused_imports)]
mod prelude {
    pub use kube::CustomResource;
    pub use serde::{Serialize, Deserialize};
    pub use std::collections::BTreeMap;
}

use self::prelude::*;

/// ClientProfileSpec defines the desired state of Ceph CSI
/// configuration for volumes and snapshots configured to use
/// this profile
#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
#[kube(group = "csi.ceph.io", version = "v1", kind = "ClientProfile", plural = "clientprofiles")]
#[kube(namespaced)]
#[kube(schema = "disabled")]
#[kube(derive="Default")]
#[kube(derive="PartialEq")]
pub struct ClientProfileSpec {
    /// LocalObjectReference contains enough information to let you locate the
    /// referenced object inside the same namespace.
    #[serde(rename = "cephConnectionRef")]
    pub ceph_connection_ref: ClientProfileCephConnectionRef,
    /// CephFsConfigSpec defines the desired CephFs configuration
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "cephFs")]
    pub ceph_fs: Option<ClientProfileCephFs>,
    /// NfsConfigSpec defines the desired NFS configuration
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nfs: Option<ClientProfileNfs>,
    /// NvmeofConfigSpec defines the desired NVMe-oF configuration
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nvmeof: Option<ClientProfileNvmeof>,
    /// RbdConfigSpec defines the desired RBD configuration
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rbd: Option<ClientProfileRbd>,
}

/// LocalObjectReference contains enough information to let you locate the
/// referenced object inside the same namespace.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileCephConnectionRef {
    /// Name of the referent.
    /// This field is effectively required, but due to backwards compatibility is
    /// allowed to be empty. Instances of this type with an empty value here are
    /// almost certainly wrong.
    /// More info: <https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names>
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
}

/// CephFsConfigSpec defines the desired CephFs configuration
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileCephFs {
    /// CephCsiSecretsSpec defines the secrets used by the client profile
    /// to access the Ceph cluster and perform operations
    /// on volumes.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "cephCsiSecrets")]
    pub ceph_csi_secrets: Option<ClientProfileCephFsCephCsiSecrets>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "fuseMountOptions")]
    pub fuse_mount_options: Option<BTreeMap<String, String>>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "kernelMountOptions")]
    pub kernel_mount_options: Option<BTreeMap<String, String>>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "radosNamespace")]
    pub rados_namespace: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "subVolumeGroup")]
    pub sub_volume_group: Option<String>,
}

/// CephCsiSecretsSpec defines the secrets used by the client profile
/// to access the Ceph cluster and perform operations
/// on volumes.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileCephFsCephCsiSecrets {
    /// SecretReference represents a Secret Reference. It has enough information to retrieve secret
    /// in any namespace
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "controllerPublishSecret")]
    pub controller_publish_secret: Option<ClientProfileCephFsCephCsiSecretsControllerPublishSecret>,
}

/// SecretReference represents a Secret Reference. It has enough information to retrieve secret
/// in any namespace
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileCephFsCephCsiSecretsControllerPublishSecret {
    /// name is unique within a namespace to reference a secret resource.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// namespace defines the space within which the secret name must be unique.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,
}

/// NfsConfigSpec defines the desired NFS configuration
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileNfs {
}

/// NvmeofConfigSpec defines the desired NVMe-oF configuration
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileNvmeof {
    /// CephCsiSecretsSpec defines the secrets used by the client profile
    /// to access the Ceph cluster and perform operations
    /// on volumes.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "cephCsiSecrets")]
    pub ceph_csi_secrets: Option<ClientProfileNvmeofCephCsiSecrets>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "radosNamespace")]
    pub rados_namespace: Option<String>,
}

/// CephCsiSecretsSpec defines the secrets used by the client profile
/// to access the Ceph cluster and perform operations
/// on volumes.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileNvmeofCephCsiSecrets {
    /// SecretReference represents a Secret Reference. It has enough information to retrieve secret
    /// in any namespace
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "controllerPublishSecret")]
    pub controller_publish_secret: Option<ClientProfileNvmeofCephCsiSecretsControllerPublishSecret>,
}

/// SecretReference represents a Secret Reference. It has enough information to retrieve secret
/// in any namespace
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileNvmeofCephCsiSecretsControllerPublishSecret {
    /// name is unique within a namespace to reference a secret resource.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// namespace defines the space within which the secret name must be unique.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,
}

/// RbdConfigSpec defines the desired RBD configuration
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileRbd {
    /// CephCsiSecretsSpec defines the secrets used by the client profile
    /// to access the Ceph cluster and perform operations
    /// on volumes.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "cephCsiSecrets")]
    pub ceph_csi_secrets: Option<ClientProfileRbdCephCsiSecrets>,
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "radosNamespace")]
    pub rados_namespace: Option<String>,
}

/// CephCsiSecretsSpec defines the secrets used by the client profile
/// to access the Ceph cluster and perform operations
/// on volumes.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileRbdCephCsiSecrets {
    /// SecretReference represents a Secret Reference. It has enough information to retrieve secret
    /// in any namespace
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "controllerPublishSecret")]
    pub controller_publish_secret: Option<ClientProfileRbdCephCsiSecretsControllerPublishSecret>,
}

/// SecretReference represents a Secret Reference. It has enough information to retrieve secret
/// in any namespace
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileRbdCephCsiSecretsControllerPublishSecret {
    /// name is unique within a namespace to reference a secret resource.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// namespace defines the space within which the secret name must be unique.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,
}

/// ClientProfileStatus defines the observed state of Ceph CSI
/// configuration for volumes and snapshots configured to use
/// this profile
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ClientProfileStatus {
}