ionoscloud 5.0.1 → 5.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +65 -0
- data/docs/AttachedVolumes.md +1 -1
- data/docs/Cdroms.md +1 -1
- data/docs/DefaultApi.md +6 -1
- data/docs/ImageProperties.md +5 -1
- data/docs/IpBlockProperties.md +1 -1
- data/docs/IpConsumer.md +5 -1
- data/docs/KubernetesApi.md +12 -12
- data/docs/KubernetesClusterForPost.md +28 -0
- data/docs/KubernetesClusterForPut.md +28 -0
- data/docs/KubernetesClusterProperties.md +5 -1
- data/docs/KubernetesClusterPropertiesForPost.md +26 -0
- data/docs/{KubernetesClusterPropertiesForPostAndPut.md → KubernetesClusterPropertiesForPut.md} +3 -3
- data/docs/KubernetesNodePoolForPost.md +26 -0
- data/docs/KubernetesNodePoolProperties.md +1 -1
- data/docs/KubernetesNodePoolPropertiesForPost.md +1 -1
- data/docs/KubernetesNodePoolPropertiesForPut.md +0 -14
- data/docs/KubernetesNodeProperties.md +3 -1
- data/docs/Nics.md +1 -1
- data/docs/README.md +3 -3
- data/docs/RequestApi.md +22 -6
- data/docs/S3KeyProperties.md +2 -2
- data/docs/UserManagementApi.md +7 -7
- data/docs/UserPost.md +18 -0
- data/docs/UserProperties.md +0 -2
- data/docs/UserPropertiesPost.md +32 -0
- data/docs/UserPropertiesPut.md +30 -0
- data/docs/UserPut.md +20 -0
- data/docs/VolumeProperties.md +1 -1
- data/docs/summary.md +17 -1
- data/lib/ionoscloud.rb +9 -1
- data/lib/ionoscloud/api/_api.rb +1 -1
- data/lib/ionoscloud/api/kubernetes_api.rb +11 -11
- data/lib/ionoscloud/api/request_api.rb +30 -6
- data/lib/ionoscloud/api/user_management_api.rb +8 -8
- data/lib/ionoscloud/api_client.rb +13 -14
- data/lib/ionoscloud/configuration.rb +2 -2
- data/lib/ionoscloud/models/datacenter_properties.rb +0 -22
- data/lib/ionoscloud/models/image_properties.rb +38 -4
- data/lib/ionoscloud/models/ip_consumer.rb +22 -4
- data/lib/ionoscloud/models/kubernetes_cluster_for_post.rb +303 -0
- data/lib/ionoscloud/models/kubernetes_cluster_for_put.rb +303 -0
- data/lib/ionoscloud/models/kubernetes_cluster_properties.rb +26 -4
- data/lib/ionoscloud/models/kubernetes_cluster_properties_for_post.rb +263 -0
- data/lib/ionoscloud/models/{kubernetes_cluster_properties_for_post_and_put.rb → kubernetes_cluster_properties_for_put.rb} +4 -4
- data/lib/ionoscloud/models/kubernetes_node_pool_for_post.rb +294 -0
- data/lib/ionoscloud/models/kubernetes_node_pool_properties.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_post.rb +1 -1
- data/lib/ionoscloud/models/kubernetes_node_pool_properties_for_put.rb +1 -152
- data/lib/ionoscloud/models/kubernetes_node_properties.rb +11 -6
- data/lib/ionoscloud/models/location_properties.rb +0 -22
- data/lib/ionoscloud/models/s3_key_properties.rb +2 -2
- data/lib/ionoscloud/models/user_post.rb +221 -0
- data/lib/ionoscloud/models/user_properties.rb +1 -11
- data/lib/ionoscloud/models/user_properties_post.rb +287 -0
- data/lib/ionoscloud/models/user_properties_put.rb +277 -0
- data/lib/ionoscloud/models/user_put.rb +231 -0
- data/lib/ionoscloud/models/volume_properties.rb +1 -1
- data/lib/ionoscloud/version.rb +1 -1
- data/spec/api/kubernetes_api_spec.rb +4 -4
- data/spec/api/request_api_spec.rb +11 -3
- data/spec/api/user_management_api_spec.rb +2 -2
- data/spec/models/datacenter_properties_spec.rb +0 -4
- data/spec/models/image_properties_spec.rb +16 -0
- data/spec/models/ip_consumer_spec.rb +12 -0
- data/spec/models/kubernetes_cluster_for_post_spec.rb +68 -0
- data/spec/models/kubernetes_cluster_for_put_spec.rb +68 -0
- data/spec/models/kubernetes_cluster_properties_for_post_spec.rb +58 -0
- data/spec/models/{kubernetes_cluster_properties_for_post_and_put_spec.rb → kubernetes_cluster_properties_for_put_spec.rb} +6 -6
- data/spec/models/kubernetes_cluster_properties_spec.rb +12 -0
- data/spec/models/kubernetes_node_pool_for_post_spec.rb +62 -0
- data/spec/models/kubernetes_node_pool_properties_for_put_spec.rb +0 -50
- data/spec/models/kubernetes_node_properties_spec.rb +6 -0
- data/spec/models/location_properties_spec.rb +0 -4
- data/spec/models/user_post_spec.rb +34 -0
- data/spec/models/user_properties_post_spec.rb +76 -0
- data/spec/models/user_properties_put_spec.rb +70 -0
- data/spec/models/user_properties_spec.rb +0 -6
- data/spec/models/user_put_spec.rb +40 -0
- metadata +157 -124
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 97c117fbad4b6425cf6b243726ae337ee064ba98affd1b784c32e0887dece80f
|
4
|
+
data.tar.gz: 92402e536f0a62f48904717d4a3aa06b247f4cb226edec7564707cc6bbfb7fb9
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 16e89ec676ce93909e1db3a3d096f90259ec5ee0c3368a3bd19a6ddffaa9f43fa2e62c1544accec5e8fce577841cd60a28876c6cc8d528150d06e716317cd7fc
|
7
|
+
data.tar.gz: 6658dc8f1b031a65cb065ecd11ddfa922887c5773e3f4e85e8ad06aafd83a2ce515112aaaab33567b5416b76c54976ebfbbdb8e505c0594d65e7ea4d2f4fcbdc
|
data/README.md
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
|
2
|
+
![CI](https://github.com/ionos-cloud/sdk-resources/workflows/CI/badge.svg)
|
3
|
+
[![Gem Version](https://img.shields.io/gem/v/ionoscloud)](https://rubygems.org/gems/ionoscloud)
|
4
|
+
[![Gitter](https://badges.gitter.im/ionos-cloud/sdk-general.png)](https://gitter.im/ionos-cloud/sdk-general)
|
5
|
+
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_sdk-ruby&metric=alert_status)](https://sonarcloud.io/dashboard?id=ionos-cloud_sdk-ruby)
|
6
|
+
[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_sdk-ruby&metric=bugs)](https://sonarcloud.io/dashboard?id=ionos-cloud_sdk-ruby)
|
7
|
+
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_sdk-ruby&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=ionos-cloud_sdk-ruby)
|
8
|
+
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_sdk-ruby&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=ionos-cloud_sdk-ruby)
|
9
|
+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_sdk-ruby&metric=security_rating)](https://sonarcloud.io/dashboard?id=ionos-cloud_sdk-ruby)
|
10
|
+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=ionos-cloud_sdk-ruby&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=ionos-cloud_sdk-ruby)
|
11
|
+
|
12
|
+
![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true "Title")
|
13
|
+
|
14
|
+
|
15
|
+
# Ruby API Client For IONOS Cloud
|
16
|
+
|
17
|
+
An enterprise-grade Infrastructure is provided as a Service (IaaS) solution that can be managed through a browser-based \"Data Center Designer\" (DCD) tool or via an easy to use API.
|
18
|
+
|
19
|
+
The API allows you to perform a variety of management tasks such as spinning up additional servers, adding volumes, adjusting networking, and so forth. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.
|
20
|
+
|
21
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
22
|
+
|
23
|
+
- API version: 5.0
|
24
|
+
- Package version: 5.0.0
|
25
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
26
|
+
|
27
|
+
## Installation
|
28
|
+
|
29
|
+
### Build a gem
|
30
|
+
|
31
|
+
To build the Ruby code into a gem:
|
32
|
+
|
33
|
+
```shell
|
34
|
+
gem build ionoscloud.gemspec
|
35
|
+
```
|
36
|
+
|
37
|
+
Then either install the gem locally:
|
38
|
+
|
39
|
+
```shell
|
40
|
+
gem install ./ionoscloud-5.0.0.gem
|
41
|
+
```
|
42
|
+
|
43
|
+
(for development, run `gem install --dev ./ionoscloud-5.0.0.gem` to install the development dependencies)
|
44
|
+
|
45
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
46
|
+
|
47
|
+
Finally add this to the Gemfile:
|
48
|
+
|
49
|
+
gem 'ionoscloud', '~> 5.0.0'
|
50
|
+
|
51
|
+
### Install from Git
|
52
|
+
|
53
|
+
If the Ruby gem is hosted at a git repository: https://github.com/ionos-cloud/sdk-ruby, then add the following in the Gemfile:
|
54
|
+
|
55
|
+
gem 'ionoscloud', :git => 'https://github.com/ionos-cloud/sdk-ruby.git'
|
56
|
+
|
57
|
+
### Include the Ruby code directly
|
58
|
+
|
59
|
+
Include the Ruby code directly using `-I` as follows:
|
60
|
+
|
61
|
+
```shell
|
62
|
+
ruby -Ilib script.rb
|
63
|
+
```
|
64
|
+
|
65
|
+
## Our latest, most up to date usage documentation is available [here](https://docs.ionos.com/ruby-sdk/)
|
data/docs/AttachedVolumes.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
8
|
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
9
|
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
-
| **items** | [**Array<Volume>**](Volume.md) | Array of items in that collection | [optional] |
|
10
|
+
| **items** | [**Array<Volume>**](Volume.md) | Array of items in that collection | [optional][readonly] |
|
11
11
|
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
12
|
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
13
|
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
data/docs/Cdroms.md
CHANGED
@@ -7,7 +7,7 @@
|
|
7
7
|
| **id** | **String** | The resource's unique identifier | [optional][readonly] |
|
8
8
|
| **type** | [**Type**](Type.md) | The type of object that has been created | [optional] |
|
9
9
|
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
-
| **items** | [**Array<Image>**](Image.md) | Array of items in that collection | [optional] |
|
10
|
+
| **items** | [**Array<Image>**](Image.md) | Array of items in that collection | [optional][readonly] |
|
11
11
|
| **offset** | **Float** | the offset (if specified in the request) | [optional] |
|
12
12
|
| **limit** | **Float** | the limit (if specified in the request) | [optional] |
|
13
13
|
| **_links** | [**PaginationLinks**](PaginationLinks.md) | | [optional] |
|
data/docs/DefaultApi.md
CHANGED
@@ -25,6 +25,11 @@ Ionoscloud.configure do |config|
|
|
25
25
|
# Configure HTTP basic authorization: Basic Authentication
|
26
26
|
config.username = 'YOUR USERNAME'
|
27
27
|
config.password = 'YOUR PASSWORD'
|
28
|
+
|
29
|
+
# Configure API key authorization: Token Authentication
|
30
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
31
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
32
|
+
# config.api_key_prefix['Authorization'] = 'Bearer'
|
28
33
|
end
|
29
34
|
|
30
35
|
api_instance = Ionoscloud::DefaultApi.new
|
@@ -75,7 +80,7 @@ end
|
|
75
80
|
|
76
81
|
### Authorization
|
77
82
|
|
78
|
-
Basic Authentication
|
83
|
+
Basic Authentication, Token Authentication
|
79
84
|
|
80
85
|
### HTTP request headers
|
81
86
|
|
data/docs/ImageProperties.md
CHANGED
@@ -21,6 +21,8 @@
|
|
21
21
|
| **licence_type** | **String** | OS type of this Image | |
|
22
22
|
| **image_type** | **String** | This indicates the type of image | [optional][readonly] |
|
23
23
|
| **public** | **Boolean** | Indicates if the image is part of the public repository or not | [optional][readonly] |
|
24
|
+
| **image_aliases** | **Array<String>** | List of image aliases mapped for this Image | [optional][readonly] |
|
25
|
+
| **cloud_init** | **String** | Cloud init compatibility | [optional] |
|
24
26
|
|
25
27
|
## Example
|
26
28
|
|
@@ -44,7 +46,9 @@ instance = Ionoscloud::ImageProperties.new(
|
|
44
46
|
disc_scsi_hot_unplug: true,
|
45
47
|
licence_type: LINUX,
|
46
48
|
image_type: HDD,
|
47
|
-
public: true
|
49
|
+
public: true,
|
50
|
+
image_aliases: null,
|
51
|
+
cloud_init: V1
|
48
52
|
)
|
49
53
|
```
|
50
54
|
|
data/docs/IpBlockProperties.md
CHANGED
@@ -20,7 +20,7 @@ instance = Ionoscloud::IpBlockProperties.new(
|
|
20
20
|
location: us/las,
|
21
21
|
size: 5,
|
22
22
|
name: My resource,
|
23
|
-
ip_consumers: { "ipConsumers": [ { "ip" : "192.18.2.11", "mac" : "02:01:3f:52:6e:57", "nicId" : "0e8ee463-1174-46f2-87ba-a5c79c14d8e5", "serverId" : "e6a3466f-8d6e-4cb6-8001-f4e245f222b7", "serverName" : "Unnamed Server", "datacenterId" : "6e54a9ec-aace-4176-8ee4-1c3a704fccfc", "datacenterName" : "IpConsumerDC"} ] }
|
23
|
+
ip_consumers: { "ipConsumers": [ { "ip" : "192.18.2.11", "mac" : "02:01:3f:52:6e:57", "nicId" : "0e8ee463-1174-46f2-87ba-a5c79c14d8e5", "serverId" : "e6a3466f-8d6e-4cb6-8001-f4e245f222b7", "serverName" : "Unnamed Server", "datacenterId" : "6e54a9ec-aace-4176-8ee4-1c3a704fccfc", "datacenterName" : "IpConsumerDC", "k8sNodePoolUuid" : "6e54a9ec-aace-4176-8ee4-1c3a704fcc12", "k8sClusterUuid" : "6e54a9ec-aace-4176-8ee4-1c3a704fcc23"} ] }
|
24
24
|
)
|
25
25
|
```
|
26
26
|
|
data/docs/IpConsumer.md
CHANGED
@@ -11,6 +11,8 @@
|
|
11
11
|
| **server_name** | **String** | | [optional] |
|
12
12
|
| **datacenter_id** | **String** | | [optional] |
|
13
13
|
| **datacenter_name** | **String** | | [optional] |
|
14
|
+
| **k8s_node_pool_uuid** | **String** | | [optional] |
|
15
|
+
| **k8s_cluster_uuid** | **String** | | [optional] |
|
14
16
|
|
15
17
|
## Example
|
16
18
|
|
@@ -24,7 +26,9 @@ instance = Ionoscloud::IpConsumer.new(
|
|
24
26
|
server_id: null,
|
25
27
|
server_name: null,
|
26
28
|
datacenter_id: null,
|
27
|
-
datacenter_name: null
|
29
|
+
datacenter_name: null,
|
30
|
+
k8s_node_pool_uuid: null,
|
31
|
+
k8s_cluster_uuid: null
|
28
32
|
)
|
29
33
|
```
|
30
34
|
|
data/docs/KubernetesApi.md
CHANGED
@@ -980,7 +980,7 @@ end
|
|
980
980
|
|
981
981
|
api_instance = Ionoscloud::KubernetesApi.new
|
982
982
|
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
983
|
-
kubernetes_node_pool = Ionoscloud::
|
983
|
+
kubernetes_node_pool = Ionoscloud::KubernetesNodePoolForPost.new({properties: Ionoscloud::KubernetesNodePoolPropertiesForPost.new({name: 'k8s-node-pool', datacenter_id: '1e072e52-2ed3-492f-b6b6-c6b116907521', node_count: 2, cpu_family: 'AMD_OPTERON', cores_count: 4, ram_size: 2048, availability_zone: 'AUTO', storage_type: 'HDD', storage_size: 100})}) # KubernetesNodePoolForPost | Details of the Kubernetes Node Pool
|
984
984
|
opts = {
|
985
985
|
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
986
986
|
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
@@ -1019,7 +1019,7 @@ end
|
|
1019
1019
|
| Name | Type | Description | Notes |
|
1020
1020
|
| ---- | ---- | ----------- | ----- |
|
1021
1021
|
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
1022
|
-
| **kubernetes_node_pool** | [**
|
1022
|
+
| **kubernetes_node_pool** | [**KubernetesNodePoolForPost**](KubernetesNodePoolForPost.md) | Details of the Kubernetes Node Pool | |
|
1023
1023
|
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1024
1024
|
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1025
1025
|
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
@@ -1040,7 +1040,7 @@ Basic Authentication, Token Authentication
|
|
1040
1040
|
|
1041
1041
|
## k8s_nodepools_put
|
1042
1042
|
|
1043
|
-
> <
|
1043
|
+
> <KubernetesNodePool> k8s_nodepools_put(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1044
1044
|
|
1045
1045
|
Modify Kubernetes Node Pool
|
1046
1046
|
|
@@ -1066,7 +1066,7 @@ end
|
|
1066
1066
|
api_instance = Ionoscloud::KubernetesApi.new
|
1067
1067
|
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
1068
1068
|
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes Node Pool
|
1069
|
-
kubernetes_node_pool = Ionoscloud::
|
1069
|
+
kubernetes_node_pool = Ionoscloud::KubernetesNodePoolForPut.new({properties: Ionoscloud::KubernetesNodePoolPropertiesForPut.new({name: 'k8s-node-pool', node_count: 2})}) # KubernetesNodePoolForPut | Details of the Kubernetes Node Pool
|
1070
1070
|
opts = {
|
1071
1071
|
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1072
1072
|
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
@@ -1086,7 +1086,7 @@ end
|
|
1086
1086
|
|
1087
1087
|
This returns an Array which contains the response data, status code and headers.
|
1088
1088
|
|
1089
|
-
> <Array(<
|
1089
|
+
> <Array(<KubernetesNodePool>, Integer, Hash)> k8s_nodepools_put_with_http_info(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1090
1090
|
|
1091
1091
|
```ruby
|
1092
1092
|
begin
|
@@ -1094,7 +1094,7 @@ begin
|
|
1094
1094
|
data, status_code, headers = api_instance.k8s_nodepools_put_with_http_info(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
|
1095
1095
|
p status_code # => 2xx
|
1096
1096
|
p headers # => { ... }
|
1097
|
-
p data # => <
|
1097
|
+
p data # => <KubernetesNodePool>
|
1098
1098
|
rescue Ionoscloud::ApiError => e
|
1099
1099
|
puts "Error when calling KubernetesApi->k8s_nodepools_put_with_http_info: #{e}"
|
1100
1100
|
end
|
@@ -1106,14 +1106,14 @@ end
|
|
1106
1106
|
| ---- | ---- | ----------- | ----- |
|
1107
1107
|
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
1108
1108
|
| **nodepool_id** | **String** | The unique ID of the Kubernetes Node Pool | |
|
1109
|
-
| **kubernetes_node_pool** | [**
|
1109
|
+
| **kubernetes_node_pool** | [**KubernetesNodePoolForPut**](KubernetesNodePoolForPut.md) | Details of the Kubernetes Node Pool | |
|
1110
1110
|
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1111
1111
|
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1112
1112
|
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
1113
1113
|
|
1114
1114
|
### Return type
|
1115
1115
|
|
1116
|
-
[**
|
1116
|
+
[**KubernetesNodePool**](KubernetesNodePool.md)
|
1117
1117
|
|
1118
1118
|
### Authorization
|
1119
1119
|
|
@@ -1151,7 +1151,7 @@ Ionoscloud.configure do |config|
|
|
1151
1151
|
end
|
1152
1152
|
|
1153
1153
|
api_instance = Ionoscloud::KubernetesApi.new
|
1154
|
-
kubernetes_cluster = Ionoscloud::
|
1154
|
+
kubernetes_cluster = Ionoscloud::KubernetesClusterForPost.new({properties: Ionoscloud::KubernetesClusterPropertiesForPost.new({name: 'k8s'})}) # KubernetesClusterForPost | Details of the Kubernetes Cluster
|
1155
1155
|
opts = {
|
1156
1156
|
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1157
1157
|
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
@@ -1189,7 +1189,7 @@ end
|
|
1189
1189
|
|
1190
1190
|
| Name | Type | Description | Notes |
|
1191
1191
|
| ---- | ---- | ----------- | ----- |
|
1192
|
-
| **kubernetes_cluster** | [**
|
1192
|
+
| **kubernetes_cluster** | [**KubernetesClusterForPost**](KubernetesClusterForPost.md) | Details of the Kubernetes Cluster | |
|
1193
1193
|
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1194
1194
|
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1195
1195
|
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
@@ -1235,7 +1235,7 @@ end
|
|
1235
1235
|
|
1236
1236
|
api_instance = Ionoscloud::KubernetesApi.new
|
1237
1237
|
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes Cluster
|
1238
|
-
kubernetes_cluster = Ionoscloud::
|
1238
|
+
kubernetes_cluster = Ionoscloud::KubernetesClusterForPut.new({properties: Ionoscloud::KubernetesClusterPropertiesForPut.new({name: 'k8s'})}) # KubernetesClusterForPut | Details of the Kubernetes Cluster
|
1239
1239
|
opts = {
|
1240
1240
|
pretty: true, # Boolean | Controls whether response is pretty-printed (with indentation and new lines)
|
1241
1241
|
depth: 56, # Integer | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
|
@@ -1274,7 +1274,7 @@ end
|
|
1274
1274
|
| Name | Type | Description | Notes |
|
1275
1275
|
| ---- | ---- | ----------- | ----- |
|
1276
1276
|
| **k8s_cluster_id** | **String** | The unique ID of the Kubernetes Cluster | |
|
1277
|
-
| **kubernetes_cluster** | [**
|
1277
|
+
| **kubernetes_cluster** | [**KubernetesClusterForPut**](KubernetesClusterForPut.md) | Details of the Kubernetes Cluster | |
|
1278
1278
|
| **pretty** | **Boolean** | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
|
1279
1279
|
| **depth** | **Integer** | Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on | [optional][default to 0] |
|
1280
1280
|
| **x_contract_number** | **Integer** | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# KubernetesClusterForPost
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The type of object | [optional][readonly] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**KubernetesClusterPropertiesForPost**](KubernetesClusterPropertiesForPost.md) | | |
|
12
|
+
| **entities** | [**KubernetesClusterEntities**](KubernetesClusterEntities.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::KubernetesClusterForPost.new(
|
20
|
+
id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
|
21
|
+
type: null,
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
properties: null,
|
25
|
+
entities: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# KubernetesClusterForPut
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The type of object | [optional][readonly] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**KubernetesClusterPropertiesForPut**](KubernetesClusterPropertiesForPut.md) | | |
|
12
|
+
| **entities** | [**KubernetesClusterEntities**](KubernetesClusterEntities.md) | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'ionoscloud'
|
18
|
+
|
19
|
+
instance = Ionoscloud::KubernetesClusterForPut.new(
|
20
|
+
id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
|
21
|
+
type: null,
|
22
|
+
href: <RESOURCE-URI>,
|
23
|
+
metadata: null,
|
24
|
+
properties: null,
|
25
|
+
entities: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -9,6 +9,8 @@
|
|
9
9
|
| **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
|
10
10
|
| **available_upgrade_versions** | **Array<String>** | List of available versions for upgrading the cluster | [optional] |
|
11
11
|
| **viable_node_pool_versions** | **Array<String>** | List of versions that may be used for node pools under this cluster | [optional] |
|
12
|
+
| **public** | **Boolean** | The indicator if the cluster is public or private. Be aware that setting it to false is currently in beta phase. | [optional][default to true] |
|
13
|
+
| **gateway_ip** | **String** | The IP address of the gateway used by the cluster. This is mandatory when `public` is set to `false` and should not be provided otherwise. | [optional] |
|
12
14
|
|
13
15
|
## Example
|
14
16
|
|
@@ -20,7 +22,9 @@ instance = Ionoscloud::KubernetesClusterProperties.new(
|
|
20
22
|
k8s_version: 1.15.4,
|
21
23
|
maintenance_window: null,
|
22
24
|
available_upgrade_versions: [1.16.4, 1.17.7],
|
23
|
-
viable_node_pool_versions: [1.17.7, 1.18.2]
|
25
|
+
viable_node_pool_versions: [1.17.7, 1.18.2],
|
26
|
+
public: null,
|
27
|
+
gateway_ip: 192.170.0.1
|
24
28
|
)
|
25
29
|
```
|
26
30
|
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# KubernetesClusterPropertiesForPost
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | A Kubernetes Cluster Name. Valid Kubernetes Cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | |
|
8
|
+
| **k8s_version** | **String** | The kubernetes version in which a cluster is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions. | [optional] |
|
9
|
+
| **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
|
10
|
+
| **public** | **Boolean** | The indicator if the cluster is public or private. Be aware that setting it to false is currently in beta phase. | [optional][default to true] |
|
11
|
+
| **gateway_ip** | **String** | The IP address of the gateway used by the cluster. This is mandatory when `public` is set to `false` and should not be provided otherwise. | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::KubernetesClusterPropertiesForPost.new(
|
19
|
+
name: k8s,
|
20
|
+
k8s_version: 1.15.4,
|
21
|
+
maintenance_window: null,
|
22
|
+
public: null,
|
23
|
+
gateway_ip: 192.170.0.1
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/{KubernetesClusterPropertiesForPostAndPut.md → KubernetesClusterPropertiesForPut.md}
RENAMED
@@ -1,10 +1,10 @@
|
|
1
|
-
#
|
1
|
+
# KubernetesClusterPropertiesForPut
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **name** | **String** | A Kubernetes Cluster Name | |
|
7
|
+
| **name** | **String** | A Kubernetes Cluster Name. Valid Kubernetes Cluster name must be 63 characters or less and must be empty or begin and end with an alphanumeric character ([a-z0-9A-Z]) with dashes (-), underscores (_), dots (.), and alphanumerics between. | |
|
8
8
|
| **k8s_version** | **String** | The kubernetes version in which a cluster is running. This imposes restrictions on what kubernetes versions can be run in a cluster's nodepools. Additionally, not all kubernetes versions are viable upgrade targets for all prior versions. | [optional] |
|
9
9
|
| **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) | | [optional] |
|
10
10
|
|
@@ -13,7 +13,7 @@
|
|
13
13
|
```ruby
|
14
14
|
require 'ionoscloud'
|
15
15
|
|
16
|
-
instance = Ionoscloud::
|
16
|
+
instance = Ionoscloud::KubernetesClusterPropertiesForPut.new(
|
17
17
|
name: k8s,
|
18
18
|
k8s_version: 1.15.4,
|
19
19
|
maintenance_window: null
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# KubernetesNodePoolForPost
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
|
8
|
+
| **type** | **String** | The type of object | [optional][readonly] |
|
9
|
+
| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
|
10
|
+
| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) | | [optional] |
|
11
|
+
| **properties** | [**KubernetesNodePoolPropertiesForPost**](KubernetesNodePoolPropertiesForPost.md) | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ionoscloud'
|
17
|
+
|
18
|
+
instance = Ionoscloud::KubernetesNodePoolForPost.new(
|
19
|
+
id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
|
20
|
+
type: null,
|
21
|
+
href: <RESOURCE-URI>,
|
22
|
+
metadata: null,
|
23
|
+
properties: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -9,7 +9,7 @@
|
|
9
9
|
| **node_count** | **Integer** | Number of nodes part of the Node Pool | |
|
10
10
|
| **cpu_family** | **String** | A valid cpu family name | |
|
11
11
|
| **cores_count** | **Integer** | Number of cores for node | |
|
12
|
-
| **ram_size** | **Integer** | RAM size for node, minimum size
|
12
|
+
| **ram_size** | **Integer** | RAM size for node, minimum size is 2048MB. Ram size must be set to multiple of 1024MB. | |
|
13
13
|
| **availability_zone** | **String** | The availability zone in which the target VM should exist | |
|
14
14
|
| **storage_type** | **String** | Hardware type of the volume | |
|
15
15
|
| **storage_size** | **Integer** | The size of the volume in GB. The size should be greater than 10GB. | |
|
@@ -9,7 +9,7 @@
|
|
9
9
|
| **node_count** | **Integer** | Number of nodes part of the Node Pool | |
|
10
10
|
| **cpu_family** | **String** | A valid cpu family name | |
|
11
11
|
| **cores_count** | **Integer** | Number of cores for node | |
|
12
|
-
| **ram_size** | **Integer** | RAM size for node, minimum size
|
12
|
+
| **ram_size** | **Integer** | RAM size for node, minimum size is 2048MB. Ram size must be set to multiple of 1024MB. | |
|
13
13
|
| **availability_zone** | **String** | The availability zone in which the target VM should exist | |
|
14
14
|
| **storage_type** | **String** | Hardware type of the volume | |
|
15
15
|
| **storage_size** | **Integer** | The size of the volume in GB. The size should be greater than 10GB. | |
|