ionoscloud 5.0.0 → 6.0.0.beta.3

data/docs/KubernetesAutoScaling.md

@@ -0,0 +1,20 @@
+# KubernetesAutoScaling
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **min_node_count** | **Integer** | The minimum number of worker nodes that the managed node group can scale in. Should be set together with 'maxNodeCount'. Value for this attribute must be greater than equal to 1 and less than equal to maxNodeCount. |  |
+| **max_node_count** | **Integer** | The maximum number of worker nodes that the managed node pool can scale-out. Should be set together with 'minNodeCount'. Value for this attribute must be greater than equal to 1 and minNodeCount. |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesAutoScaling.new(
+  min_node_count: 1,
+  max_node_count: 1
+)
+```
+

data/docs/KubernetesCluster.md

@@ -0,0 +1,28 @@
+# KubernetesCluster
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesClusterProperties**](KubernetesClusterProperties.md) |  |  |
+| **entities** | [**KubernetesClusterEntities**](KubernetesClusterEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesCluster.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/KubernetesClusterEntities.md

@@ -0,0 +1,18 @@
+# KubernetesClusterEntities
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nodepools** | [**KubernetesNodePools**](KubernetesNodePools.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusterEntities.new(
+  nodepools: null
+)
+```
+

data/docs/KubernetesClusterForPost.md

@@ -0,0 +1,28 @@
+# KubernetesClusterForPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesClusterPropertiesForPost**](KubernetesClusterPropertiesForPost.md) |  |  |
+| **entities** | [**KubernetesClusterEntities**](KubernetesClusterEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusterForPost.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/KubernetesClusterForPut.md

@@ -0,0 +1,28 @@
+# KubernetesClusterForPut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesClusterPropertiesForPut**](KubernetesClusterPropertiesForPut.md) |  |  |
+| **entities** | [**KubernetesClusterEntities**](KubernetesClusterEntities.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusterForPut.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null,
+  entities: null
+)
+```
+

data/docs/KubernetesClusterProperties.md

@@ -0,0 +1,30 @@
+# KubernetesClusterProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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] |
+| **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) |  | [optional] |
+| **available_upgrade_versions** | **Array<String>** | List of available versions for upgrading the cluster | [optional] |
+| **viable_node_pool_versions** | **Array<String>** | List of versions that may be used for node pools under this cluster | [optional] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusterProperties.new(
+  name: k8s,
+  k8s_version: 1.15.4,
+  maintenance_window: null,
+  available_upgrade_versions: [1.16.4, 1.17.7],
+  viable_node_pool_versions: [1.17.7, 1.18.2],
+  public: null,
+  gateway_ip: 192.170.0.1
+)
+```
+

data/docs/KubernetesClusterPropertiesForPost.md

@@ -0,0 +1,26 @@
+# KubernetesClusterPropertiesForPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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] |
+| **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) |  | [optional] |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusterPropertiesForPost.new(
+  name: k8s,
+  k8s_version: 1.15.4,
+  maintenance_window: null,
+  public: null,
+  gateway_ip: 192.170.0.1
+)
+```
+

data/docs/KubernetesClusterPropertiesForPut.md

@@ -0,0 +1,22 @@
+# KubernetesClusterPropertiesForPut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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] |
+| **maintenance_window** | [**KubernetesMaintenanceWindow**](KubernetesMaintenanceWindow.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusterPropertiesForPut.new(
+  name: k8s,
+  k8s_version: 1.15.4,
+  maintenance_window: null
+)
+```
+

data/docs/KubernetesClusters.md

@@ -0,0 +1,24 @@
+# KubernetesClusters
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique representation for Kubernetes Cluster as a collection on a resource. | [optional][readonly] |
+| **type** | **String** | The type of resource within a collection | [optional][readonly] |
+| **href** | **String** | URL to the collection representation (absolute path) | [optional][readonly] |
+| **items** | [**Array<KubernetesCluster>**](KubernetesCluster.md) | Array of items in that collection | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesClusters.new(
+  id: k8s,
+  type: collection,
+  href: <RESOURCE-URI>,
+  items: null
+)
+```
+

data/docs/KubernetesMaintenanceWindow.md

@@ -0,0 +1,20 @@
+# KubernetesMaintenanceWindow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **day_of_the_week** | **String** | The day of the week for a maintenance window. |  |
+| **time** | **String** | The time to use for a maintenance window. Accepted formats are: HH:mm:ss; HH:mm:ss\"Z\"; HH:mm:ssZ. This time may varies by 15 minutes. |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesMaintenanceWindow.new(
+  day_of_the_week: Monday,
+  time: 13:00:00
+)
+```
+

data/docs/KubernetesNode.md

@@ -0,0 +1,26 @@
+# KubernetesNode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**KubernetesNodeMetadata**](KubernetesNodeMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesNodeProperties**](KubernetesNodeProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNode.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/KubernetesNodeMetadata.md

@@ -0,0 +1,26 @@
+# KubernetesNodeMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **etag** | **String** | Resource's Entity Tag as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.11 . Entity Tag is also added as an 'ETag response header to requests which don't use 'depth' parameter.  | [optional][readonly] |
+| **created_date** | **Time** | The last time the resource was created | [optional][readonly] |
+| **last_modified_date** | **Time** | The last time the resource has been modified | [optional][readonly] |
+| **state** | **String** | State of the resource. | [optional][readonly] |
+| **last_software_updated_date** | **Time** | The last time the software updated on node. | [optional][readonly] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodeMetadata.new(
+  etag: 45480eb3fbfc31f1d916c1eaa4abdcc3,
+  created_date: 2015-12-04T14:34:09.809Z,
+  last_modified_date: 2015-12-04T14:34:09.809Z,
+  state: AVAILABLE,
+  last_software_updated_date: 2015-12-04T14:34:09.809Z
+)
+```
+

data/docs/KubernetesNodePool.md

@@ -0,0 +1,26 @@
+# KubernetesNodePool
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesNodePoolProperties**](KubernetesNodePoolProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePool.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/KubernetesNodePoolForPost.md

@@ -0,0 +1,26 @@
+# KubernetesNodePoolForPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesNodePoolPropertiesForPost**](KubernetesNodePoolPropertiesForPost.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePoolForPost.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/KubernetesNodePoolForPut.md

@@ -0,0 +1,26 @@
+# KubernetesNodePoolForPut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The resource's unique identifier. | [optional][readonly] |
+| **type** | **String** | The type of object | [optional][readonly] |
+| **href** | **String** | URL to the object representation (absolute path) | [optional][readonly] |
+| **metadata** | [**DatacenterElementMetadata**](DatacenterElementMetadata.md) |  | [optional] |
+| **properties** | [**KubernetesNodePoolPropertiesForPut**](KubernetesNodePoolPropertiesForPut.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePoolForPut.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  metadata: null,
+  properties: null
+)
+```
+

data/docs/KubernetesNodePoolLan.md

@@ -0,0 +1,22 @@
+# KubernetesNodePoolLan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The LAN ID of an existing LAN at the related datacenter | [optional] |
+| **dhcp** | **Boolean** | Indicates if the Kubernetes Node Pool LAN will reserve an IP using DHCP | [optional] |
+| **routes** | [**Array<KubernetesNodePoolLanRoutes>**](KubernetesNodePoolLanRoutes.md) | array of additional LANs attached to worker nodes | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePoolLan.new(
+  id: 3,
+  dhcp: true,
+  routes: null
+)
+```
+

data/docs/KubernetesNodePoolLanRoutes.md

@@ -0,0 +1,20 @@
+# KubernetesNodePoolLanRoutes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **network** | **String** | IPv4 or IPv6 CIDR to be routed via the interface. | [optional] |
+| **gateway_ip** | **String** | IPv4 or IPv6 Gateway IP for the route. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePoolLanRoutes.new(
+  network: 1.2.3.4/24,
+  gateway_ip: 10.1.5.16
+)
+```
+