-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmodel_patch_node_pool_properties.go
294 lines (223 loc) · 13.9 KB
/
model_patch_node_pool_properties.go
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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*
* IONOS Cloud - Managed Stackable Data Platform API
*
* *Managed Stackable Data Platform* by IONOS Cloud provides a preconfigured Kubernetes cluster with pre-installed and managed Stackable operators. After the provision of these Stackable operators, the customer can interact with them directly and build his desired application on top of the Stackable platform. The Managed Stackable Data Platform by IONOS Cloud can be configured through the IONOS Cloud API in addition or as an alternative to the *Data Center Designer* (DCD). ## Getting Started To get your DataPlatformCluster up and running, the following steps needs to be performed. ### IONOS Cloud Account The first step is the creation of a IONOS Cloud account if not already existing. To register a **new account**, visit [cloud.ionos.com](https://cloud.ionos.com/compute/signup). ### Virtual Data Center (VDC) The Managed Stackable Data Platform needs a virtual data center (VDC) hosting the cluster. This could either be a VDC that already exists, especially if you want to connect the managed data platform to other services already running within your VDC. Otherwise, if you want to place the Managed Stackable Data Platform in a new VDC or you have not yet created a VDC, you need to do so. A new VDC can be created via the IONOS Cloud API, the IONOS Cloud CLI (`ionosctl`), or the DCD Web interface. For more information, see the [official documentation](https://docs.ionos.com/cloud/getting-started/basic-tutorials/data-center-basics). ### Get a authentication token To interact with this API a user specific authentication token is needed. This token can be generated using the IONOS Cloud CLI the following way: ``` ionosctl token generate ``` For more information, [see](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate). ### Create a new DataPlatformCluster Before using the Managed Stackable Data Platform, a new DataPlatformCluster must be created. To create a cluster, use the [Create DataPlatformCluster](paths./clusters.post) API endpoint. The provisioning of the cluster might take some time. To check the current provisioning status, you can query the cluster by calling the [Get Endpoint](#/DataPlatformCluster/getCluster) with the cluster ID that was presented to you in the response of the create cluster call. ### Add a DataPlatformNodePool To deploy and run a Stackable service, the cluster must have enough computational resources. The node pool that is provisioned along with the cluster is reserved for the Stackable operators. You may create further node pools with resources tailored to your use case. To create a new node pool use the [Create DataPlatformNodepool](paths./clusters/{clusterId}/nodepools.post) endpoint. ### Receive Kubeconfig Once the DataPlatformCluster is created, the kubeconfig can be accessed by the API. The kubeconfig allows the interaction with the provided cluster as with any regular Kubernetes cluster. To protect the deployment of the Stackable distribution, the kubeconfig does not provide you with administration rights for the cluster. What that means is that your actions and deployments are limited to the **default** namespace. If you still want to group your deployments, you have the option to create subnamespaces within the default namespace. This is made possible by the concept of *hierarchical namespaces* (HNS). You can find more details [here](https://kubernetes.io/blog/2020/08/14/introducing-hierarchical-namespaces/). The kubeconfig can be downloaded with the [Get Kubeconfig](paths./clusters/{clusterId}/kubeconfig.get) endpoint using the cluster ID of the created DataPlatformCluster. ### Create Stackable Services You can leverage the `kubeconfig.json` file to access the Managed Stackable Data Platform cluster and manage the deployment of [Stackable data apps](https://stackable.tech/en/platform/). With the Stackable operators, you can deploy the [data apps](https://docs.stackable.tech/home/stable/getting_started.html#_deploying_stackable_services) you want in your Data Platform cluster. ## Authorization All endpoints are secured, so only an authenticated user can access them. As Authentication mechanism the default IONOS Cloud authentication mechanism is used. A detailed description can be found [here](https://api.ionos.com/docs/authentication/). ### Basic Auth The basic auth scheme uses the IONOS Cloud user credentials in form of a *Basic Authentication* header accordingly to [RFC 7617](https://datatracker.ietf.org/doc/html/rfc7617). ### API Key as Bearer Token The Bearer auth token used at the API Gateway is a user-related token created with the IONOS Cloud CLI (For details, see the [documentation](https://docs.ionos.com/cli-ionosctl/subcommands/authentication/token/generate)). For every request to be authenticated, the token is passed as *Authorization Bearer* header along with the request. ### Permissions and Access Roles Currently, an administrator can see and manipulate all resources in a contract. Furthermore, users with the group privilege `Manage Dataplatform` can access the API. ## Components The Managed Stackable Data Platform by IONOS Cloud consists of two components. The concept of a DataPlatformClusters and the backing DataPlatformNodePools the cluster is build on. ### DataPlatformCluster A DataPlatformCluster is the virtual instance of the customer services and operations running the managed services like Stackable operators. A DataPlatformCluster is a Kubernetes Cluster in the VDC of the customer. Therefore, it's possible to integrate the cluster with other resources as VLANs e.g. to shape the data center in the customer's need and integrate the cluster within the topology the customer wants to build. In addition to the Kubernetes cluster, a small node pool is provided which is exclusively used to run the Stackable operators. ### DataPlatformNodePool A DataPlatformNodePool represents the physical machines a DataPlatformCluster is build on top. All nodes within a node pool are identical in setup. The nodes of a pool are provisioned into virtual data centers at a location of your choice and you can freely specify the properties of all the nodes at once before creation. Nodes in node pools provisioned by the Managed Stackable Data Platform Cloud API are read-only in the customer's VDC and can only be modified or deleted via the API. ## References
*
* API version: 1.2.0
*/
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
package ionoscloud
import (
"encoding/json"
)
// PatchNodePoolProperties struct for PatchNodePoolProperties
type PatchNodePoolProperties struct {
// The number of nodes that make up the node pool.
NodeCount *int32 `json:"nodeCount,omitempty"`
MaintenanceWindow *MaintenanceWindow `json:"maintenanceWindow,omitempty"`
// Key-value pairs attached to the node pool resource as [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).
Labels *map[string]interface{} `json:"labels,omitempty"`
// Key-value pairs attached to node pool resource as [Kubernetes annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/).
Annotations *map[string]interface{} `json:"annotations,omitempty"`
AutoScaling *AutoScaling `json:"autoScaling,omitempty"`
}
// NewPatchNodePoolProperties instantiates a new PatchNodePoolProperties object
// This constructor will assign default values to properties that have it defined,
// and makes sure properties required by API are set, but the set of arguments
// will change when the set of required properties is changed
func NewPatchNodePoolProperties() *PatchNodePoolProperties {
this := PatchNodePoolProperties{}
return &this
}
// NewPatchNodePoolPropertiesWithDefaults instantiates a new PatchNodePoolProperties object
// This constructor will only assign default values to properties that have it defined,
// but it doesn't guarantee that properties required by API are set
func NewPatchNodePoolPropertiesWithDefaults() *PatchNodePoolProperties {
this := PatchNodePoolProperties{}
return &this
}
// GetNodeCount returns the NodeCount field value
// If the value is explicit nil, the zero value for int32 will be returned
func (o *PatchNodePoolProperties) GetNodeCount() *int32 {
if o == nil {
return nil
}
return o.NodeCount
}
// GetNodeCountOk returns a tuple with the NodeCount field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *PatchNodePoolProperties) GetNodeCountOk() (*int32, bool) {
if o == nil {
return nil, false
}
return o.NodeCount, true
}
// SetNodeCount sets field value
func (o *PatchNodePoolProperties) SetNodeCount(v int32) {
o.NodeCount = &v
}
// HasNodeCount returns a boolean if a field has been set.
func (o *PatchNodePoolProperties) HasNodeCount() bool {
if o != nil && o.NodeCount != nil {
return true
}
return false
}
// GetMaintenanceWindow returns the MaintenanceWindow field value
// If the value is explicit nil, the zero value for MaintenanceWindow will be returned
func (o *PatchNodePoolProperties) GetMaintenanceWindow() *MaintenanceWindow {
if o == nil {
return nil
}
return o.MaintenanceWindow
}
// GetMaintenanceWindowOk returns a tuple with the MaintenanceWindow field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *PatchNodePoolProperties) GetMaintenanceWindowOk() (*MaintenanceWindow, bool) {
if o == nil {
return nil, false
}
return o.MaintenanceWindow, true
}
// SetMaintenanceWindow sets field value
func (o *PatchNodePoolProperties) SetMaintenanceWindow(v MaintenanceWindow) {
o.MaintenanceWindow = &v
}
// HasMaintenanceWindow returns a boolean if a field has been set.
func (o *PatchNodePoolProperties) HasMaintenanceWindow() bool {
if o != nil && o.MaintenanceWindow != nil {
return true
}
return false
}
// GetLabels returns the Labels field value
// If the value is explicit nil, the zero value for map[string]interface{} will be returned
func (o *PatchNodePoolProperties) GetLabels() *map[string]interface{} {
if o == nil {
return nil
}
return o.Labels
}
// GetLabelsOk returns a tuple with the Labels field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *PatchNodePoolProperties) GetLabelsOk() (*map[string]interface{}, bool) {
if o == nil {
return nil, false
}
return o.Labels, true
}
// SetLabels sets field value
func (o *PatchNodePoolProperties) SetLabels(v map[string]interface{}) {
o.Labels = &v
}
// HasLabels returns a boolean if a field has been set.
func (o *PatchNodePoolProperties) HasLabels() bool {
if o != nil && o.Labels != nil {
return true
}
return false
}
// GetAnnotations returns the Annotations field value
// If the value is explicit nil, the zero value for map[string]interface{} will be returned
func (o *PatchNodePoolProperties) GetAnnotations() *map[string]interface{} {
if o == nil {
return nil
}
return o.Annotations
}
// GetAnnotationsOk returns a tuple with the Annotations field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *PatchNodePoolProperties) GetAnnotationsOk() (*map[string]interface{}, bool) {
if o == nil {
return nil, false
}
return o.Annotations, true
}
// SetAnnotations sets field value
func (o *PatchNodePoolProperties) SetAnnotations(v map[string]interface{}) {
o.Annotations = &v
}
// HasAnnotations returns a boolean if a field has been set.
func (o *PatchNodePoolProperties) HasAnnotations() bool {
if o != nil && o.Annotations != nil {
return true
}
return false
}
// GetAutoScaling returns the AutoScaling field value
// If the value is explicit nil, the zero value for AutoScaling will be returned
func (o *PatchNodePoolProperties) GetAutoScaling() *AutoScaling {
if o == nil {
return nil
}
return o.AutoScaling
}
// GetAutoScalingOk returns a tuple with the AutoScaling field value
// and a boolean to check if the value has been set.
// NOTE: If the value is an explicit nil, `nil, true` will be returned
func (o *PatchNodePoolProperties) GetAutoScalingOk() (*AutoScaling, bool) {
if o == nil {
return nil, false
}
return o.AutoScaling, true
}
// SetAutoScaling sets field value
func (o *PatchNodePoolProperties) SetAutoScaling(v AutoScaling) {
o.AutoScaling = &v
}
// HasAutoScaling returns a boolean if a field has been set.
func (o *PatchNodePoolProperties) HasAutoScaling() bool {
if o != nil && o.AutoScaling != nil {
return true
}
return false
}
func (o PatchNodePoolProperties) MarshalJSON() ([]byte, error) {
toSerialize := map[string]interface{}{}
if o.NodeCount != nil {
toSerialize["nodeCount"] = o.NodeCount
}
if o.MaintenanceWindow != nil {
toSerialize["maintenanceWindow"] = o.MaintenanceWindow
}
if o.Labels != nil {
toSerialize["labels"] = o.Labels
}
if o.Annotations != nil {
toSerialize["annotations"] = o.Annotations
}
toSerialize["autoScaling"] = o.AutoScaling
return json.Marshal(toSerialize)
}
type NullablePatchNodePoolProperties struct {
value *PatchNodePoolProperties
isSet bool
}
func (v NullablePatchNodePoolProperties) Get() *PatchNodePoolProperties {
return v.value
}
func (v *NullablePatchNodePoolProperties) Set(val *PatchNodePoolProperties) {
v.value = val
v.isSet = true
}
func (v NullablePatchNodePoolProperties) IsSet() bool {
return v.isSet
}
func (v *NullablePatchNodePoolProperties) Unset() {
v.value = nil
v.isSet = false
}
func NewNullablePatchNodePoolProperties(val *PatchNodePoolProperties) *NullablePatchNodePoolProperties {
return &NullablePatchNodePoolProperties{value: val, isSet: true}
}
func (v NullablePatchNodePoolProperties) MarshalJSON() ([]byte, error) {
return json.Marshal(v.value)
}
func (v *NullablePatchNodePoolProperties) UnmarshalJSON(src []byte) error {
v.isSet = true
return json.Unmarshal(src, &v.value)
}