knife-ionoscloud 5.0.0.beta.1 → 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
data/docs/subcommands/kubeconfig_get.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieve the kubeconfig file for a given Kubernetes cluster.
4
4
 
5
- knife ionoscloud kubeconfig get (options)
6
-
5
+ ```text
6
+ knife ionoscloud kubeconfig get (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 Kubernetes cluster. (required)
19
20
 
@@ -22,9 +23,11 @@ Retrieve the kubeconfig file for a given 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 kubeconfig get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud kubeconfig get --cluster-id CLUSTER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
data/docs/subcommands/label_add.md CHANGED
@@ -2,21 +2,22 @@
2
2
 
3
3
  Add a Label to a Resource.
4
4
 
5
- knife ionoscloud label add (options)
6
-
5
+ ```text
6
+ knife ionoscloud label add (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
+
12
13
  * type
13
- * resource_id
14
+ * resource\_id
14
15
  * key
15
16
  * value
16
- * ionoscloud_username
17
- * ionoscloud_password
17
+ * ionoscloud\_username
18
+ * ionoscloud\_password
18
19
 
19
- ```
20
+ ```text
20
21
  type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
21
22
  type of the resource to be labeled. Must be one of [datacenter, server, volume, ipblock, snapshot] (required)
22
23
 
@@ -37,9 +38,11 @@ Add a Label to a Resource.
37
38
 
38
39
  ionoscloud_password: --password PASSWORD, -p PASSWORD
39
40
  your Ionoscloud password (required)
40
-
41
41
  ```
42
42
 
43
43
  ## Example
44
44
 
45
- knife ionoscloud label add --resource-type RESOURCE_TYPE --key KEY --value VALUE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
45
+ ```text
46
+ knife ionoscloud label add --resource-type RESOURCE_TYPE --key KEY --value VALUE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
47
+ ```
48
+
data/docs/subcommands/label_list.md CHANGED
@@ -2,17 +2,18 @@
2
2
 
3
3
  List all Labels available to the user. Specify the type and required resource ID to list labels for a specific resource instead.
4
4
 
5
- knife ionoscloud label list (options)
6
-
5
+ ```text
6
+ knife ionoscloud label 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
  type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
17
18
  type of the resource to be labeled.
18
19
 
@@ -27,9 +28,11 @@ List all Labels available to the user. Specify the type and required resource ID
27
28
 
28
29
  ionoscloud_password: --password PASSWORD, -p PASSWORD
29
30
  your Ionoscloud password (required)
30
-
31
31
  ```
32
32
 
33
33
  ## Example
34
34
 
35
- knife ionoscloud label list --resource-type RESOURCE_TYPE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
35
+ ```text
36
+ knife ionoscloud label list --resource-type RESOURCE_TYPE --datacenter-id DATACENTER_ID --resource-id RESOURCE_ID --username USERNAME --password PASSWORD
37
+ ```
38
+
data/docs/subcommands/label_remove.md CHANGED
@@ -2,19 +2,20 @@
2
2
 
3
3
  Remove a Label from a Resource.
4
4
 
5
- knife ionoscloud label remove LABEL_KEY [LABEL_KEY] (options)
6
-
5
+ ```text
6
+ knife ionoscloud label remove LABEL_KEY [LABEL_KEY] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
+
12
13
  * type
13
- * resource_id
14
- * ionoscloud_username
15
- * ionoscloud_password
14
+ * resource\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
16
17
 
17
- ```
18
+ ```text
18
19
  type: --resource-type RESOURCE_TYPE, -T RESOURCE_TYPE
19
20
  type of the resource to be labeled. (required)
20
21
 
@@ -29,9 +30,11 @@ Remove a Label from a Resource.
29
30
 
30
31
  ionoscloud_password: --password PASSWORD, -p PASSWORD
31
32
  your Ionoscloud password (required)
32
-
33
33
  ```
34
34
 
35
35
  ## Example
36
36
 
37
- knife ionoscloud label remove LABEL_KEY
37
+ ```text
38
+ knife ionoscloud label remove LABEL_KEY
39
+ ```
40
+
data/docs/subcommands/lan_create.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  Creates a new LAN under a data center.
4
4
 
5
- knife ionoscloud lan create (options)
6
-
5
+ ```text
6
+ knife ionoscloud lan create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * datacenter\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
18
19
  name of the data center (required)
19
20
 
@@ -28,9 +29,11 @@ Creates a new LAN under a data center.
28
29
 
29
30
  ionoscloud_password: --password PASSWORD, -p PASSWORD
30
31
  your Ionoscloud password (required)
31
-
32
32
  ```
33
33
 
34
34
  ## Example
35
35
 
36
- knife ionoscloud lan create --datacenter-id DATACENTER_ID --name NAME --public --username USERNAME --password PASSWORD
36
+ ```text
37
+ knife ionoscloud lan create --datacenter-id DATACENTER_ID --name NAME --public --username USERNAME --password PASSWORD
38
+ ```
39
+
data/docs/subcommands/lan_delete.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  Deletes an existing LAN.
4
4
 
5
- knife ionoscloud lan delete LAN_ID [LAN_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud lan delete LAN_ID [LAN_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * datacenter\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
18
19
  name of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ Deletes an existing LAN.
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 lan delete LAN_ID
30
+ ```text
31
+ knife ionoscloud lan delete LAN_ID
32
+ ```
33
+
data/docs/subcommands/lan_list.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  Lists all available LANs under a data center.
4
4
 
5
- knife ionoscloud lan list (options)
6
-
5
+ ```text
6
+ knife ionoscloud lan list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * datacenter\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
18
19
  the ID of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ Lists all available LANs under a data center.
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 lan list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud lan list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
data/docs/subcommands/loadbalancer_create.md CHANGED
@@ -2,19 +2,20 @@
2
2
 
3
3
  Creates a load balancer within the VDC. Load balancers can be used for public or private IP traffic.
4
4
 
5
- knife ionoscloud loadbalancer create (options)
6
-
5
+ ```text
6
+ knife ionoscloud loadbalancer create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
12
+
13
+ * datacenter\_id
13
14
  * name
14
- * ionoscloud_username
15
- * ionoscloud_password
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
16
17
 
17
- ```
18
+ ```text
18
19
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
19
20
  name of the data center (required)
20
21
 
@@ -35,9 +36,11 @@ Creates a load balancer within the VDC. Load balancers can be used for public or
35
36
 
36
37
  ionoscloud_password: --password PASSWORD, -p PASSWORD
37
38
  your Ionoscloud password (required)
38
-
39
39
  ```
40
40
 
41
41
  ## Example
42
42
 
43
- knife ionoscloud loadbalancer create --datacenter-id DATACENTER_ID --name NAME --ip IP --dhcp DHCP --nics NIC_ID [NIC_ID] --username USERNAME --password PASSWORD
43
+ ```text
44
+ knife ionoscloud loadbalancer create --datacenter-id DATACENTER_ID --name NAME --ip IP --dhcp DHCP --nics NIC_ID [NIC_ID] --username USERNAME --password PASSWORD
45
+ ```
46
+
data/docs/subcommands/loadbalancer_delete.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  Deletes the specified load balancer.
4
4
 
5
- knife ionoscloud loadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud loadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * datacenter\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
18
19
  name of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ Deletes the specified load balancer.
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 loadbalancer delete LOAD_BALANCER_ID
30
+ ```text
31
+ knife ionoscloud loadbalancer delete LOAD_BALANCER_ID
32
+ ```
33
+
data/docs/subcommands/loadbalancer_get.md CHANGED
@@ -2,19 +2,20 @@
2
2
 
3
3
  Retrieves the attributes of a given load balancer. This will also retrieve a list of NICs associated with the load balancer.
4
4
 
5
- knife ionoscloud loadbalancer get (options)
6
-
5
+ ```text
6
+ knife ionoscloud loadbalancer get (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * loadbalancer_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * datacenter\_id
14
+ * loadbalancer\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
19
20
  iD of the data center (required)
20
21
 
@@ -26,9 +27,11 @@ Retrieves the attributes of a given load balancer. This will also retrieve a lis
26
27
 
27
28
  ionoscloud_password: --password PASSWORD, -p PASSWORD
28
29
  your Ionoscloud password (required)
29
-
30
30
  ```
31
31
 
32
32
  ## Example
33
33
 
34
- knife ionoscloud loadbalancer get --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --username USERNAME --password PASSWORD
34
+ ```text
35
+ knife ionoscloud loadbalancer get --datacenter-id DATACENTER_ID --loadbalancer-id LOADBALANCER_ID --username USERNAME --password PASSWORD
36
+ ```
37
+
data/docs/subcommands/loadbalancer_list.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieve a list of load balancers within the virtual data center.
4
4
 
5
- knife ionoscloud loadbalancer list (options)
6
-
5
+ ```text
6
+ knife ionoscloud loadbalancer list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * datacenter\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
18
19
  name of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ Retrieve a list of load balancers within the virtual data center.
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 loadbalancer list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud loadbalancer list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+