knife-ionoscloud 5.0.0.beta.1 → 5.1.2

data/docs/subcommands/nodepool_delete.md

@@ -2,18 +2,19 @@
 
 Deletes a node pool within an existing Kubernetes cluster.
 
-    knife ionoscloud nodepool delete NODEPOOL_ID [NODEPOOL_ID] (options)
-
+```text
+knife ionoscloud nodepool delete NODEPOOL_ID [NODEPOOL_ID] (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* cluster_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* cluster\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
         the ID of the K8s Cluster (required)
 
@@ -23,8 +24,12 @@ Deletes a node pool within an existing Kubernetes cluster.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud nodepool delete NODEPOOL_ID 
+```text
+knife ionoscloud nodepool delete NODEPOOL_ID 
+```

data/docs/subcommands/nodepool_get.md

@@ -0,0 +1,39 @@
+# NodepoolGet
+
+Retrieves the attributes of a given K8S Nodepool.
+
+```text
+knife ionoscloud nodepool get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* cluster\_id
+* nodepool\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    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)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud nodepool get --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nodepool_list.md

@@ -2,18 +2,19 @@
 
 Retrieve a list of all node pools contained in a selected Kubernetes cluster.
 
-    knife ionoscloud nodepool list
-
+```text
+knife ionoscloud nodepool list
+```
 
 ## Available options:
----
 
 ### Required options:
-* cluster_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* cluster\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
         the ID of the K8s Cluster (required)
 
@@ -23,8 +24,12 @@ Retrieve a list of all node pools contained in a selected Kubernetes cluster.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud nodepool list--cluster-id CLUSTER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud nodepool list--cluster-id CLUSTER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/nodepool_update.md

@@ -0,0 +1,69 @@
+# NodepoolUpdate
+
+Updates information about a Ionoscloud K8s Nodepool.
+
+```text
+knife ionoscloud nodepool update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* cluster\_id
+* nodepool\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
+        iD of the Kubernetes cluster (required)
+
+    nodepool_id: --nodepool-id NODEPOOL_ID, -P NODEPOOL_ID
+        iD of the Kubernetes nodepool (required)
+
+    k8s_version: --version VERSION, -v VERSION
+        the version for the Kubernetes cluster.
+
+    maintenance_day: --maintenance-day 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.
+
+    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
+
+    public_ips: --ips PUBLIC_IP [PUBLIC_IP]
+        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.
+
+    labels: --labels LABEL [LABEL]
+        map of labels attached to node pool
+
+    annotations: --annotations ANNOTATION [ANNOTATION]
+        map of annotations attached to node pool
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud nodepool update --cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --ips PUBLIC_IP [PUBLIC_IP] --labels LABEL [LABEL] --annotations ANNOTATION [ANNOTATION] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/pcc_create.md

@@ -2,37 +2,39 @@
 
 Creates a Private Cross-Connect.
 
-    knife ionoscloud pcc create (options)
-
+```text
+knife ionoscloud pcc create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     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]
+    peers: --peers DATACENTER_ID,LAN_ID [DATACENTER_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)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud pcc create --name NAME --description DESCRIPTION --peers LAN_ID [LAN_ID] --datacenters DATACENTER_IS [DATACENTER_IS] --username USERNAME --password PASSWORD
+```text
+knife ionoscloud pcc create --name NAME --description DESCRIPTION --peers DATACENTER_ID,LAN_ID [DATACENTER_ID,LAN_ID] --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/pcc_delete.md

@@ -2,25 +2,30 @@
 
 Deletes a Private Cross-Connect.
 
-    knife ionoscloud pcc delete PCC_ID [PCC_ID]
-
+```text
+knife ionoscloud pcc delete PCC_ID [PCC_ID]
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud pcc delete PCC_ID [PCC_ID]--username USERNAME --password PASSWORD
+```text
+knife ionoscloud pcc delete PCC_ID [PCC_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/pcc_get.md

@@ -0,0 +1,35 @@
+# PccGet
+
+Retrieves information about a Ionoscloud Private Cross Connect.
+
+```text
+knife ionoscloud pcc get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* pcc\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    pcc_id: --pcc-id PRIVATE_CROSS_CONNECT_ID, -P PRIVATE_CROSS_CONNECT_ID
+        iD of the Private Cross Connect (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud pcc get --pcc-id PRIVATE_CROSS_CONNECT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/pcc_list.md

@@ -2,25 +2,30 @@
 
 Lists all Private Cross-Connect instances.
 
-    knife ionoscloud pcc list
-
+```text
+knife ionoscloud pcc list
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud pcc list--username USERNAME --password PASSWORD
+```text
+knife ionoscloud pcc list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/pcc_update.md

@@ -0,0 +1,41 @@
+# PccUpdate
+
+Updates information about a Ionoscloud Private Cross Connect. In order to add LANs to the Private Cross Connect one shouldupdate the LAN and change the pcc property using the ```text\knife ionscloud lan update\n``` command.
+
+```text
+knife ionoscloud pcc update (options)
+```
+
+## Available options:
+
+### Required options:
+
+* pcc\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    pcc_id: --pcc-id PRIVATE_CROSS_CONNECT_ID, -P PRIVATE_CROSS_CONNECT_ID
+        iD of the Private Cross Connect (required)
+
+    name: --name NAME, -n NAME
+        name of the data center
+
+    description: --description DESCRIPTION
+        description of the data center
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud pcc update --pcc-id PRIVATE_CROSS_CONNECT_ID --name NAME --description DESCRIPTION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/request_get.md

@@ -0,0 +1,35 @@
+# RequestGet
+
+Retrieves the properties of a specific request based on the supplied request id.
+
+```text
+knife ionoscloud request get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* request\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    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)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud request get --request-id REQUEST_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/request_list.md

@@ -1,32 +1,43 @@
 # 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)
+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.
 
+```text
+knife ionoscloud request list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     limit: --limit LIMIT, -l LIMIT
-        the maximum number of results.
+        the maximum number of requests to look into.
 
     offset: --offset OFFSET, -o OFFSET
         the request number from which to return results.
 
+    status: --status STATUS, -s STATUS
+        request status filter to fetch all the request based on a particular status [QUEUED, RUNNING, DONE, FAILED]
+
+    method: --method METHOD, -m METHOD
+        request method filter to fetch all the request based on a particular method [POST, PUT, PATCH, DELETE]
+
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud request list --limit LIMIT --offset OFFSET --username USERNAME --password PASSWORD
+```text
+knife ionoscloud request list --limit LIMIT --offset OFFSET --status STATUS --method METHOD --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/request_status.md

@@ -2,18 +2,19 @@
 
 Retrieves the status of a specific request based on the supplied request id.
 
-    knife ionoscloud request status (options)
-
+```text
+knife ionoscloud request status (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* request_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* request\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     request_id: --request-id REQUEST_ID, -R REQUEST_ID
         the ID of the Request. (required)
 
@@ -23,8 +24,12 @@ Retrieves the status of a specific request based on the supplied request id.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/request_wait.md

@@ -2,18 +2,19 @@
 
 Waits until a request status is either DONE or FAILED.
 
-    knife ionoscloud request wait (options)
-
+```text
+knife ionoscloud request wait (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* request_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* request\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     request_id: --request-id REQUEST_ID, -R REQUEST_ID
         the ID of the Backup unit. (required)
 
@@ -23,8 +24,12 @@ Waits until a request status is either DONE or FAILED.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/resource_list.md

@@ -4,17 +4,18 @@ No option: Retrieves a list of all resources and optionally their group associat
 
 
 
-    knife ionoscloud resource list (options)
-
+```text
+knife ionoscloud resource list (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     resource_type: --resource-type RESOURCE_TYPE, -t RESOURCE_TYPE
         the specific type of resources to retrieve information about.
 
@@ -27,8 +28,12 @@ No option: Retrieves a list of all resources and optionally their group associat
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud resource list --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud resource list --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/s3key_create.md

@@ -2,18 +2,19 @@
 
 Creates a new S3 key for a particular user.
 
-    knife ionoscloud s3key create (options)
-
+```text
+knife ionoscloud s3key create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* user_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* user\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     user_id: --user USER_ID, -u USER_ID
         the ID of the user (required)
 
@@ -23,8 +24,12 @@ Creates a new S3 key for a particular user.
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
 
-```
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
 
+```
 ## Example
 
-    knife ionoscloud s3key create --user USER_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud s3key create --user USER_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```