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,25 +2,28 @@
2
2
 
3
3
  Lists information about available contract resources.
4
4
 
5
- knife ionoscloud contract list
6
-
5
+ ```text
6
+ knife ionoscloud contract 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 contract list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud contract list--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,23 +2,25 @@
2
2
 
3
3
  Unless you are planning to manage an existing Ionoscloud environment, the first step will typically involve choosing the location for a new virtual data centerA list of locations can be obtained with location command.
4
4
 
5
- knife ionoscloud location list
5
+ ```text
6
+ knife ionoscloud location list
7
+ ```
6
8
 
7
9
  Make a note of the desired location ID and now the data center can be created.
8
10
 
9
-
10
- knife ionoscloud datacenter create (options)
11
-
11
+ ```text
12
+ knife ionoscloud datacenter create (options)
13
+ ```
12
14
 
13
15
  ## Available options:
14
- ---
15
16
 
16
17
  ### Required options:
18
+
17
19
  * location
18
- * ionoscloud_username
19
- * ionoscloud_password
20
+ * ionoscloud\_username
21
+ * ionoscloud\_password
20
22
 
21
- ```
23
+ ```text
22
24
  name: --name NAME, -n NAME
23
25
  name of the data center
24
26
 
@@ -33,9 +35,11 @@ Make a note of the desired location ID and now the data center can be created.
33
35
 
34
36
  ionoscloud_password: --password PASSWORD, -p PASSWORD
35
37
  your Ionoscloud password (required)
36
-
37
38
  ```
38
39
 
39
40
  ## Example
40
41
 
41
- knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD
42
+ ```text
43
+ knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD
44
+ ```
45
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  You will want to exercise a bit of caution here. Removing a data center will destroy all objects contained within that data center -- servers, volumes, snapshots, and so on. The objects -- once removed -- will be unrecoverable.
4
4
 
5
- knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]
6
-
5
+ ```text
6
+ knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_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 datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Ionoscloud introduces the concept of virtual data centers. These are logically separated from one another and allow you to have a self-contained environment for all servers, volumes, networking, and other resources. The goal is to give you the same experience as you would have if you were running your own physical data center. A list of available data centers can be obtained with the following command.
4
4
 
5
- knife ionoscloud datacenter list
6
-
5
+ ```text
6
+ knife ionoscloud datacenter 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 datacenter list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud datacenter list--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,20 +2,21 @@
2
2
 
3
3
  Creates a new firewall rule on an existing NIC.
4
4
 
5
- knife ionoscloud firewall create (options)
6
-
5
+ ```text
6
+ knife ionoscloud firewall create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * server_id
14
- * nic_id
15
- * ionoscloud_username
16
- * ionoscloud_password
17
12
 
18
- ```
13
+ * datacenter\_id
14
+ * server\_id
15
+ * nic\_id
16
+ * ionoscloud\_username
17
+ * ionoscloud\_password
18
+
19
+ ```text
19
20
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
20
21
  iD of the data center (required)
21
22
 
@@ -57,9 +58,11 @@ Creates a new firewall rule on an existing NIC.
57
58
 
58
59
  ionoscloud_password: --password PASSWORD, -p PASSWORD
59
60
  your Ionoscloud password (required)
60
-
61
61
  ```
62
62
 
63
63
  ## Example
64
64
 
65
- knife ionoscloud firewall create --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --username USERNAME --password PASSWORD
65
+ ```text
66
+ knife ionoscloud firewall create --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --name NAME --protocol PROTOCOL --source-mac MAC --source-ip IP --target-ip IP --port-range-start PORT --port-range-end PORT --icmp-type INT --icmp-code INT --username USERNAME --password PASSWORD
67
+ ```
68
+
@@ -2,20 +2,21 @@
2
2
 
3
3
  Deletes a firewall rule from an existing NIC.
4
4
 
5
- knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * server_id
14
- * nic_id
15
- * ionoscloud_username
16
- * ionoscloud_password
17
12
 
18
- ```
13
+ * datacenter\_id
14
+ * server\_id
15
+ * nic\_id
16
+ * ionoscloud\_username
17
+ * ionoscloud\_password
18
+
19
+ ```text
19
20
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
20
21
  the ID of the data center (required)
21
22
 
@@ -30,9 +31,11 @@ Deletes a firewall rule from an existing NIC.
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 firewall delete FIREWALL_ID
38
+ ```text
39
+ knife ionoscloud firewall delete FIREWALL_ID
40
+ ```
41
+
@@ -2,20 +2,21 @@
2
2
 
3
3
  Lists all available firewall rules assigned to a NIC.
4
4
 
5
- knife ionoscloud firewall list (options)
6
-
5
+ ```text
6
+ knife ionoscloud firewall list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * server_id
14
- * nic_id
15
- * ionoscloud_username
16
- * ionoscloud_password
17
12
 
18
- ```
13
+ * datacenter\_id
14
+ * server\_id
15
+ * nic\_id
16
+ * ionoscloud\_username
17
+ * ionoscloud\_password
18
+
19
+ ```text
19
20
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
20
21
  iD of the data center (required)
21
22
 
@@ -30,9 +31,11 @@ Lists all available firewall rules assigned to a NIC.
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 firewall list --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD
38
+ ```text
39
+ knife ionoscloud firewall list --datacenter-id DATACENTER_ID --server-id SERVER_ID --nic-id NIC_ID --username USERNAME --password PASSWORD
40
+ ```
41
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Use this operation to create a new group and set group privileges.
4
4
 
5
- knife ionoscloud group create (options)
6
-
5
+ ```text
6
+ knife ionoscloud group create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
+
12
13
  * name
13
- * ionoscloud_username
14
- * ionoscloud_password
14
+ * ionoscloud\_username
15
+ * ionoscloud\_password
15
16
 
16
- ```
17
+ ```text
17
18
  name: --name NAME, -N NAME
18
19
  mame of the group. (required)
19
20
 
@@ -40,9 +41,11 @@ Use this operation to create a new group and set group privileges.
40
41
 
41
42
  ionoscloud_password: --password PASSWORD, -p PASSWORD
42
43
  your Ionoscloud password (required)
43
-
44
44
  ```
45
45
 
46
46
  ## Example
47
47
 
48
- knife ionoscloud group create --name NAME --create-datacenter --create-snapshot --reserve-ip --access-log --s3 --create-backupunit --username USERNAME --password PASSWORD
48
+ ```text
49
+ knife ionoscloud group create --name NAME --create-datacenter --create-snapshot --reserve-ip --access-log --s3 --create-backupunit --username USERNAME --password PASSWORD
50
+ ```
51
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Use this operation to delete a single group. Resources that are assigned to the group are NOT deleted, but are no longer accessible to the group members unless the member is a Contract Owner, Admin, or Resource Owner.
4
4
 
5
- knife ionoscloud group delete GROUP_ID [GROUP_ID]
6
-
5
+ ```text
6
+ knife ionoscloud group delete GROUP_ID [GROUP_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 group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud group delete GROUP_ID [GROUP_ID]--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Retrieves detailed information about a specific group. This will also retrieve a list of users who are members of the group.
4
4
 
5
- knife ionoscloud group get (options)
6
-
5
+ ```text
6
+ knife ionoscloud group get (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 detailed information about a specific group. This will also retrieve a
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 group get --group-id GROUP_ID --username USERNAME --password PASSWORD
30
+ ```text
31
+ knife ionoscloud group get --group-id GROUP_ID --username USERNAME --password PASSWORD
32
+ ```
33
+
@@ -2,17 +2,18 @@
2
2
 
3
3
  This retrieves a full list of all groups.
4
4
 
5
- knife ionoscloud group list (options)
6
-
5
+ ```text
6
+ knife ionoscloud group 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
  user_id: --user-id USER_ID, -u USER_ID
17
18
  iD of the user.
18
19
 
@@ -21,9 +22,11 @@ This retrieves a full list of all groups.
21
22
 
22
23
  ionoscloud_password: --password PASSWORD, -p PASSWORD
23
24
  your Ionoscloud password (required)
24
-
25
25
  ```
26
26
 
27
27
  ## Example
28
28
 
29
- knife ionoscloud group list --user-id USER_ID --username USERNAME --password PASSWORD
29
+ ```text
30
+ knife ionoscloud group list --user-id USER_ID --username USERNAME --password PASSWORD
31
+ ```
32
+