knife-ionoscloud 5.0.0 → 6.0.0.beta.1

data/docs/templates/subcommand_doc.mustache

@@ -1,26 +1,28 @@
 # {{name}}
 
-{{description}}
-
-    {{banner}}
+{{{description}}}
 
+```text
+{{banner}}
+```
 
 ## Available options:
----
 
 ### Required options:
+
 {{#required_options}}
 * {{.}}
 {{/required_options}}
 
-```
+```text
 {{#options}}
     {{name}}: {{long}}{{#short}}, {{short}}{{/short}}
         {{{description}}}{{#required}} (required){{/required}}
 
 {{/options}}
 ```
-
 ## Example
 
-    {{example}}
+```text
+{{example}}
+```

data/knife-ionoscloud.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'chef', '~> 16.10', '>= 16.10.17'
-  spec.add_runtime_dependency 'ionoscloud', '~> 5.0'
+  spec.add_runtime_dependency 'ionoscloud', '~> 6.0.0.beta.3'
 
   spec.add_development_dependency 'rspec', '~> 3.10'
   spec.add_development_dependency 'simplecov', '~> 0.21.2'

data/lib/chef/knife/ionoscloud_backupunit_create.rb

@@ -33,11 +33,12 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         print "#{ui.color('Creating Backup unit...', :magenta)}"
 
-        backupunit_api = Ionoscloud::BackupUnitApi.new(api_client)
+        backupunit_api = Ionoscloud::BackupUnitsApi.new(api_client)
 
         backupunit, _, headers  = backupunit_api.backupunits_post_with_http_info({
           properties: {

data/lib/chef/knife/ionoscloud_backupunit_delete.rb

@@ -21,9 +21,10 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
-        backupunit_api = Ionoscloud::BackupUnitApi.new(api_client)
+        backupunit_api = Ionoscloud::BackupUnitsApi.new(api_client)
 
         @name_args.each do |backupunit_id|
           begin

data/lib/chef/knife/ionoscloud_backupunit_list.rb

@@ -18,6 +18,7 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         backupunit_list = [
@@ -26,7 +27,7 @@ class Chef
           ui.color('Email', :bold),
         ]
 
-        backupunit_api = Ionoscloud::BackupUnitApi.new(api_client)
+        backupunit_api = Ionoscloud::BackupUnitsApi.new(api_client)
 
         backupunit_api.backupunits_get({ depth: 1 }).items.each do |backupunit|
           backupunit_list << backupunit.id

data/lib/chef/knife/ionoscloud_backupunit_ssourl.rb

@@ -18,17 +18,18 @@ class Chef
         super(args)
         @description =
         'The ProfitBricks backup system features a web-based GUI. Once you have created '\
-        'a backup unit, you can access the GUI with a Single Sign On (SSO) URL that can be '\
+        'a backup unit, you can access the GUI with a Single Sign On \(SSO\) URL that can be '\
         'retrieved from the Cloud API using this request.'
         @required_options = [:backupunit_id, :ionoscloud_username, :ionoscloud_password]
       end
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
         begin
-          puts Ionoscloud::BackupUnitApi.new(api_client).backupunits_ssourl_get(config[:backupunit_id]).sso_url
+          puts Ionoscloud::BackupUnitsApi.new(api_client).backupunits_ssourl_get(config[:backupunit_id]).sso_url
         rescue Ionoscloud::ApiError => err
           raise err unless err.code == 404
           ui.error("Backup unit ID #{config[:backupunit_id]} not found.")

data/lib/chef/knife/ionoscloud_base.rb

@@ -18,6 +18,11 @@ class Chef
                   short: '-p PASSWORD',
                   long: '--password PASSWORD',
                   description: 'Your Ionoscloud password'
+
+          option :extra_config_file,
+                  short: '-e EXTRA_CONFIG_FILE_PATH',
+                  long: '--extra-config EXTRA_CONFIG_FILE_PATH',
+                  description: 'Path to the additional config file'
         end
       end
 
@@ -37,6 +42,24 @@ class Chef
         end
       end
 
+      def handle_extra_config
+        return if config[:extra_config_file].nil?
+
+        available_options = options.map { |key, _| key }
+        ionoscloud_options = available_options[available_options.find_index(:ionoscloud_username)..]
+        ignored_options = []
+
+        JSON[File.read(config[:extra_config_file])].transform_keys(&:to_sym).each do |key, value|
+          if config.key?(key) || !ionoscloud_options.include?(key)
+            ignored_options << key
+          else
+            config[key] = value 
+          end
+        end
+
+        ui.warn "The following options #{ignored_options} from the specified JSON file will be ignored." unless ignored_options.empty?
+      end
+
       def api_client
         api_config = Ionoscloud::Configuration.new()
 
@@ -57,7 +80,7 @@ class Chef
       end
 
       def is_done?(request_id)
-        response = Ionoscloud::RequestApi.new(api_client).requests_status_get(request_id)
+        response = Ionoscloud::RequestsApi.new(api_client).requests_status_get(request_id)
         if response.metadata.status == 'FAILED'
           puts "\nRequest #{request_id} failed\n#{response.metadata.message.to_s}"
           exit(1)

data/lib/chef/knife/ionoscloud_composite_server_create.rb

@@ -87,6 +87,20 @@ class Chef
               long: '--ssh-keys SSHKEY1,SSHKEY2,...',
               description: 'A list of public SSH keys to include'
 
+      option :backupunit_id,
+              short: '-B BACKUPUNIT_ID',
+              long: '--backupunit BACKUPUNIT_ID',
+              description: '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.'
+
+      option :user_data,
+              short: '-u USER_DATA',
+              long: '--user-data USER_DATA',
+              description: '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.'
+
       option :nic_name,
               long: '--nic-name NAME',
               description: 'Name of the NIC'
@@ -108,9 +122,11 @@ class Chef
               long: '--lan ID',
               description: 'The LAN ID the NIC will reside on; if the LAN ID does not exist it will be created'
 
-      option :nat,
-              long: '--nat',
-              description: 'Set to enable NAT on the NIC'
+      option :firewall_type,
+              long: '--firewall-type FIREWALL_TYPE',
+              description: 'The type of firewall rules that will be allowed on the NIC. If it is not specified it will take the '\
+              'default value INGRESS',
+              default: 'INGRESS'
 
       attr_reader :description, :required_options
 
@@ -125,25 +141,11 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
-        if !config[:image] && !config[:image_alias]
-          ui.error('Either \'--image\' or \'--image-alias\' parameter must be provided')
-          exit(1)
-        end
-
-        if !config[:ssh_keys] && !config[:image_password]
-          ui.error('Either \'--image-password\' or \'--ssh-keys\' parameter must be provided')
-          exit(1)
-        end
-
-        if config[:ssh_keys]
-          config[:ssh_keys] = config[:ssh_keys].split(',')
-        end
-
-        if config[:ips]
-          config[:ips] = config[:ips].split(',')
-        end
+        config[:ssh_keys] = config[:ssh_keys].split(',') if config[:ssh_keys] && config[:ssh_keys].instance_of?(String)
+        config[:ips] = config[:ips].split(',') if config[:ips] && config[:ips].instance_of?(String)
 
         print ui.color('Creating composite server...', :magenta).to_s
 
@@ -159,6 +161,8 @@ class Chef
             type: config[:type],
             licence_type: config[:licence_type],
             availability_zone: config[:volume_availability_zone],
+            backupunit_id: config[:backupunit_id],
+            user_data: config[:user_data],
           }.compact)
         )
 
@@ -168,11 +172,10 @@ class Chef
             ips: config[:ips],
             dhcp: config[:dhcp],
             lan: config[:lan],
-            nat: !config[:nat].nil?,
+            firewall_type: config[:firewall_type],
           }.compact)
         )
 
-
         server = Ionoscloud::Server.new(
           properties: Ionoscloud::ServerProperties.new({
             name: config[:name],
@@ -191,7 +194,7 @@ class Chef
           ),
         )
 
-        server_api = Ionoscloud::ServerApi.new(api_client)
+        server_api = Ionoscloud::ServersApi.new(api_client)
 
         server, _, headers = server_api.datacenters_servers_post_with_http_info(config[:datacenter_id], server)
 

data/lib/chef/knife/ionoscloud_contract_list.rb

@@ -18,32 +18,42 @@ class Chef
 
       def run
         $stdout.sync = true
+        handle_extra_config
         validate_required_params(@required_options, config)
 
-        contract = Ionoscloud::ContractApi.new(api_client).contracts_get()
+        contracts = Ionoscloud::ContractResourcesApi.new(api_client).contracts_get()
 
-        puts "#{ui.color('Contract Type', :cyan)}: #{contract.type}"
-        puts "#{ui.color('Contract Owner', :cyan)}: #{contract.properties.owner}"
-        puts "#{ui.color('Contract Number', :cyan)}: #{contract.properties.contract_number}"
-        puts "#{ui.color('Registration Domain', :cyan)}: #{contract.properties.reg_domain}"
-        puts "#{ui.color('Status', :cyan)}: #{contract.properties.status}"
-        puts "#{ui.color('Cores per contract', :cyan)}: #{contract.properties.resource_limits.cores_per_contract}"
-        puts "#{ui.color('Cores per server', :cyan)}: #{contract.properties.resource_limits.cores_per_server}"
-        puts "#{ui.color('Cores provisioned', :cyan)}: #{contract.properties.resource_limits.cores_provisioned}"
-        puts "#{ui.color('HDD limit per contract', :cyan)}: #{contract.properties.resource_limits.hdd_limit_per_contract}"
-        puts "#{ui.color('HDD limit per volume', :cyan)}: #{contract.properties.resource_limits.hdd_limit_per_volume}"
-        puts "#{ui.color('HDD volume provisioned', :cyan)}: #{contract.properties.resource_limits.hdd_volume_provisioned}"
-        puts "#{ui.color('RAM per contract', :cyan)}: #{contract.properties.resource_limits.ram_per_contract}"
-        puts "#{ui.color('RAM per server', :cyan)}: #{contract.properties.resource_limits.ram_per_server}"
-        puts "#{ui.color('RAM provisioned', :cyan)}: #{contract.properties.resource_limits.ram_provisioned}"
-        puts "#{ui.color('Reservable IPs', :cyan)}: #{contract.properties.resource_limits.reservable_ips}"
-        puts "#{ui.color('Reservable IPs in use', :cyan)}: #{contract.properties.resource_limits.reserved_ips_in_use}"
-        puts "#{ui.color('Reservable IPs on contract', :cyan)}: #{contract.properties.resource_limits.reserved_ips_on_contract}"
-        puts "#{ui.color('SSD limit per contract', :cyan)}: #{contract.properties.resource_limits.ssd_limit_per_contract}"
-        puts "#{ui.color('SSD limit per volume', :cyan)}: #{contract.properties.resource_limits.ssd_limit_per_volume}"
-        puts "#{ui.color('SSD volume provisioned', :cyan)}: #{contract.properties.resource_limits.ssd_volume_provisioned}"
-        puts "#{ui.color('K8s Cluster Limit Total', :cyan)}: #{contract.properties.resource_limits.k8s_cluster_limit_total}"
-        puts "#{ui.color('K8s Clusters provisioned', :cyan)}: #{contract.properties.resource_limits.k8s_clusters_provisioned}"
+        contracts.items.each do
+          |contract|
+          puts "#{ui.color('Contract Type', :cyan)}: #{contract.type}"
+          puts "#{ui.color('Contract Owner', :cyan)}: #{contract.properties.owner}"
+          puts "#{ui.color('Contract Number', :cyan)}: #{contract.properties.contract_number}"
+          puts "#{ui.color('Registration Domain', :cyan)}: #{contract.properties.reg_domain}"
+          puts "#{ui.color('Status', :cyan)}: #{contract.properties.status}"
+          puts "#{ui.color('Cores per contract', :cyan)}: #{contract.properties.resource_limits.cores_per_contract}"
+          puts "#{ui.color('Cores per server', :cyan)}: #{contract.properties.resource_limits.cores_per_server}"
+          puts "#{ui.color('Cores provisioned', :cyan)}: #{contract.properties.resource_limits.cores_provisioned}"
+          puts "#{ui.color('HDD limit per contract', :cyan)}: #{contract.properties.resource_limits.hdd_limit_per_contract}"
+          puts "#{ui.color('HDD limit per volume', :cyan)}: #{contract.properties.resource_limits.hdd_limit_per_volume}"
+          puts "#{ui.color('HDD volume provisioned', :cyan)}: #{contract.properties.resource_limits.hdd_volume_provisioned}"
+          puts "#{ui.color('RAM per contract', :cyan)}: #{contract.properties.resource_limits.ram_per_contract}"
+          puts "#{ui.color('RAM per server', :cyan)}: #{contract.properties.resource_limits.ram_per_server}"
+          puts "#{ui.color('RAM provisioned', :cyan)}: #{contract.properties.resource_limits.ram_provisioned}"
+          puts "#{ui.color('Reservable IPs', :cyan)}: #{contract.properties.resource_limits.reservable_ips}"
+          puts "#{ui.color('Reservable IPs in use', :cyan)}: #{contract.properties.resource_limits.reserved_ips_in_use}"
+          puts "#{ui.color('Reservable IPs on contract', :cyan)}: #{contract.properties.resource_limits.reserved_ips_on_contract}"
+          puts "#{ui.color('SSD limit per contract', :cyan)}: #{contract.properties.resource_limits.ssd_limit_per_contract}"
+          puts "#{ui.color('SSD limit per volume', :cyan)}: #{contract.properties.resource_limits.ssd_limit_per_volume}"
+          puts "#{ui.color('SSD volume provisioned', :cyan)}: #{contract.properties.resource_limits.ssd_volume_provisioned}"
+          puts "#{ui.color('DAS volume provisioned', :cyan)}: #{contract.properties.resource_limits.das_volume_provisioned}"
+          puts "#{ui.color('K8s Cluster Limit Total', :cyan)}: #{contract.properties.resource_limits.k8s_cluster_limit_total}"
+          puts "#{ui.color('K8s Clusters provisioned', :cyan)}: #{contract.properties.resource_limits.k8s_clusters_provisioned}"
+          puts "#{ui.color('NLB total limit', :cyan)}: #{contract.properties.resource_limits.nlb_limit_total}"
+          puts "#{ui.color('NLBs provisioned', :cyan)}: #{contract.properties.resource_limits.nlb_provisioned}"
+          puts "#{ui.color('NAT gateway total limit', :cyan)}: #{contract.properties.resource_limits.nat_gateway_limit_total}"
+          puts "#{ui.color('NAT gateways provisioned', :cyan)}: #{contract.properties.resource_limits.nat_gateway_provisioned}"
+          puts "\n"
+        end
       end
     end
   end

data/lib/chef/knife/ionoscloud_cube_server_create.rb

@@ -0,0 +1,216 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudCubeServerCreate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud cube server create (options)'
+
+      option :datacenter_id,
+              short: '-D DATACENTER_ID',
+              long: '--datacenter-id DATACENTER_ID',
+              description: 'Name of the virtual datacenter'
+
+      option :name,
+              short: '-n NAME',
+              long: '--name NAME',
+              description: '(required) Name of the server'
+
+      option :template,
+              long: '--template TEMPLATE_UUID',
+              description: 'The UUID of the template for creating a CUBE server; the available templates for CUBE servers can be found on the templates resource'
+
+      option :cpu_family,
+              short: '-f CPU_FAMILY',
+              long: '--cpu-family CPU_FAMILY',
+              description: 'The family of processor cores (INTEL_XEON or AMD_OPTERON)',
+              default: 'INTEL_SKYLAKE'
+
+      option :availability_zone,
+              short: '-a AVAILABILITY_ZONE',
+              long: '--availability-zone AVAILABILITY_ZONE',
+              description: 'The availability zone of the server',
+              default: 'AUTO'
+
+      option :volume_name,
+              long: '--volume-name NAME',
+              description: 'Name of the volume'
+
+      option :bus,
+              short: '-b BUS',
+              long: '--bus BUS',
+              description: 'The bus type of the volume (VIRTIO or IDE)'
+
+      option :image,
+              short: '-N ID',
+              long: '--image ID',
+              description: '(required) The image or snapshot ID'
+
+      option :licence_type,
+              short: '-l LICENCE',
+              long: '--licence-type LICENCE',
+              description: 'The licence type of the volume (LINUX, WINDOWS, WINDOWS2016, UNKNOWN, OTHER)'
+
+      option :image_password,
+              short: '-P PASSWORD',
+              long: '--image-password PASSWORD',
+              description: 'The password set on the image for the "root" or "Administrator" user'
+
+      option :ssh_keys,
+              short: '-K SSHKEY[,SSHKEY,...]',
+              long: '--ssh-keys SSHKEY1,SSHKEY2,...',
+              description: 'A list of public SSH keys to include'
+
+      option :backupunit_id,
+              short: '-B BACKUPUNIT_ID',
+              long: '--backupunit BACKUPUNIT_ID',
+              description: '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.'
+
+      option :user_data,
+              short: '-u USER_DATA',
+              long: '--user-data USER_DATA',
+              description: '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.'
+
+      option :set_boot,
+              long: '--set-boot',
+              description: 'Whether to set the volume as the boot volume'
+
+      option :nic_name,
+              long: '--nic-name NAME',
+              description: 'Name of the NIC'
+
+      option :ips,
+              short: '-i IP[,IP,...]',
+              long: '--ips IP[,IP,...]',
+              description: 'IPs assigned to the NIC'
+
+      option :dhcp,
+              short: '-h',
+              long: '--dhcp',
+              boolean: true | false,
+              default: true,
+              description: 'Set to false if you wish to disable DHCP'
+
+      option :lan,
+              short: '-L ID',
+              long: '--lan ID',
+              description: 'The LAN ID the NIC will reside on; if the LAN ID does not exist it will be created'
+
+      option :firewall_type,
+              short: '-t FIREWALL_TYPE',
+              long: '--firewall-type FIREWALL_TYPE',
+              description: 'The type of firewall rules that will be allowed on the NIC. If it is not specified it will take the '\
+              'default value INGRESS',
+              default: 'INGRESS'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'This creates a new cube server with an attached volume and NIC in a specified virtual data center.'
+        @required_options = [
+          :datacenter_id, :name, :template, :ionoscloud_username, :ionoscloud_password,
+        ]
+      end
+
+      def run
+        $stdout.sync = true
+        handle_extra_config
+        validate_required_params(@required_options, config)
+
+        config[:ssh_keys] = config[:ssh_keys].split(',') if config[:ssh_keys] && config[:ssh_keys].instance_of?(String)
+        config[:ips] = config[:ips].split(',') if config[:ips] && config[:ips].instance_of?(String)
+
+        print ui.color('Creating cube server...', :magenta).to_s
+
+        volumes = [Ionoscloud::Volume.new(
+          properties: Ionoscloud::VolumeProperties.new({
+            name: config[:volume_name],
+            bus: config[:bus] || 'VIRTIO',
+            image: config[:image],
+            ssh_keys: config[:ssh_keys],
+            image_password: config[:image_password],
+            type: 'DAS',
+            licence_type: config[:licence_type],
+            backupunit_id: config[:backupunit_id],
+            user_data: config[:user_data],
+          }.compact)
+        )]
+
+        nics = []
+
+        if config[:nic_name] || config[:ips] || config[:dhcp] || config[:lan]
+          nics = [
+            Ionoscloud::Nic.new(
+              properties: Ionoscloud::NicProperties.new({
+                name: config[:nic_name],
+                ips: config[:ips],
+                dhcp: config[:dhcp],
+                lan: config[:lan],
+                firewall_type: config[:firewall_type],
+              }.compact)
+            )
+          ]
+        end
+
+        server = Ionoscloud::Server.new(
+          properties: Ionoscloud::ServerProperties.new({
+            name: config[:name],
+            type: 'CUBE',
+            template_uuid: config[:template],
+            cpu_family: config[:cpu_family],
+            ram: config[:ram],
+            availability_zone: config[:availability_zone],
+          }.compact),
+          entities: Ionoscloud::ServerEntities.new(
+            volumes: {
+               items: volumes,
+            },
+            nics: {
+              items: nics,
+            },
+          ),
+        )
+
+        server_api = Ionoscloud::ServersApi.new(api_client)
+
+        server, _, headers = server_api.datacenters_servers_post_with_http_info(config[:datacenter_id], server)
+
+        dot = ui.color('.', :magenta)
+        api_client.wait_for { print dot; is_done? get_request_id headers }
+
+        server = server_api.datacenters_servers_find_by_id(config[:datacenter_id], server.id, depth: 1)
+
+        if config[:set_boot]
+          changes = Ionoscloud::ServerProperties.new(boot_volume: { id: server.entities.volumes.items[0].id })
+          _, _, headers = server_api.datacenters_servers_patch_with_http_info(
+            config[:datacenter_id], server.id, changes,
+          )
+
+          api_client.wait_for { is_done? get_request_id headers }
+
+          server = server_api.datacenters_servers_find_by_id(config[:datacenter_id], server.id, depth: 1)
+        end
+
+        puts "\n"
+        puts "#{ui.color('ID', :cyan)}: #{server.id}"
+        puts "#{ui.color('Name', :cyan)}: #{server.properties.name}"
+        puts "#{ui.color('Type', :cyan)}: #{server.properties.type}"
+        puts "#{ui.color('Cores', :cyan)}: #{server.properties.cores}"
+        puts "#{ui.color('CPU Family', :cyan)}: #{server.properties.cpu_family}"
+        puts "#{ui.color('Ram', :cyan)}: #{server.properties.ram}"
+        puts "#{ui.color('Availability Zone', :cyan)}: #{server.properties.availability_zone}"
+        puts "#{ui.color('Boot Volume', :cyan)}: #{server.properties.boot_volume ? server.properties.boot_volume.id : ''}"
+        puts "#{ui.color('Boot CDROM', :cyan)}: #{server.properties.boot_cdrom ? server.properties.boot_cdrom.id : ''}"
+
+        puts 'done'
+      end
+    end
+  end
+end