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,22 +2,23 @@
2
2
 
3
3
  One of the unique features of the Ionoscloud platform when compared with the other providers is that they allow you to define your own settings for cores, memory, and disk size without being tied to a particular size or flavor.
4
4
 
5
- Note: *The memory parameter value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so forth.*
6
-
7
- knife ionoscloud server create (options)
5
+ Note: _The memory parameter value must be a multiple of 256, e.g. 256, 512, 768, 1024, and so forth._
8
6
 
7
+ ```text
8
+ knife ionoscloud server create (options)
9
+ ```
9
10
 
10
11
  ## Available options:
11
- ---
12
12
 
13
13
  ### Required options:
14
- * datacenter_id
14
+
15
+ * datacenter\_id
15
16
  * cores
16
17
  * ram
17
- * ionoscloud_username
18
- * ionoscloud_password
18
+ * ionoscloud\_username
19
+ * ionoscloud\_password
19
20
 
20
- ```
21
+ ```text
21
22
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
22
23
  name of the virtual datacenter (required)
23
24
 
@@ -47,9 +48,11 @@ Note: *The memory parameter value must be a multiple of 256, e.g. 256, 512, 768,
47
48
 
48
49
  ionoscloud_password: --password PASSWORD, -p PASSWORD
49
50
  your Ionoscloud password (required)
50
-
51
51
  ```
52
52
 
53
53
  ## Example
54
54
 
55
- knife ionoscloud server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD
55
+ ```text
56
+ knife ionoscloud server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --boot-volume VOLUME_ID --boot-cdrom CDROM_ID --username USERNAME --password PASSWORD
57
+ ```
58
+
@@ -2,20 +2,21 @@
2
2
 
3
3
  This will remove a server from a VDC.
4
4
 
5
- **NOTE**: This will not automatically remove the storage volume(s) attached to a server. A separate API call is required to perform that action.
6
-
7
- knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
5
+ **NOTE**: This will not automatically remove the storage volume\(s\) attached to a server. A separate API call is required to perform that action.
8
6
 
7
+ ```text
8
+ knife ionoscloud server delete SERVER_ID [SERVER_ID] (options)
9
+ ```
9
10
 
10
11
  ## Available options:
11
- ---
12
12
 
13
13
  ### Required options:
14
- * datacenter_id
15
- * ionoscloud_username
16
- * ionoscloud_password
17
14
 
18
- ```
15
+ * datacenter\_id
16
+ * ionoscloud\_username
17
+ * ionoscloud\_password
18
+
19
+ ```text
19
20
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
20
21
  name of the data center (required)
21
22
 
@@ -24,9 +25,11 @@ This will remove a server from a VDC.
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 server delete SERVER_ID
32
+ ```text
33
+ knife ionoscloud server delete SERVER_ID
34
+ ```
35
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  List all available servers under a specified data center.
4
4
 
5
- knife ionoscloud server list (options)
6
-
5
+ ```text
6
+ knife ionoscloud server 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 datacenter containing the server (required)
19
20
 
@@ -22,9 +23,11 @@ List all available servers under a specified 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 server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud server list --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  This will force a hard reboot of the server. Do not use this method if you want to gracefully reboot the machine. This is the equivalent of powering off the machine and turning it back on.
4
4
 
5
- knife ionoscloud server reboot SERVER_ID [SERVER_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud server reboot SERVER_ID [SERVER_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
  iD of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ This will force a hard reboot of the server. Do not use this method if you want
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 server reboot SERVER_ID
30
+ ```text
31
+ knife ionoscloud server reboot SERVER_ID
32
+ ```
33
+
@@ -1,19 +1,20 @@
1
1
  # ServerStart
2
2
 
3
- This will start a server. If the server's public IP was deallocated then a new IP will be assigned.
4
-
5
- knife ionoscloud server start SERVER_ID [SERVER_ID] (options)
3
+ This will start a server. If the server's public IP was deallocated then a new IP will be assigned.
6
4
 
5
+ ```text
6
+ knife ionoscloud server start SERVER_ID [SERVER_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
  iD of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ This will start a server. If the server's public IP was deallocated then a n
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 server start SERVER_ID
30
+ ```text
31
+ knife ionoscloud server start SERVER_ID
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  This will stop a server. The machine will be forcefully powered off, billing will cease, and the public IP, if one is allocated, will be deallocated.
4
4
 
5
- knife ionoscloud server stop SERVER_ID [SERVER_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud server stop SERVER_ID [SERVER_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
  iD of the data center (required)
19
20
 
@@ -22,9 +23,11 @@ This will stop a server. The machine will be forcefully powered off, billing wil
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 server stop SERVER_ID
30
+ ```text
31
+ knife ionoscloud server stop SERVER_ID
32
+ ```
33
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  Adds a specific resource share to a group and optionally allows the setting of permissions for that resource. As an example, you might use this to grant permissions to use an image or snapshot to a specific group.
4
4
 
5
- knife ionoscloud share create (options)
6
-
5
+ ```text
6
+ knife ionoscloud share create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * group_id
13
- * resource_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * group\_id
14
+ * resource\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  group_id: --group-id GROUP_ID, -G GROUP_ID
19
20
  iD of the group. (required)
20
21
 
@@ -32,9 +33,11 @@ Adds a specific resource share to a group and optionally allows the setting of p
32
33
 
33
34
  ionoscloud_password: --password PASSWORD, -p PASSWORD
34
35
  your Ionoscloud password (required)
35
-
36
36
  ```
37
37
 
38
38
  ## Example
39
39
 
40
- knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD
40
+ ```text
41
+ knife ionoscloud share create --group-id GROUP_ID --resource-id RESOURCE_ID --edit --share --username USERNAME --password PASSWORD
42
+ ```
43
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Removes a resource share from a specified group.
4
4
 
5
- knife ionoscloud server delete SHARE_ID [SHARE_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud server delete SHARE_ID [SHARE_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * group_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * group\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  group_id: --group-id GROUP_ID, -G GROUP_ID
18
19
  iD of the group. (required)
19
20
 
@@ -22,9 +23,11 @@ Removes a resource share from a specified group.
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 server delete SHARE_ID
30
+ ```text
31
+ knife ionoscloud server delete SHARE_ID
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieves a full list of all the resources that are shared through this group and lists the permissions granted to the group members for each shared resource.
4
4
 
5
- knife ionoscloud share list (options)
6
-
5
+ ```text
6
+ knife ionoscloud share list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * group_id
13
- * ionoscloud_username
14
- * ionoscloud_password
15
12
 
16
- ```
13
+ * group\_id
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
16
+
17
+ ```text
17
18
  group_id: --group-id GROUP_ID, -G GROUP_ID
18
19
  iD of the group. (required)
19
20
 
@@ -22,9 +23,11 @@ Retrieves a full list of all the resources that are shared through this group an
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 share list --group-id GROUP_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud share list --group-id GROUP_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  Creates a snapshot of a volume within the virtual data center. You can use a snapshot to create a new storage volume or to restore a storage volume.
4
4
 
5
- knife ionoscloud snapshot create (options)
6
-
5
+ ```text
6
+ knife ionoscloud snapshot create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * volume_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * datacenter\_id
14
+ * volume\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  datacenter_id: --datacenter DATACENTER_ID, -D DATACENTER_ID
19
20
  iD of the Datacenter (required)
20
21
 
@@ -26,9 +27,11 @@ Creates a snapshot of a volume within the virtual data center. You can use a sna
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 snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --username USERNAME --password PASSWORD
34
+ ```text
35
+ knife ionoscloud snapshot create --datacenter DATACENTER_ID --volume VOLUME_ID --username USERNAME --password PASSWORD
36
+ ```
37
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Deletes the specified snapshot.
4
4
 
5
- knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]
6
-
5
+ ```text
6
+ knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_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 snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud snapshot delete SNAPSHOT_ID [SNAPSHOT_ID]--username USERNAME --password PASSWORD
28
+ ```
29
+