ionoscloud 5.0.0 → 5.0.1

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. | [optional] |
+| **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. | [optional] |
+
+## 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/KubernetesClusterProperties.md

@@ -0,0 +1,26 @@
+# 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] |
+
+## 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]
+)
+```
+

data/docs/KubernetesClusterPropertiesForPostAndPut.md

@@ -0,0 +1,22 @@
+# KubernetesClusterPropertiesForPostAndPut
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A Kubernetes Cluster Name |  |
+| **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::KubernetesClusterPropertiesForPostAndPut.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 object that has been created | [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/KubernetesConfig.md

@@ -0,0 +1,24 @@
+# KubernetesConfig
+
+## 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] |
+| **properties** | [**KubernetesConfigProperties**](KubernetesConfigProperties.md) |  |  |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesConfig.new(
+  id: 1e072e52-2ed3-492f-b6b6-c6b116907527,
+  type: null,
+  href: <RESOURCE-URI>,
+  properties: null
+)
+```
+

data/docs/KubernetesConfigProperties.md

@@ -0,0 +1,18 @@
+# KubernetesConfigProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **kubeconfig** | **String** | A Kubernetes Config file data | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesConfigProperties.new(
+  kubeconfig: <FILE>
+)
+```
+

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. | [optional] |
+| **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. | [optional] |
+
+## 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/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,18 @@
+# KubernetesNodePoolLan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **Integer** | The LAN ID of an existing LAN at the related datacenter | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePoolLan.new(
+  id: 3
+)
+```
+

data/docs/KubernetesNodePoolProperties.md

@@ -0,0 +1,50 @@
+# KubernetesNodePoolProperties
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A Kubernetes Node Pool Name. Valid Kubernetes Node Pool 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. |  |
+| **datacenter_id** | **String** | A valid uuid of the datacenter on which user has access |  |
+| **node_count** | **Integer** | Number of nodes part of the Node Pool |  |
+| **cpu_family** | **String** | A valid cpu family name |  |
+| **cores_count** | **Integer** | Number of cores for node |  |
+| **ram_size** | **Integer** | RAM size for node, minimum size 2048MB is recommended. Ram size must be set to multiple of 1024MB. |  |
+| **availability_zone** | **String** | The availability zone in which the target VM should exist |  |
+| **storage_type** | **String** | Hardware type of the volume |  |
+| **storage_size** | **Integer** | The size of the volume in GB. The size should be greater than 10GB. |  |
+| **k8s_version** | **String** | The kubernetes version in which a nodepool 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] |
+| **auto_scaling** | [**KubernetesAutoScaling**](KubernetesAutoScaling.md) |  | [optional] |
+| **lans** | [**Array<KubernetesNodePoolLan>**](KubernetesNodePoolLan.md) | array of additional LANs attached to worker nodes | [optional] |
+| **labels** | **Hash<String, String>** | map of labels attached to node pool | [optional] |
+| **annotations** | **Hash<String, String>** | map of annotations attached to node pool | [optional] |
+| **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes. | [optional] |
+| **available_upgrade_versions** | **Array<String>** | List of available versions for upgrading the node pool | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = Ionoscloud::KubernetesNodePoolProperties.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,
+  k8s_version: 1.15.4,
+  maintenance_window: null,
+  auto_scaling: null,
+  lans: null,
+  labels: null,
+  annotations: null,
+  public_ips: [81.173.1.2, 82.231.2.5, 92.221.2.4],
+  available_upgrade_versions: [1.16.4, 1.17.7]
+)
+```
+

data/docs/KubernetesNodePoolPropertiesForPost.md

@@ -0,0 +1,48 @@
+# KubernetesNodePoolPropertiesForPost
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A Kubernetes Node Pool Name. Valid Kubernetes Node Pool 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. |  |
+| **datacenter_id** | **String** | A valid uuid of the datacenter on which user has access |  |
+| **node_count** | **Integer** | Number of nodes part of the Node Pool |  |
+| **cpu_family** | **String** | A valid cpu family name |  |
+| **cores_count** | **Integer** | Number of cores for node |  |
+| **ram_size** | **Integer** | RAM size for node, minimum size 2048MB is recommended. Ram size must be set to multiple of 1024MB. |  |
+| **availability_zone** | **String** | The availability zone in which the target VM should exist |  |
+| **storage_type** | **String** | Hardware type of the volume |  |
+| **storage_size** | **Integer** | The size of the volume in GB. The size should be greater than 10GB. |  |
+| **k8s_version** | **String** | The kubernetes version in which a nodepool 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] |
+| **auto_scaling** | [**KubernetesAutoScaling**](KubernetesAutoScaling.md) |  | [optional] |
+| **lans** | [**Array<KubernetesNodePoolLan>**](KubernetesNodePoolLan.md) | array of additional LANs attached to worker nodes | [optional] |
+| **labels** | **Hash<String, String>** | map of labels attached to node pool | [optional] |
+| **annotations** | **Hash<String, String>** | map of annotations attached to node pool | [optional] |
+| **public_ips** | **Array<String>** | Optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes. | [optional] |
+
+## Example
+
+```ruby
+require 'ionoscloud'
+
+instance = 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,
+  k8s_version: 1.15.4,
+  maintenance_window: null,
+  auto_scaling: null,
+  lans: null,
+  labels: null,
+  annotations: null,
+  public_ips: [81.173.1.2, 82.231.2.5, 92.221.2.4]
+)
+```
+