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,19 +2,20 @@
2
2
 
3
3
  Adds the association of a NIC with a load balancer.
4
4
 
5
- knife ionoscloud loadbalancer nic add NIC_ID [NIC_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud loadbalancer nic add NIC_ID [NIC_ID] (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
  name of the data center (required)
20
21
 
@@ -26,9 +27,11 @@ Adds the association of a NIC with a load balancer.
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 nic add NIC_ID
34
+ ```text
35
+ knife ionoscloud loadbalancer nic add NIC_ID
36
+ ```
37
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  Removes the association of a NIC with a load balancer.
4
4
 
5
- knife ionoscloud loadbalancer nic remove NIC_ID [NIC_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud loadbalancer nic remove NIC_ID [NIC_ID] (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
  name of the data center (required)
20
21
 
@@ -26,9 +27,11 @@ Removes the association of a NIC with a load balancer.
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 nic remove NIC_ID
34
+ ```text
35
+ knife ionoscloud loadbalancer nic remove NIC_ID
36
+ ```
37
+
@@ -2,25 +2,28 @@
2
2
 
3
3
  List available physical locations where resources can reside.
4
4
 
5
- knife ionoscloud location list
6
-
5
+ ```text
6
+ knife ionoscloud location 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 location list--username USERNAME --password PASSWORD
26
+ ```text
27
+ knife ionoscloud location list--username USERNAME --password PASSWORD
28
+ ```
29
+
@@ -1,22 +1,22 @@
1
1
  # NicCreate
2
2
 
3
- Creates a NIC on the specified server.
4
- The Ionoscloud platform supports adding multiple NICs to a server. These NICs can be used to create different, segmented networks on the platform.
5
-
6
- knife ionoscloud nic create (options)
3
+ Creates a NIC on the specified server. The Ionoscloud platform supports adding multiple NICs to a server. These NICs can be used to create different, segmented networks on the platform.
7
4
 
5
+ ```text
6
+ knife ionoscloud nic create (options)
7
+ ```
8
8
 
9
9
  ## Available options:
10
- ---
11
10
 
12
11
  ### Required options:
13
- * datacenter_id
14
- * server_id
12
+
13
+ * datacenter\_id
14
+ * server\_id
15
15
  * lan
16
- * ionoscloud_username
17
- * ionoscloud_password
16
+ * ionoscloud\_username
17
+ * ionoscloud\_password
18
18
 
19
- ```
19
+ ```text
20
20
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
21
21
  name of the data center (required)
22
22
 
@@ -43,9 +43,11 @@ The Ionoscloud platform supports adding multiple NICs to a server. These NICs ca
43
43
 
44
44
  ionoscloud_password: --password PASSWORD, -p PASSWORD
45
45
  your Ionoscloud password (required)
46
-
47
46
  ```
48
47
 
49
48
  ## Example
50
49
 
51
- knife ionoscloud nic create --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --ips IP[,IP,...] --dhcp --lan ID --nat --username USERNAME --password PASSWORD
50
+ ```text
51
+ knife ionoscloud nic create --datacenter-id DATACENTER_ID --server-id SERVER_ID --name NAME --ips IP[,IP,...] --dhcp --lan ID --nat --username USERNAME --password PASSWORD
52
+ ```
53
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  Deletes an existing NIC from a server.
4
4
 
5
- knife ionoscloud nic delete NIC_ID [NIC_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud nic delete NIC_ID [NIC_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * server_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * datacenter\_id
14
+ * server\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
19
20
  the ID of the data center (required)
20
21
 
@@ -26,9 +27,11 @@ Deletes an existing NIC from a server.
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 nic delete NIC_ID
34
+ ```text
35
+ knife ionoscloud nic delete NIC_ID
36
+ ```
37
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  List all available NICs connected to a server.
4
4
 
5
- knife ionoscloud nic list (options)
6
-
5
+ ```text
6
+ knife ionoscloud nic list (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * datacenter_id
13
- * server_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * datacenter\_id
14
+ * server\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
19
20
  the ID of the datacenter containing the NIC (required)
20
21
 
@@ -26,9 +27,11 @@ List all available NICs connected to a server.
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 nic list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
34
+ ```text
35
+ knife ionoscloud nic list --datacenter-id DATACENTER_ID --server-id SERVER_ID --username USERNAME --password PASSWORD
36
+ ```
37
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  Delete a single Kubernetes Node.
4
4
 
5
- knife ionoscloud node delete NODE_ID [NODE_ID] (options)
6
-
5
+ ```text
6
+ knife ionoscloud node delete NODE_ID [NODE_ID] (options)
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * cluster_id
13
- * nodepool_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * cluster\_id
14
+ * nodepool\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
19
20
  the ID of the K8s Cluster (required)
20
21
 
@@ -26,9 +27,11 @@ Delete a single Kubernetes Node.
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 node delete NODE_ID
34
+ ```text
35
+ knife ionoscloud node delete NODE_ID
36
+ ```
37
+
@@ -2,19 +2,20 @@
2
2
 
3
3
  Retrieve a list of Kubernetes Nodes in a Nodepool.
4
4
 
5
- knife ionoscloud node list
6
-
5
+ ```text
6
+ knife ionoscloud node list
7
+ ```
7
8
 
8
9
  ## Available options:
9
- ---
10
10
 
11
11
  ### Required options:
12
- * cluster_id
13
- * nodepool_id
14
- * ionoscloud_username
15
- * ionoscloud_password
16
12
 
17
- ```
13
+ * cluster\_id
14
+ * nodepool\_id
15
+ * ionoscloud\_username
16
+ * ionoscloud\_password
17
+
18
+ ```text
18
19
  cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
19
20
  the ID of the K8s Cluster (required)
20
21
 
@@ -26,9 +27,11 @@ Retrieve a list of Kubernetes Nodes in a Nodepool.
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 node list--cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD
34
+ ```text
35
+ knife ionoscloud node list--cluster-id CLUSTER_ID --nodepool-id NODEPOOL_ID --username USERNAME --password PASSWORD
36
+ ```
37
+
@@ -2,21 +2,22 @@
2
2
 
3
3
  You can recreate a single Kubernetes Node.
4
4
 
5
- Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
6
-
7
- knife ionoscloud node replace NODE_ID [NODE_ID] (options)
5
+ Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
8
6
 
7
+ ```text
8
+ knife ionoscloud node replace NODE_ID [NODE_ID] (options)
9
+ ```
9
10
 
10
11
  ## Available options:
11
- ---
12
12
 
13
13
  ### Required options:
14
- * cluster_id
15
- * nodepool_id
16
- * ionoscloud_username
17
- * ionoscloud_password
18
14
 
19
- ```
15
+ * cluster\_id
16
+ * nodepool\_id
17
+ * ionoscloud\_username
18
+ * ionoscloud\_password
19
+
20
+ ```text
20
21
  cluster_id: --cluster-id CLUSTER_ID, -C CLUSTER_ID
21
22
  the ID of the K8s Cluster (required)
22
23
 
@@ -28,9 +29,11 @@ Managed Kubernetes starts a process which based on the nodepool's template c
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 node replace NODE_ID
36
+ ```text
37
+ knife ionoscloud node replace NODE_ID
38
+ ```
39
+
@@ -1,31 +1,32 @@
1
1
  # NodepoolCreate
2
2
 
3
- Creates a node pool into an existing Kubernetes cluster. The Kubernetes cluster must be in state "ACTIVE" before creating a node pool.
3
+ Creates a node pool into an existing Kubernetes cluster. The Kubernetes cluster must be in state "ACTIVE" before creating a node pool.
4
4
 
5
5
  The worker nodes within the node pools will be deployed into an existing data centers.
6
6
 
7
- knife ionoscloud nodepool create (options)
8
-
7
+ ```text
8
+ knife ionoscloud nodepool create (options)
9
+ ```
9
10
 
10
11
  ## Available options:
11
- ---
12
12
 
13
13
  ### Required options:
14
- * datacenter_id
15
- * cluster_id
14
+
15
+ * datacenter\_id
16
+ * cluster\_id
16
17
  * name
17
18
  * version
18
- * node_count
19
- * cpu_family
19
+ * node\_count
20
+ * cpu\_family
20
21
  * cores
21
22
  * ram
22
- * availability_zone
23
- * storage_type
24
- * storage_size
25
- * ionoscloud_username
26
- * ionoscloud_password
23
+ * availability\_zone
24
+ * storage\_type
25
+ * storage\_size
26
+ * ionoscloud\_username
27
+ * ionoscloud\_password
27
28
 
28
- ```
29
+ ```text
29
30
  datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
30
31
  iD of the virtual datacenter (required)
31
32
 
@@ -79,9 +80,11 @@ The worker nodes within the node pools will be deployed into an existing data ce
79
80
 
80
81
  ionoscloud_password: --password PASSWORD, -p PASSWORD
81
82
  your Ionoscloud password (required)
82
-
83
83
  ```
84
84
 
85
85
  ## Example
86
86
 
87
- knife ionoscloud nodepool create --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --username USERNAME --password PASSWORD
87
+ ```text
88
+ knife ionoscloud nodepool create --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --username USERNAME --password PASSWORD
89
+ ```
90
+