kcr_zookeeper_stackable_tech 3.20260603.71006

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

// WARNING: generated by kopium - manual changes will be overwritten
// kopium command: kopium --docs --derive=Default --derive=PartialEq --smart-derive-elision --filename crd-catalog/stackabletech/zookeeper-operator/zookeeper.stackable.tech/v1alpha1/zookeeperznodes.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::*;

/// A claim for a single ZooKeeper ZNode tree (filesystem node).
/// 
/// A ConfigMap will automatically be created with the same name, containing the connection string in the field `ZOOKEEPER`.
/// Each ZookeeperZnode gets an isolated ZNode chroot, which the `ZOOKEEPER` automatically contains.
/// All data inside of this chroot will be deleted when the corresponding `ZookeeperZnode` is.
/// 
/// `ZookeeperZnode` is *not* designed to manage the contents of this ZNode. Instead, it should be used to create a chroot
/// for an installation of an application to work inside. Initializing the contents is the responsibility of the application.
/// 
/// You can learn more about this in the
/// [Isolating clients with ZNodes usage guide](<https://docs.stackable.tech/home/nightly/zookeeper/usage_guide/isolating_clients_with_znodes).>
#[derive(CustomResource, Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
#[kube(group = "zookeeper.stackable.tech", version = "v1alpha1", kind = "ZookeeperZnode", plural = "zookeeperznodes")]
#[kube(namespaced)]
#[kube(status = "ZookeeperZnodeStatus")]
#[kube(schema = "disabled")]
#[kube(derive="Default")]
#[kube(derive="PartialEq")]
pub struct ZookeeperZnodeSpec {
    /// The reference to the ZookeeperCluster that this ZNode belongs to.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "clusterRef")]
    pub cluster_ref: Option<ZookeeperZnodeClusterRef>,
    /// A list of generic Kubernetes objects, which are merged into the objects that the operator
    /// creates.
    /// 
    /// List entries are arbitrary YAML objects, which need to be valid Kubernetes objects.
    /// 
    /// Read the [Object overrides documentation](<https://docs.stackable.tech/home/nightly/concepts/overrides#object-overrides)>
    /// for more information.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "objectOverrides")]
    pub object_overrides: Option<Vec<BTreeMap<String, serde_json::Value>>>,
}

/// The reference to the ZookeeperCluster that this ZNode belongs to.
#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ZookeeperZnodeClusterRef {
    /// The name of the cluster
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The namespace of the cluster
    /// 
    /// This field is optional, and will default to the namespace of the referring object.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub namespace: Option<String>,
}

#[derive(Serialize, Deserialize, Clone, Debug, Default, PartialEq)]
pub struct ZookeeperZnodeStatus {
    /// The absolute ZNode allocated to the ZookeeperZnode. This will typically be set by the operator.
    /// 
    /// This can be set explicitly by an administrator, such as when restoring from a backup.
    #[serde(default, skip_serializing_if = "Option::is_none", rename = "znodePath")]
    pub znode_path: Option<String>,
}