knife-ionoscloud 5.0.0.beta.1 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (93) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/build.yml +20 -0
  3. data/.github/workflows/publish.yml +25 -14
  4. data/README.md +81 -0
  5. data/docs/README.md +33 -18
  6. data/docs/changelog.md +2 -1
  7. data/docs/subcommands/backupunit_create.md +11 -8
  8. data/docs/subcommands/backupunit_delete.md +11 -8
  9. data/docs/subcommands/backupunit_list.md +11 -8
  10. data/docs/subcommands/backupunit_ssourl.md +13 -10
  11. data/docs/subcommands/composite_server_create.md +12 -9
  12. data/docs/subcommands/contract_list.md +11 -8
  13. data/docs/subcommands/datacenter_create.md +14 -10
  14. data/docs/subcommands/datacenter_delete.md +11 -8
  15. data/docs/subcommands/datacenter_list.md +11 -8
  16. data/docs/subcommands/firewall_create.md +14 -11
  17. data/docs/subcommands/firewall_delete.md +14 -11
  18. data/docs/subcommands/firewall_list.md +14 -11
  19. data/docs/subcommands/group_create.md +11 -8
  20. data/docs/subcommands/group_delete.md +11 -8
  21. data/docs/subcommands/group_get.md +12 -9
  22. data/docs/subcommands/group_list.md +11 -8
  23. data/docs/subcommands/group_user_add.md +12 -9
  24. data/docs/subcommands/group_user_remove.md +12 -9
  25. data/docs/subcommands/image_list.md +11 -8
  26. data/docs/subcommands/ipblock_create.md +12 -9
  27. data/docs/subcommands/ipblock_delete.md +11 -8
  28. data/docs/subcommands/ipblock_list.md +11 -8
  29. data/docs/subcommands/ipfailover_add.md +15 -12
  30. data/docs/subcommands/ipfailover_remove.md +14 -11
  31. data/docs/subcommands/k8s_create.md +11 -8
  32. data/docs/subcommands/k8s_delete.md +11 -8
  33. data/docs/subcommands/k8s_list.md +11 -8
  34. data/docs/subcommands/kubeconfig_get.md +12 -9
  35. data/docs/subcommands/label_add.md +12 -9
  36. data/docs/subcommands/label_list.md +11 -8
  37. data/docs/subcommands/label_remove.md +12 -9
  38. data/docs/subcommands/lan_create.md +12 -9
  39. data/docs/subcommands/lan_delete.md +12 -9
  40. data/docs/subcommands/lan_list.md +12 -9
  41. data/docs/subcommands/loadbalancer_create.md +12 -9
  42. data/docs/subcommands/loadbalancer_delete.md +12 -9
  43. data/docs/subcommands/loadbalancer_get.md +13 -10
  44. data/docs/subcommands/loadbalancer_list.md +12 -9
  45. data/docs/subcommands/loadbalancer_nic_add.md +13 -10
  46. data/docs/subcommands/loadbalancer_nic_remove.md +13 -10
  47. data/docs/subcommands/location_list.md +11 -8
  48. data/docs/subcommands/nic_create.md +14 -12
  49. data/docs/subcommands/nic_delete.md +13 -10
  50. data/docs/subcommands/nic_list.md +13 -10
  51. data/docs/subcommands/node_delete.md +13 -10
  52. data/docs/subcommands/node_list.md +13 -10
  53. data/docs/subcommands/node_replace.md +14 -11
  54. data/docs/subcommands/nodepool_create.md +19 -16
  55. data/docs/subcommands/nodepool_delete.md +12 -9
  56. data/docs/subcommands/nodepool_list.md +12 -9
  57. data/docs/subcommands/pcc_create.md +11 -8
  58. data/docs/subcommands/pcc_delete.md +11 -8
  59. data/docs/subcommands/pcc_list.md +11 -8
  60. data/docs/subcommands/request_list.md +12 -9
  61. data/docs/subcommands/request_status.md +12 -9
  62. data/docs/subcommands/request_wait.md +12 -9
  63. data/docs/subcommands/resource_list.md +11 -10
  64. data/docs/subcommands/s3key_create.md +12 -9
  65. data/docs/subcommands/s3key_delete.md +12 -9
  66. data/docs/subcommands/s3key_list.md +12 -9
  67. data/docs/subcommands/server_create.md +13 -10
  68. data/docs/subcommands/server_delete.md +13 -10
  69. data/docs/subcommands/server_list.md +12 -9
  70. data/docs/subcommands/server_reboot.md +12 -9
  71. data/docs/subcommands/server_start.md +13 -10
  72. data/docs/subcommands/server_stop.md +12 -9
  73. data/docs/subcommands/share_create.md +13 -10
  74. data/docs/subcommands/share_delete.md +12 -9
  75. data/docs/subcommands/share_list.md +12 -9
  76. data/docs/subcommands/snapshot_create.md +13 -10
  77. data/docs/subcommands/snapshot_delete.md +11 -8
  78. data/docs/subcommands/snapshot_list.md +11 -8
  79. data/docs/subcommands/snapshot_restore.md +14 -11
  80. data/docs/subcommands/user_create.md +12 -10
  81. data/docs/subcommands/user_delete.md +11 -8
  82. data/docs/subcommands/user_list.md +12 -9
  83. data/docs/subcommands/user_ssourl.md +12 -9
  84. data/docs/subcommands/volume_attach.md +13 -10
  85. data/docs/subcommands/volume_create.md +12 -9
  86. data/docs/subcommands/volume_delete.md +12 -9
  87. data/docs/subcommands/volume_detach.md +13 -10
  88. data/docs/subcommands/volume_list.md +12 -9
  89. data/docs/summary.md +1 -0
  90. data/git-versioning.sh +113 -0
  91. data/lib/knife-ionoscloud/version.rb +1 -1
  92. data/sonar-project.properties +12 -0
  93. metadata +8 -4
@@ -2,18 +2,19 @@
2
2
 
3
3
  Deletes a node pool within an existing Kubernetes cluster.
4
4
 
5
- knife ionoscloud nodepool delete NODEPOOL_ID [NODEPOOL_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud nodepool delete NODEPOOL_ID [NODEPOOL_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * cluster_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * cluster\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
18
19
  the ID of the K8s Cluster (required)
19
20
 
@@ -22,9 +23,11 @@ Deletes a node pool within an existing Kubernetes cluster.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud nodepool delete NODEPOOL_ID
30
+ ```text
31
+ knife ionoscloud nodepool delete NODEPOOL_ID
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieve a list of all node pools contained in a selected Kubernetes cluster.
4
4
 
5
- knife ionoscloud nodepool list
6
-
5
+ ```text
6
+ knife ionoscloud nodepool list
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * cluster_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * cluster\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
18
19
  the ID of the K8s Cluster (required)
19
20
 
@@ -22,9 +23,11 @@ Retrieve a list of all node pools contained in a selected Kubernetes cluster.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud nodepool list--cluster-id CLUSTER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud nodepool list--cluster-id CLUSTER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,17 +2,18 @@
2
2
 
3
3
  Creates a Private Cross-Connect.
4
4
 
5
- knife ionoscloud pcc create (options)
6
-
5
+ ```text
6
+ knife ionoscloud pcc create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * ionoscloud_username
13
- * ionoscloud_password
14
12
 
15
- ```
13
+ * ionoscloud\_username
14
+ * ionoscloud\_password
15
+
16
+ ```text
16
17
  name: --name NAME, -n NAME
17
18
  name of the data center
18
19
 
@@ -30,9 +31,11 @@ Creates a Private Cross-Connect.
30
31
 
31
32
  ionoscloud_password: --password PASSWORD, -p PASSWORD
32
33
  your Ionoscloud password (required)
33
-
34
34
  ```
35
35
 
36
36
  ## Example
37
37
 
38
- knife ionoscloud pcc create --name NAME --description DESCRIPTION --peers LAN_ID [LAN_ID] --datacenters DATACENTER_IS [DATACENTER_IS] --username USERNAME --password PASSWORD
38
+ ```text
39
+ knife ionoscloud pcc create --name NAME --description DESCRIPTION --peers LAN_ID [LAN_ID] --datacenters DATACENTER_IS [DATACENTER_IS] --username USERNAME --password PASSWORD
40
+ ```
41
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Deletes a Private Cross-Connect.
4
4
 
5
- knife ionoscloud pcc delete PCC_ID [PCC_ID]
6
-
5
+ ```text
6
+ knife ionoscloud pcc delete PCC_ID [PCC_ID]
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * ionoscloud_username
13
- * ionoscloud_password
14
12
 
15
- ```
13
+ * ionoscloud\_username
14
+ * ionoscloud\_password
15
+
16
+ ```text
16
17
  ionoscloud_username: --username USERNAME, -u USERNAME
17
18
  your Ionoscloud username (required)
18
19
 
19
20
  ionoscloud_password: --password PASSWORD, -p PASSWORD
20
21
  your Ionoscloud password (required)
21
-
22
22
  ```
23
23
 
24
24
  ## Example
25
25
 
26
- knife ionoscloud pcc delete PCC_ID [PCC_ID]--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud pcc delete PCC_ID [PCC_ID]--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Lists all Private Cross-Connect instances.
4
4
 
5
- knife ionoscloud pcc list
6
-
5
+ ```text
6
+ knife ionoscloud pcc list
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * ionoscloud_username
13
- * ionoscloud_password
14
12
 
15
- ```
13
+ * ionoscloud\_username
14
+ * ionoscloud\_password
15
+
16
+ ```text
16
17
  ionoscloud_username: --username USERNAME, -u USERNAME
17
18
  your Ionoscloud username (required)
18
19
 
19
20
  ionoscloud_password: --password PASSWORD, -p PASSWORD
20
21
  your Ionoscloud password (required)
21
-
22
22
  ```
23
23
 
24
24
  ## Example
25
25
 
26
- knife ionoscloud pcc list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud pcc list--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -1,18 +1,19 @@
1
1
  # RequestList
2
2
 
3
- 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.
4
-
5
- knife ionoscloud request list (options)
3
+ 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.
6
4
 
5
+ ```text
6
+ knife ionoscloud request list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * ionoscloud_username
13
- * ionoscloud_password
14
12
 
15
- ```
13
+ * ionoscloud\_username
14
+ * ionoscloud\_password
15
+
16
+ ```text
16
17
  limit: --limit LIMIT, -l LIMIT
17
18
  the maximum number of results.
18
19
 
@@ -24,9 +25,11 @@ This operation allows you to retrieve a list of requests. Cloud API calls genera
24
25
 
25
26
  ionoscloud_password: --password PASSWORD, -p PASSWORD
26
27
  your Ionoscloud password (required)
27
-
28
28
  ```
29
29
 
30
30
  ## Example
31
31
 
32
- knife ionoscloud request list --limit LIMIT --offset OFFSET --username USERNAME --password PASSWORD
32
+ ```text
33
+ knife ionoscloud request list --limit LIMIT --offset OFFSET --username USERNAME --password PASSWORD
34
+ ```
35
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieves the status of a specific request based on the supplied request id.
4
4
 
5
- knife ionoscloud request status (options)
6
-
5
+ ```text
6
+ knife ionoscloud request status (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * request_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * request\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  request_id: --request-id REQUEST_ID, -R REQUEST_ID
18
19
  the ID of the Request. (required)
19
20
 
@@ -22,9 +23,11 @@ Retrieves the status of a specific request based on the supplied request id.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud request status --request-id REQUEST_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Waits until a request status is either DONE or FAILED.
4
4
 
5
- knife ionoscloud request wait (options)
6
-
5
+ ```text
6
+ knife ionoscloud request wait (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * request_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * request\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  request_id: --request-id REQUEST_ID, -R REQUEST_ID
18
19
  the ID of the Backup unit. (required)
19
20
 
@@ -22,9 +23,11 @@ Waits until a request status is either DONE or FAILED.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud request wait --request-id REQUEST_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,19 +2,18 @@
2
2
 
3
3
  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.
4
4
 
5
-
6
-
7
- knife ionoscloud resource list (options)
8
-
5
+ ```text
6
+ knife ionoscloud resource list (options)
7
+ ```
9
8
 
10
9
  ## Available options:
11
- ---
12
10
 
13
11
  ### Required options:
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * ionoscloud\_username
14
+ * ionoscloud\_password
15
+
16
+ ```text
18
17
  resource_type: --resource-type RESOURCE_TYPE, -t RESOURCE_TYPE
19
18
  the specific type of resources to retrieve information about.
20
19
 
@@ -26,9 +25,11 @@ No option: Retrieves a list of all resources and optionally their group associat
26
25
 
27
26
  ionoscloud_password: --password PASSWORD, -p PASSWORD
28
27
  your Ionoscloud password (required)
29
-
30
28
  ```
31
29
 
32
30
  ## Example
33
31
 
34
- knife ionoscloud resource list --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
32
+ ```text
33
+ knife ionoscloud resource list --resource-type RESOURCE_TYPE --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
34
+ ```
35
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Creates a new S3 key for a particular user.
4
4
 
5
- knife ionoscloud s3key create (options)
6
-
5
+ ```text
6
+ knife ionoscloud s3key create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * user_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * user\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  user_id: --user USER_ID, -u USER_ID
18
19
  the ID of the user (required)
19
20
 
@@ -22,9 +23,11 @@ Creates a new S3 key for a particular user.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud s3key create --user USER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud s3key create --user USER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  This operation deletes a specific S3 key.
4
4
 
5
- knife ionoscloud s3key delete S3KEY_ID [S3KEY_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud s3key delete S3KEY_ID [S3KEY_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * user_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * user\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  user_id: --user USER_ID, -u USER_ID
18
19
  the ID of the user (required)
19
20
 
@@ -22,9 +23,11 @@ This operation deletes a specific S3 key.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud s3key delete S3KEY_ID
30
+ ```text
31
+ knife ionoscloud s3key delete S3KEY_ID
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieve a list of all the S3 keys for a specific user.
4
4
 
5
- knife ionoscloud s3key list (options)
6
-
5
+ ```text
6
+ knife ionoscloud s3key list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * user_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * user\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  user_id: --user USER_ID, -u USER_ID
18
19
  the ID of the user (required)
19
20
 
@@ -22,9 +23,11 @@ Retrieve a list of all the S3 keys for a specific user.
22
23
 
23
24
  ionoscloud_password: --password PASSWORD, -p PASSWORD
24
25
  your Ionoscloud password (required)
25
-
26
26
  ```
27
27
 
28
28
  ## Example
29
29
 
30
- knife ionoscloud s3key list --user USER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud s3key list --user USER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+