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
  Use this operation to add an existing user to a group.
4
4
 
5
- knife ionoscloud group user add USER_ID [USER_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud group user add USER_ID [USER_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 @@ Use this operation to add an existing user to a 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 group user add USER_ID
30
+ ```text
31
+ knife ionoscloud group user add USER_ID
32
+ ```
33
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Use this operation to remove a user from a group.
4
4
 
5
- knife ionoscloud group user remove USER_ID [USER_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud group user remove USER_ID [USER_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 @@ Use this operation to remove a user from a 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 group user remove USER_ID
30
+ ```text
31
+ knife ionoscloud group user remove USER_ID
32
+ ```
33
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  A list of disk and ISO images are available from Ionoscloud for immediate use. Make sure the image you use is in the same location as the virtual data center.
4
4
 
5
- knife ionoscloud image list
6
-
5
+ ```text
6
+ knife ionoscloud image 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 image list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud image list--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -1,20 +1,21 @@
1
1
  # IpblockCreate
2
2
 
3
- Reserves an IP block at a specified location that can be used by resources within any VDCs provisioned in that same location. An IP block consists of one or more static IP addresses. The IP block size (number of IP addresses) and location are required to reserve an IP block.
4
-
5
- knife ionoscloud ipblock create (options)
3
+ Reserves an IP block at a specified location that can be used by resources within any VDCs provisioned in that same location. An IP block consists of one or more static IP addresses. The IP block size \(number of IP addresses\) and location are required to reserve an IP block.
6
4
 
5
+ ```text
6
+ knife ionoscloud ipblock create (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
+
12
13
  * size
13
14
  * location
14
- * ionoscloud_username
15
- * ionoscloud_password
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
16
17
 
17
- ```
18
+ ```text
18
19
  location: --location LOCATION, -l LOCATION
19
20
  location of the IP block (us/las, us/ewr, de/fra, de/fkb) (required)
20
21
 
@@ -29,9 +30,11 @@ Reserves an IP block at a specified location that can be used by resources withi
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 ipblock create --location LOCATION --size INT --name NAME --username USERNAME --password PASSWORD
37
+ ```text
38
+ knife ionoscloud ipblock create --location LOCATION --size INT --name NAME --username USERNAME --password PASSWORD
39
+ ```
40
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Releases a currently assigned IP block.
4
4
 
5
- knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]
6
-
5
+ ```text
6
+ knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_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 ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud ipblock delete IPBLOCK_ID [IPBLOCK_ID]--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Lists all available IP blocks.
4
4
 
5
- knife ionoscloud ipblock list
6
-
5
+ ```text
6
+ knife ionoscloud ipblock 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 ipblock list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud ipblock list--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -1,26 +1,27 @@
1
1
  # IpfailoverAdd
2
2
 
3
3
  Successfully setting up an IP Failover group requires three steps:
4
+
4
5
  * Add a reserved IP address to a NIC that will become the IP Failover master.
5
6
  * Use PATCH or PUT to enable ipFailover by providing the relevant ip and nicUuid values.
6
7
  * Add the same reserved IP address to any other NICs that are a member of the same LAN. Those NICs will become IP Failover members.
7
8
 
8
-
9
- knife ionoscloud ipfailover add (options)
10
-
9
+ ```text
10
+ knife ionoscloud ipfailover add (options)
11
+ ```
11
12
 
12
13
  ## Available options:
13
- ---
14
14
 
15
15
  ### Required options:
16
- * datacenter_id
17
- * lan_id
16
+
17
+ * datacenter\_id
18
+ * lan\_id
18
19
  * ip
19
- * nic_id
20
- * ionoscloud_username
21
- * ionoscloud_password
20
+ * nic\_id
21
+ * ionoscloud\_username
22
+ * ionoscloud\_password
22
23
 
23
- ```
24
+ ```text
24
25
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
25
26
  name of the data center (required)
26
27
 
@@ -38,9 +39,11 @@ Successfully setting up an IP Failover group requires three steps:
38
39
 
39
40
  ionoscloud_password: --password PASSWORD, -p PASSWORD
40
41
  your Ionoscloud password (required)
41
-
42
42
  ```
43
43
 
44
44
  ## Example
45
45
 
46
- knife ionoscloud ipfailover add --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
46
+ ```text
47
+ knife ionoscloud ipfailover add --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
48
+ ```
49
+
@@ -2,21 +2,22 @@
2
2
 
3
3
  Remove IP Failover from LAN
4
4
 
5
- knife ionoscloud ipfailover remove (options)
6
-
5
+ ```text
6
+ knife ionoscloud ipfailover remove (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * lan_id
12
+
13
+ * datacenter\_id
14
+ * lan\_id
14
15
  * ip
15
- * nic_id
16
- * ionoscloud_username
17
- * ionoscloud_password
16
+ * nic\_id
17
+ * ionoscloud\_username
18
+ * ionoscloud\_password
18
19
 
19
- ```
20
+ ```text
20
21
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
21
22
  name of the data center (required)
22
23
 
@@ -34,9 +35,11 @@ Remove IP Failover from LAN
34
35
 
35
36
  ionoscloud_password: --password PASSWORD, -p PASSWORD
36
37
  your Ionoscloud password (required)
37
-
38
38
  ```
39
39
 
40
40
  ## Example
41
41
 
42
- knife ionoscloud ipfailover remove --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
42
+ ```text
43
+ knife ionoscloud ipfailover remove --datacenter-id DATACENTER_ID --lan-id LAN_ID --ip IP --nic-id NIC_ID --username USERNAME --password PASSWORD
44
+ ```
45
+
@@ -2,18 +2,19 @@
2
2
 
3
3
  Creates a new Managed Kubernetes cluster.
4
4
 
5
- knife ionoscloud k8s create (options)
6
-
5
+ ```text
6
+ knife ionoscloud k8s 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
  name of the server (required)
19
20
 
@@ -31,9 +32,11 @@ Creates a new Managed Kubernetes cluster.
31
32
 
32
33
  ionoscloud_password: --password PASSWORD, -p PASSWORD
33
34
  your Ionoscloud password (required)
34
-
35
35
  ```
36
36
 
37
37
  ## Example
38
38
 
39
- knife ionoscloud k8s create --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --username USERNAME --password PASSWORD
39
+ ```text
40
+ knife ionoscloud k8s create --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --username USERNAME --password PASSWORD
41
+ ```
42
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Deletes a Kubernetes cluster. The cluster cannot contain any node pools when deleting.
4
4
 
5
- knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_ID]
6
-
5
+ ```text
6
+ knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_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 k8s delete CLUSTER_ID [CLUSTER_ID]--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud k8s delete CLUSTER_ID [CLUSTER_ID]--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  Retrieve a list of Kubernetes clusters.
4
4
 
5
- knife ionoscloud k8s list
6
-
5
+ ```text
6
+ knife ionoscloud k8s 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 k8s list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud k8s list--username USERNAME --password PASSWORD
28
+ ```
29
+