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
use serde::{Deserialize, Serialize};
#[derive(Default, Debug, Serialize, Deserialize)]
/// TopologyRequirement expresses the user's requirements for a volume's
/// accessible topology.
pub struct TopologyRequirement {
/// Preferred is a list of Topologies that the volume should attempt to be
/// provisioned in.
///
/// Taken from the CSI spec:
///
/// Specifies the list of topologies the CO would prefer the volume to
/// be provisioned in.
///
/// This field is OPTIONAL. If TopologyRequirement is specified either
/// requisite or preferred or both MUST be specified.
///
/// An SP MUST attempt to make the provisioned volume available using
/// the preferred topologies in order from first to last.
///
/// If requisite is specified, all topologies in preferred list MUST
/// also be present in the list of requisite topologies.
///
/// If the SP is unable to make the provisioned volume available
/// from any of the preferred topologies, the SP MAY choose a topology
/// from the list of requisite topologies.
/// If the list of requisite topologies is not specified, then the SP
/// MAY choose from the list of all possible topologies.
/// If the list of requisite topologies is specified and the SP is
/// unable to make the provisioned volume available from any of the
/// requisite topologies it MUST fail the CreateVolume call.
///
/// Example 1:
/// Given a volume should be accessible from a single zone, and
/// requisite =
/// {"region": "R1", "zone": "Z2"},
/// {"region": "R1", "zone": "Z3"}
/// preferred =
/// {"region": "R1", "zone": "Z3"}
/// then the SP SHOULD first attempt to make the provisioned volume
/// available from "zone" "Z3" in the "region" "R1" and fall back to
/// "zone" "Z2" in the "region" "R1" if that is not possible.
///
/// Example 2:
/// Given a volume should be accessible from a single zone, and
/// requisite =
/// {"region": "R1", "zone": "Z2"},
/// {"region": "R1", "zone": "Z3"},
/// {"region": "R1", "zone": "Z4"},
/// {"region": "R1", "zone": "Z5"}
/// preferred =
/// {"region": "R1", "zone": "Z4"},
/// {"region": "R1", "zone": "Z2"}
/// then the SP SHOULD first attempt to make the provisioned volume
/// accessible from "zone" "Z4" in the "region" "R1" and fall back to
/// "zone" "Z2" in the "region" "R1" if that is not possible. If that
/// is not possible, the SP may choose between either the "zone"
/// "Z3" or "Z5" in the "region" "R1".
///
/// Example 3:
/// Given a volume should be accessible from TWO zones (because an
/// opaque parameter in CreateVolumeRequest, for example, specifies
/// the volume is accessible from two zones, aka synchronously
/// replicated), and
/// requisite =
/// {"region": "R1", "zone": "Z2"},
/// {"region": "R1", "zone": "Z3"},
/// {"region": "R1", "zone": "Z4"},
/// {"region": "R1", "zone": "Z5"}
/// preferred =
/// {"region": "R1", "zone": "Z5"},
/// {"region": "R1", "zone": "Z3"}
/// then the SP SHOULD first attempt to make the provisioned volume
/// accessible from the combination of the two "zones" "Z5" and "Z3" in
/// the "region" "R1". If that's not possible, it should fall back to
/// a combination of "Z5" and other possibilities from the list of
/// requisite. If that's not possible, it should fall back to a
/// combination of "Z3" and other possibilities from the list of
/// requisite. If that's not possible, it should fall back to a
/// combination of other possibilities from the list of requisite.
#[serde(rename = "Preferred")]
pub preferred: Option<Vec<crate::v5::models::Topology>>,
/// Requisite specifies a list of Topologies, at least one of which the
/// volume must be accessible from.
///
/// Taken verbatim from the CSI Spec:
///
/// Specifies the list of topologies the provisioned volume MUST be
/// accessible from.
/// This field is OPTIONAL. If TopologyRequirement is specified either
/// requisite or preferred or both MUST be specified.
///
/// If requisite is specified, the provisioned volume MUST be
/// accessible from at least one of the requisite topologies.
///
/// Given
/// x = number of topologies provisioned volume is accessible from
/// n = number of requisite topologies
/// The CO MUST ensure n >= 1. The SP MUST ensure x >= 1
/// If x==n, then the SP MUST make the provisioned volume available to
/// all topologies from the list of requisite topologies. If it is
/// unable to do so, the SP MUST fail the CreateVolume call.
/// For example, if a volume should be accessible from a single zone,
/// and requisite =
/// {"region": "R1", "zone": "Z2"}
/// then the provisioned volume MUST be accessible from the "region"
/// "R1" and the "zone" "Z2".
/// Similarly, if a volume should be accessible from two zones, and
/// requisite =
/// {"region": "R1", "zone": "Z2"},
/// {"region": "R1", "zone": "Z3"}
/// then the provisioned volume MUST be accessible from the "region"
/// "R1" and both "zone" "Z2" and "zone" "Z3".
///
/// If x<n, then the SP SHALL choose x unique topologies from the list
/// of requisite topologies. If it is unable to do so, the SP MUST fail
/// the CreateVolume call.
/// For example, if a volume should be accessible from a single zone,
/// and requisite =
/// {"region": "R1", "zone": "Z2"},
/// {"region": "R1", "zone": "Z3"}
/// then the SP may choose to make the provisioned volume available in
/// either the "zone" "Z2" or the "zone" "Z3" in the "region" "R1".
/// Similarly, if a volume should be accessible from two zones, and
/// requisite =
/// {"region": "R1", "zone": "Z2"},
/// {"region": "R1", "zone": "Z3"},
/// {"region": "R1", "zone": "Z4"}
/// then the provisioned volume MUST be accessible from any combination
/// of two unique topologies: e.g. "R1/Z2" and "R1/Z3", or "R1/Z2" and
/// "R1/Z4", or "R1/Z3" and "R1/Z4".
///
/// If x>n, then the SP MUST make the provisioned volume available from
/// all topologies from the list of requisite topologies and MAY choose
/// the remaining x-n unique topologies from the list of all possible
/// topologies. If it is unable to do so, the SP MUST fail the
/// CreateVolume call.
/// For example, if a volume should be accessible from two zones, and
/// requisite =
/// {"region": "R1", "zone": "Z2"}
/// then the provisioned volume MUST be accessible from the "region"
/// "R1" and the "zone" "Z2" and the SP may select the second zone
/// independently, e.g. "R1/Z4".
#[serde(rename = "Requisite")]
pub requisite: Option<Vec<crate::v5::models::Topology>>,
}