knife-ionoscloud 5.0.0.beta.1

data/docs/subcommands/node_replace.md

@@ -0,0 +1,36 @@
+# NodeReplace
+
+You can recreate a single Kubernetes Node.
+
+Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
+
+    knife ionoscloud node replace NODE_ID [NODE_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* cluster_id
+* nodepool_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        the ID of the K8s Cluster (required)
+
+    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
+        the ID of the K8s Nodepool (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud node replace NODE_ID 

data/docs/subcommands/nodepool_create.md

@@ -0,0 +1,87 @@
+# NodepoolCreate
+
+Creates a node pool into an existing Kubernetes cluster. The Kubernetes cluster must be in state "ACTIVE" before creating a node pool.
+
+The worker nodes within the node pools will be deployed into an existing data centers.
+
+    knife ionoscloud nodepool create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* cluster_id
+* name
+* version
+* node_count
+* cpu_family
+* cores
+* ram
+* availability_zone
+* storage_type
+* storage_size
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the virtual datacenter (required)
+
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        iD of the Kubernetes cluster (required)
+
+    name: --name NAME, -n NAME
+        name of the Kubernetes node pool (required)
+
+    version: --version VERSION, -v VERSION
+        the version for the Kubernetes cluster. (required)
+
+    maintenance_day: --maintenance-day MAINTENANCE_DAY, -d MAINTENANCE_DAY
+        day Of the week when to perform the maintenance.
+
+    maintenance_time: --maintenance-time MAINTENANCE_TIME, -t MAINTENANCE_TIME
+        time Of the day when to perform the maintenance.
+
+    node_count: --node-count NODE_COUNT, -c NODE_COUNT
+        the number of worker nodes that the node pool should contain. Min 2, Max: Determined by the resource availability. (required)
+
+    cpu_family: --cpu-family CPU_FAMILY, -f CPU_FAMILY
+        sets the CPU type. [AMD_OPTERON, INTEL_XEON, INTEL_SKYLAKE] (required)
+
+    cores: --cores CORES
+        the total number of cores for the node. (required)
+
+    ram: --ram RAM, -r RAM
+        the amount of RAM in MB (required)
+
+    availability_zone: --availability-zone AVAILABILITY_ZONE, -a AVAILABILITY_ZONE
+        the availability zone of the node pool (required)
+
+    storage_type: --storage-type STORAGE_TYPE
+        sets the storage type. [HDD, SSD] (required)
+
+    storage_size: --storage-size STORAGE_SIZE
+        the total allocated storage capacity of a node. (required)
+
+    min_node_count: --min-node-count MIN_NODE_COUNT
+        the minimum number of worker nodes that the managed node group can scale in
+
+    max_node_count: --max-node-count MAX_NODE_COUNT
+        the maximum number of worker nodes that the managed node pool can scale-out.
+
+    lans: --lans LAN_ID [LAN_ID]
+        an array of additional private LANs attached to worker nodes
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud nodepool create --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --username USERNAME --password PASSWORD

data/docs/subcommands/nodepool_delete.md

@@ -0,0 +1,30 @@
+# NodepoolDelete
+
+Deletes a node pool within an existing Kubernetes cluster.
+
+    knife ionoscloud nodepool delete NODEPOOL_ID [NODEPOOL_ID] (options)
+
+
+## Available options:
+---
+
+### Required options:
+* cluster_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        the ID of the K8s Cluster (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud nodepool delete NODEPOOL_ID 

data/docs/subcommands/nodepool_list.md

@@ -0,0 +1,30 @@
+# NodepoolList
+
+Retrieve a list of all node pools contained in a selected Kubernetes cluster.
+
+    knife ionoscloud nodepool list
+
+
+## Available options:
+---
+
+### Required options:
+* cluster_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        the ID of the K8s Cluster (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud nodepool list--cluster-id CLUSTER_ID --username USERNAME --password PASSWORD

data/docs/subcommands/pcc_create.md

@@ -0,0 +1,38 @@
+# PccCreate
+
+Creates a Private Cross-Connect.
+
+    knife ionoscloud pcc create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    name: --name NAME, -n NAME
+        name of the data center
+
+    description: --description DESCRIPTION, -D DESCRIPTION
+        description of the data center
+
+    peers: --peers LAN_ID [LAN_ID]
+        an array of LANs joined to this private cross connect
+
+    datacenters: --datacenters DATACENTER_IS [DATACENTER_IS]
+        an array of datacenters joined to this private cross connect
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud pcc create --name NAME --description DESCRIPTION --peers LAN_ID [LAN_ID] --datacenters DATACENTER_IS [DATACENTER_IS] --username USERNAME --password PASSWORD

data/docs/subcommands/pcc_delete.md

@@ -0,0 +1,26 @@
+# PccDelete
+
+Deletes a Private Cross-Connect.
+
+    knife ionoscloud pcc delete PCC_ID [PCC_ID]
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud pcc delete PCC_ID [PCC_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/pcc_list.md

@@ -0,0 +1,26 @@
+# PccList
+
+Lists all Private Cross-Connect instances.
+
+    knife ionoscloud pcc list
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud pcc list--username USERNAME --password PASSWORD

data/docs/subcommands/request_list.md

@@ -0,0 +1,32 @@
+# RequestList
+
+This operation allows you to retrieve a list of requests. Cloud API calls generate a request which is assigned an id. This "request id" can be used to get information about the request and its current status. The "list request" operation described here will return an array of request items. Each returned request item will have an id that can be used to get additional information as described in the Get Request and Get Request Status sections.
+
+    knife ionoscloud request list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    limit: --limit LIMIT, -l LIMIT
+        the maximum number of results.
+
+    offset: --offset OFFSET, -o OFFSET
+        the request number from which to return results.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud request list --limit LIMIT --offset OFFSET --username USERNAME --password PASSWORD

data/docs/subcommands/request_status.md

@@ -0,0 +1,30 @@
+# RequestStatus
+
+Retrieves the status of a specific request based on the supplied request id.
+
+    knife ionoscloud request status (options)
+
+
+## Available options:
+---
+
+### Required options:
+* request_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    request_id: --request-id REQUEST_ID, -R REQUEST_ID
+        the ID of the Request. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD

data/docs/subcommands/request_wait.md

@@ -0,0 +1,30 @@
+# RequestWait
+
+Waits until a request status is either DONE or FAILED.
+
+    knife ionoscloud request wait (options)
+
+
+## Available options:
+---
+
+### Required options:
+* request_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    request_id: --request-id REQUEST_ID, -R REQUEST_ID
+        the ID of the Backup unit. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD

data/docs/subcommands/resource_list.md

@@ -0,0 +1,34 @@
+# ResourceList
+
+No option: Retrieves a list of all resources and optionally their group associations. Please Note: This API call can take a significant amount of time to return when there are a large number of provisioned resources. You may wish to consult the next section on how to list resources of a particular type.
+
+
+
+    knife ionoscloud resource list (options)
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    resource_type: --resource-type RESOURCE_TYPE, -t RESOURCE_TYPE
+        the specific type of resources to retrieve information about.
+
+    resource_id: --resource-id RESOURCE_ID, -R RESOURCE_ID
+        the ID of the specific resource to retrieve information about.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud resource list --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID --username USERNAME --password PASSWORD

data/docs/subcommands/s3key_create.md

@@ -0,0 +1,30 @@
+# S3keyCreate
+
+Creates a new S3 key for a particular user.
+
+    knife ionoscloud s3key create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* user_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    user_id: --user USER_ID, -u USER_ID
+        the ID of the user (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud s3key create --user USER_ID --username USERNAME --password PASSWORD