knife-ionoscloud 5.0.0 → 6.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6f600f5f7cde46e790731b30ffd8180db5d375c4d6fd1b9b10647ee77bade25
-  data.tar.gz: 62d7fea589b66d308cee20a9849246fb31a983b6c919f91f910c2d718bf79652
+  metadata.gz: 466c2927e32f6d584559a80aee7a32f1a39834e02abd5fe0a10be5aad04f5a7f
+  data.tar.gz: 8d9ca6b4e1cded2da076149c2527d94b4e593db2de09f78681f510f6d855166c
 SHA512:
-  metadata.gz: f76084ab2fc1e1ef87e597a353442f91f7fe7ff3937b0bad75c26891aafb715f4f4260bbb383a718e335e28bc1009d97d1d470a1c27fb0ad95431ed0ecbb13ca
-  data.tar.gz: d23d88f3b5fcbb650cc6fdbe02c60c74451e67e990eb2652de9b6b4056e57d55c4fc9c9cc78265b2e50099bfe3a546ea335d6f4e29f00b8144f4a874f84409c2
+  metadata.gz: 57c94f8bd0a2098253ae4be624bb329f626989ca75f06447f123da416f4e40f37d5d2991e949616401af08a747e1c757b4bb52e52eec989d63edf6870bdd724f
+  data.tar.gz: 39602ed7873d6f61d162f500ba30f151c6a70e1ed9ec4a9c056dbb5fe41f9c048f653daaa3b7662defd1c38df53b01512e8c9cbd615ab723609357279e3abc62

data/.github/workflows/ci.yml

@@ -11,10 +11,10 @@ on:
 
 jobs:
   test:
-    env:
-      ruby-version: 2.7
-
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: [ 2.6, 2.7, 3.0 ]
 
     steps:
       - name: Checkout
@@ -23,7 +23,7 @@ jobs:
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1.61.1
         with:
-          ruby-version: ${{ env.ruby-version }}
+          ruby-version: ${{ matrix.ruby-version }}
 
       - name: Install Rubocop
         run: gem install rubocop

data/.github/workflows/publish.yml

@@ -46,9 +46,12 @@ jobs:
         id: old_version
         run: echo ::set-output name=VERSION::$(git tag --list "v*" --sort=version:refname | tail -n 2 | head -n 1)
 
+      - name: Get the release version
+        run: echo "RELEASE_VERSION=${GITHUB_REF:10}" >> $GITHUB_ENV
+
       - name: Check Version
         run: |
-          if [ "${{ steps.new_version.outputs.VERSION }}" != v$(cat lib/knife-ionoscloud/version.rb | grep 'VERSION =' | tr -s ' ' | cut -d ' ' -f 4 | sed 's/^.//;s/.$//') ]; then
+          if [ $RELEASE_VERSION != v$(cat lib/knife-ionoscloud/version.rb | grep 'VERSION =' | tr -s ' ' | cut -d ' ' -f 4 | sed 's/^.//;s/.$//') ]; then
             echo "Tag version does not match the one from version.rb!"
             exit 1
           fi

data/.rubocop.yml

@@ -1,7 +1,6 @@
 # This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
 # Automatically generated by OpenAPI Generator (https://openapi-generator.tech)
 AllCops:
-  TargetRubyVersion: 2.4
   # RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
   # to ignore them, so only the ones explicitly set in this file are enabled.
   DisabledByDefault: true

data/docs/README.md

@@ -67,6 +67,26 @@ $ export IONOSCLOUD_PASSWORD='password'
 $ rspec spec
 ```
 
+### Getting input from a file
+
+In order to make passing JSON or array arguments easier, we allow you to specify a file which holds the arguments for a command. This is done with the
+`--extra-config EXTRA_CONFIG_FILE_PATH` or `-e EXTRA_CONFIG_FILE_PATH`. The file is expected to contain a JSON which should map the name of arguments to their expected values. Here is an example of such a file.
+
+```json
+{
+  "ionoscloud_username": "username",
+  "ionoscloud_password": "password",
+  "name": "test_datacenter_name",
+  "location": "de/txl"
+}
+```
+
+When using the command `knife ionoscloud datacenter create --extra-config EXTRA_CONFIG_FILE_PATH` where EXTRA_CONFIG_FILE_PATH is the name of the file containing the JSON above, the arguments described in the file will be used. 
+
+* If any of the arguments are set in any other way, the values from the file will be ignored. Running the command `knife ionoscloud datacenter create --location us/las --extra-config EXTRA_CONFIG_FILE_PATH` will create a datacenter in the 'us/las' location. In the same way if the values for ionoscloud_username and ionoscloud_password are already set in the knife.rb file, the contents from the JSON will be ignored.
+* Only Ionoscloud specific options may be altered using this option.
+* If an option is ignored because it is not on the available options list or if it is overwritten in another way then a warning message will be displayed.
+
 ## Feature Reference
 
 The IONOS Cloud plugin for Knife aims to offer access to all resources in the IONOS Cloud API and also offers some additional features that make the integration easier:

data/docs/docs_generator.rb

@@ -49,7 +49,7 @@ def generate_subcommand_doc(subcommand)
     value[:required] = subcommand.required_options.include? key
     value[:description][0] = value[:description][0].downcase
     value
-  }.rotate(2)
+  }.rotate(3)
 
   subcommand_name = subcommand.class.to_s
   subcommand_name.slice!('Chef::Knife::Ionoscloud')
@@ -69,7 +69,7 @@ def generate_subcommand_doc(subcommand)
         options,
         description,
         subcommand_name,
-        subcommand.required_options,
+        subcommand.required_options.map { |el| el.to_s.gsub '_', '\_' },
       ).render,
     )
   }

data/docs/subcommands/backupunit_create.md

@@ -31,11 +31,13 @@ knife ionoscloud backupunit create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud backupunit create --name NAME --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD
+knife ionoscloud backupunit create --name NAME --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/backupunit_delete.md

@@ -19,11 +19,13 @@ knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]--username USERNAME --password PASSWORD
+knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/backupunit_list.md

@@ -19,11 +19,13 @@ knife ionoscloud backupunit list
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud backupunit list--username USERNAME --password PASSWORD
+knife ionoscloud backupunit list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/backupunit_ssourl.md

@@ -23,11 +23,13 @@ knife ionoscloud backupunit ssourl (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud backupunit ssourl --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD
+knife ionoscloud backupunit ssourl --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/composite_server_create.md

@@ -70,6 +70,12 @@ knife ionoscloud composite server create (options)
     ssh_keys: --ssh-keys SSHKEY1,SSHKEY2,..., -K SSHKEY[,SSHKEY,...]
         a list of public SSH keys to include
 
+    backupunit_id: --backupunit BACKUPUNIT_ID, -B BACKUPUNIT_ID
+        the uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property.
+
+    user_data: --user-data USER_DATA, -u USER_DATA
+        the cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property.
+
     nic_name: --nic-name NAME
         name of the NIC
 
@@ -82,19 +88,21 @@ knife ionoscloud composite server create (options)
     lan: --lan ID, -L ID
         the LAN ID the NIC will reside on; if the LAN ID does not exist it will be created (required)
 
-    nat: --nat
-        set to enable NAT on the NIC
+    firewall_type: --firewall-type FIREWALL_TYPE
+        the type of firewall rules that will be allowed on the NIC. If it is not specified it will take the default value INGRESS
 
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud composite server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --volume-name NAME --size SIZE --bus BUS --image ID --image-alias IMAGE_ALIAS --type TYPE --licence-type LICENCE --image-password PASSWORD --volume-availability-zone AVAILABILITY_ZONE --ssh-keys SSHKEY1,SSHKEY2,... --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --nat --username USERNAME --password PASSWORD
+knife ionoscloud composite server create --datacenter-id DATACENTER_ID --name NAME --cores CORES --cpu-family CPU_FAMILY --ram RAM --availability-zone AVAILABILITY_ZONE --volume-name NAME --size SIZE --bus BUS --image ID --image-alias IMAGE_ALIAS --type TYPE --licence-type LICENCE --image-password PASSWORD --volume-availability-zone AVAILABILITY_ZONE --ssh-keys SSHKEY1,SSHKEY2,... --backupunit BACKUPUNIT_ID --user-data USER_DATA --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --firewall-type FIREWALL_TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/contract_list.md

@@ -19,11 +19,13 @@ knife ionoscloud contract list
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud contract list--username USERNAME --password PASSWORD
+knife ionoscloud contract list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/cube_server_create.md

@@ -0,0 +1,91 @@
+# CubeServerCreate
+
+This creates a new cube server with an attached volume and NIC in a specified virtual data center.
+
+```text
+knife ionoscloud cube server create (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* name
+* template
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the virtual datacenter (required)
+
+    name: --name NAME, -n NAME
+        (required) Name of the server (required)
+
+    template: --template TEMPLATE_UUID
+        the UUID of the template for creating a CUBE server; the available templates for CUBE servers can be found on the templates resource (required)
+
+    cpu_family: --cpu-family CPU_FAMILY, -f CPU_FAMILY
+        the family of processor cores (INTEL_XEON or AMD_OPTERON)
+
+    availability_zone: --availability-zone AVAILABILITY_ZONE, -a AVAILABILITY_ZONE
+        the availability zone of the server
+
+    volume_name: --volume-name NAME
+        name of the volume
+
+    bus: --bus BUS, -b BUS
+        the bus type of the volume (VIRTIO or IDE)
+
+    image: --image ID, -N ID
+        (required) The image or snapshot ID
+
+    licence_type: --licence-type LICENCE, -l LICENCE
+        the licence type of the volume (LINUX, WINDOWS, WINDOWS2016, UNKNOWN, OTHER)
+
+    image_password: --image-password PASSWORD, -P PASSWORD
+        the password set on the image for the "root" or "Administrator" user
+
+    ssh_keys: --ssh-keys SSHKEY1,SSHKEY2,..., -K SSHKEY[,SSHKEY,...]
+        a list of public SSH keys to include
+
+    backupunit_id: --backupunit BACKUPUNIT_ID, -B BACKUPUNIT_ID
+        the uuid of the Backup Unit that user has access to. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' in conjunction with this property.
+
+    user_data: --user-data USER_DATA, -u USER_DATA
+        the cloud-init configuration for the volume as base64 encoded string. The property is immutable and is only allowed to be set on a new volume creation. It is mandatory to provide either 'public image' or 'imageAlias' that has cloud-init compatibility in conjunction with this property.
+
+    set_boot: --set-boot
+        whether to set the volume as the boot volume
+
+    nic_name: --nic-name NAME
+        name of the NIC
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        iPs assigned to the NIC
+
+    dhcp: --dhcp, -h
+        set to false if you wish to disable DHCP
+
+    lan: --lan ID, -L ID
+        the LAN ID the NIC will reside on; if the LAN ID does not exist it will be created
+
+    firewall_type: --firewall-type FIREWALL_TYPE, -t FIREWALL_TYPE
+        the type of firewall rules that will be allowed on the NIC. If it is not specified it will take the default value INGRESS
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
+## Example
+
+```text
+knife ionoscloud cube server create --datacenter-id DATACENTER_ID --name NAME --template TEMPLATE_UUID --cpu-family CPU_FAMILY --availability-zone AVAILABILITY_ZONE --volume-name NAME --bus BUS --image ID --licence-type LICENCE --image-password PASSWORD --ssh-keys SSHKEY1,SSHKEY2,... --backupunit BACKUPUNIT_ID --user-data USER_DATA --set-boot --nic-name NAME --ips IP[,IP,...] --dhcp --lan ID --firewall-type FIREWALL_TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
+```

data/docs/subcommands/datacenter_create.md

@@ -2,12 +2,13 @@
 
 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.
 
-```text
+	```text
 knife ionoscloud location list
 ```
 
 Make a note of the desired location ID and now the data center can be created.
 
+
 ```text
 knife ionoscloud datacenter create (options)
 ```
@@ -35,11 +36,13 @@ knife ionoscloud datacenter create (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD
+knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/datacenter_delete.md

@@ -19,11 +19,13 @@ knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD
+knife ionoscloud datacenter delete DATACENTER_ID [DATACENTER_ID]--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/datacenter_list.md

@@ -19,11 +19,13 @@ knife ionoscloud datacenter list
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-knife ionoscloud datacenter list--username USERNAME --password PASSWORD
+knife ionoscloud datacenter list--username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/firewall_create.md

@@ -44,7 +44,7 @@ knife ionoscloud firewall create (options)
     port_range_start: --port-range-start PORT, -p PORT
         defines the start range of the allowed port(s)
 
-    port_range_end: --port-range-end PORT, -t PORT
+    port_range_end: --port-range-end PORT
         defines the end range of the allowed port(s)
 
     icmp_type: --icmp-type INT
@@ -53,16 +53,21 @@ knife ionoscloud firewall create (options)
     icmp_code: --icmp-code INT
         defines the allowed code (from 0 to 254) if the protocol ICMP is chosen; null allows all codes
 
+    type: --type TYPE, --t TYPE
+        the type of firewall rule. If is not specified, it will take the default value INGRESS
+
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
-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
+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 --type TYPE --username USERNAME --password PASSWORD --extra-config EXTRA_CONFIG_FILE_PATH
 ```
-

data/docs/subcommands/firewall_delete.md

@@ -31,11 +31,13 @@ knife ionoscloud firewall delete FIREWALL_ID [FIREWALL_ID] (options)
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-```
 
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+```
 ## Example
 
 ```text
 knife ionoscloud firewall delete FIREWALL_ID 
 ```
-