knife-ionoscloud 5.0.0.beta.1

data/docs/templates/subcommand_doc.mustache

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

data/docs/templates/summary.mustache

@@ -0,0 +1,10 @@
+# Table of contents
+
+* [Introduction](README.md)
+* [Changelog](changelog.md)
+
+## Subcommands
+
+{{#subcommands}}
+* [{{title}}]({{filename}})
+{{/subcommands}}

data/knife-ionoscloud.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knife-ionoscloud/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'knife-ionoscloud'
+  spec.version       = Knife::Ionoscloud::VERSION
+  spec.authors       = ['IONOS Cloud']
+  spec.email         = ['sdk@cloud.ionos.com']
+  spec.summary       = 'Chef Knife plugin for Ionoscloud platform'
+  spec.description   = 'Official Chef Knife plugin for Ionoscloud platform using REST API'
+  spec.homepage      = 'https://github.com/ionos-cloud/knife-ionos-cloud'
+  spec.license       = 'Apache-2.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'chef', '~> 16.10', '>= 16.10.17'
+  spec.add_runtime_dependency 'ionoscloud', '~> 5.0'
+
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'simplecov', '~> 0.21.2'
+end

data/lib/chef/knife/ionoscloud_backupunit_create.rb

@@ -0,0 +1,63 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudBackupunitCreate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud backupunit create (options)'
+
+      option :name,
+              short: '-n NAME',
+              long: '--name NAME',
+              description: 'Alphanumeric name you want assigned to the backup unit'
+
+      option :password,
+              short: '-p PASSWORD',
+              long: '--password PASSWORD',
+              description: 'Alphanumeric password you want assigned to the backup unit'
+
+      option :email,
+              short: '-e EMAIL',
+              long: '--email EMAIL',
+              description: 'The e-mail address you want assigned to the backup unit.'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Create a new backup unit.'
+        @required_options = [:name, :password, :email, :ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        validate_required_params(@required_options, config)
+
+        print "#{ui.color('Creating Backup unit...', :magenta)}"
+
+        backupunit_api = Ionoscloud::BackupUnitApi.new(api_client)
+
+        backupunit, _, headers  = backupunit_api.backupunits_post_with_http_info({
+          properties: {
+            name: config[:name],
+            password: config[:password],
+            email: config[:email],
+          }.compact,
+        })
+
+        dot = ui.color('.', :magenta)
+        api_client.wait_for { print dot; is_done? get_request_id headers }
+
+        puts backupunit
+
+        puts "\n"
+        puts "#{ui.color('ID', :cyan)}: #{backupunit.id}"
+        puts "#{ui.color('Name', :cyan)}: #{backupunit.properties.name}"
+        puts "#{ui.color('Email', :cyan)}: #{backupunit.properties.email}"
+        puts 'done'
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_backupunit_delete.rb

@@ -0,0 +1,55 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudBackupunitDelete < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'A backup unit may be deleted using a DELETE request. Deleting a backup unit '\
+        'is a dangerous operation. A successful DELETE request will remove the backup '\
+        'plans inside a backup unit, ALL backups associated with the backup unit, the '\
+        'backup user and finally the backup unit itself.'
+        @required_options = [:ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        validate_required_params(@required_options, config)
+
+        backupunit_api = Ionoscloud::BackupUnitApi.new(api_client)
+
+        @name_args.each do |backupunit_id|
+          begin
+            backupunit = backupunit_api.backupunits_find_by_id(backupunit_id)
+          rescue Ionoscloud::ApiError => err
+            raise err unless err.code == 404
+            ui.error("Backup unit ID #{backupunit_id} not found. Skipping.")
+            next
+          end
+
+          msg_pair('ID', backupunit.id)
+          msg_pair('Name', backupunit.properties.name)
+          msg_pair('Email', backupunit.properties.email)
+
+          puts "\n"
+
+          begin
+            confirm('Do you really want to delete this Backup unit')
+          rescue SystemExit => exc
+            next
+          end
+
+          _, _, headers = backupunit_api.backupunits_delete_with_http_info(backupunit_id)
+          ui.warn("Deleted Backup unit #{backupunit.id}. Request ID: #{get_request_id headers}")
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_backupunit_list.rb

@@ -0,0 +1,41 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudBackupunitList < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud backupunit list'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'Retrieve a list of all the backup units the supplied credentials have access to.'
+        @required_options = [:ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        validate_required_params(@required_options, config)
+
+        backupunit_list = [
+          ui.color('ID', :bold),
+          ui.color('Name', :bold),
+          ui.color('Email', :bold),
+        ]
+
+        backupunit_api = Ionoscloud::BackupUnitApi.new(api_client)
+
+        backupunit_api.backupunits_get({ depth: 1 }).items.each do |backupunit|
+          backupunit_list << backupunit.id
+          backupunit_list << backupunit.properties.name
+          backupunit_list << backupunit.properties.email
+        end
+
+        puts ui.list(backupunit_list, :uneven_columns_across, 3)
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_backupunit_ssourl.rb

@@ -0,0 +1,39 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudBackupunitSsourl < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud backupunit ssourl (options)'
+
+      option :backupunit_id,
+              short: '-B BACKUPUNIT_ID',
+              long: '--backupunit-id BACKUPUNIT_ID',
+              description: 'The ID of the Backup unit.'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        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 '\
+        'retrieved from the Cloud API using this request.'
+        @required_options = [:backupunit_id, :ionoscloud_username, :ionoscloud_password]
+      end
+
+      def run
+        $stdout.sync = true
+        validate_required_params(@required_options, config)
+
+        begin
+          puts Ionoscloud::BackupUnitApi.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.")
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/ionoscloud_base.rb

@@ -0,0 +1,76 @@
+require 'chef/knife'
+
+class Chef
+  class Knife
+    module IonoscloudBase
+      def self.included(includer)
+        includer.class_eval do
+          deps do
+            require 'ionoscloud'
+          end
+
+          option :ionoscloud_username,
+                  short: '-u USERNAME',
+                  long: '--username USERNAME',
+                  description: 'Your Ionoscloud username'
+
+          option :ionoscloud_password,
+                  short: '-p PASSWORD',
+                  long: '--password PASSWORD',
+                  description: 'Your Ionoscloud password'
+        end
+      end
+
+      def msg_pair(label, value, color = :cyan)
+        if !value.nil? && !value.to_s.empty?
+          puts "#{ui.color(label, color)}: #{value}"
+        end
+      end
+
+      def validate_required_params(required_params, params)
+        missing_params = required_params.select do |param|
+          params[param].nil?
+        end
+        if missing_params.any?
+          puts "Missing required parameters #{missing_params}"
+          exit(1)
+        end
+      end
+
+      def api_client
+        api_config = Ionoscloud::Configuration.new()
+
+        api_config.username = config[:ionoscloud_username]
+        api_config.password = config[:ionoscloud_password]
+
+        api_config.debugging = config[:ionoscloud_debug] || false
+
+        @api_client ||= Ionoscloud::ApiClient.new(api_config)
+      end
+
+      def get_request_id(headers)
+        begin
+          headers['Location'].scan(%r{/requests/(\b[0-9a-f]{8}\b-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-\b[0-9a-f]{12}\b)}).last.first
+        rescue NoMethodError
+          nil
+        end
+      end
+
+      def is_done?(request_id)
+        response = Ionoscloud::RequestApi.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)
+        end
+        response.metadata.status == 'DONE'
+      end
+    end
+  end
+end
+
+# compact method will remove nil values from Hash
+class Hash
+  def compact
+    delete_if { |_k, v| v.nil? }
+  end
+end

data/lib/chef/knife/ionoscloud_composite_server_create.rb

@@ -0,0 +1,217 @@
+require_relative 'ionoscloud_base'
+
+class Chef
+  class Knife
+    class IonoscloudCompositeServerCreate < Knife
+      include Knife::IonoscloudBase
+
+      banner 'knife ionoscloud composite 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 :cores,
+              short: '-C CORES',
+              long: '--cores CORES',
+              description: '(required) The number of processor cores'
+
+      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 :ram,
+              short: '-r RAM',
+              long: '--ram RAM',
+              description: '(required) The amount of RAM in MB'
+
+      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 :size,
+              short: '-S SIZE',
+              long: '--size SIZE',
+              description: '(required) The size of the volume in GB'
+
+      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 :image_alias,
+              long: '--image-alias IMAGE_ALIAS',
+              description: '(required) The image alias'
+
+      option :type,
+              short: '-t TYPE',
+              long: '--type TYPE',
+              description: '(required) The disk type (HDD or SSD)'
+
+      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 :volume_availability_zone,
+              short: '-Z AVAILABILITY_ZONE',
+              long: '--volume-availability-zone AVAILABILITY_ZONE',
+              description: 'The volume availability zone of the server'
+
+      option :ssh_keys,
+              short: '-K SSHKEY[,SSHKEY,...]',
+              long: '--ssh-keys SSHKEY1,SSHKEY2,...',
+              description: 'A list of public SSH keys to include'
+
+      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 :nat,
+              long: '--nat',
+              description: 'Set to enable NAT on the NIC'
+
+      attr_reader :description, :required_options
+
+      def initialize(args = [])
+        super(args)
+        @description =
+        'This creates a new composite server with an attached volume and NIC in a specified virtual data center.'
+        @required_options = [
+          :datacenter_id, :name, :cores, :ram, :size, :type, :dhcp, :lan, :ionoscloud_username, :ionoscloud_password,
+        ]
+      end
+
+      def run
+        $stdout.sync = true
+        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
+
+        print ui.color('Creating composite server...', :magenta).to_s
+
+        volume = Ionoscloud::Volume.new(
+          properties: Ionoscloud::VolumeProperties.new({
+            name: config[:volume_name],
+            size: config[:size],
+            bus: config[:bus] || 'VIRTIO',
+            image: config[:image],
+            image_alias: config[:image_alias],
+            ssh_keys: config[:ssh_keys],
+            image_password: config[:image_password],
+            type: config[:type],
+            licence_type: config[:licence_type],
+            availability_zone: config[:volume_availability_zone],
+          }.compact)
+        )
+
+        nic = Ionoscloud::Nic.new(
+          properties: Ionoscloud::NicProperties.new({
+            name: config[:nic_name],
+            ips: config[:ips],
+            dhcp: config[:dhcp],
+            lan: config[:lan],
+            nat: !config[:nat].nil?,
+          }.compact)
+        )
+
+
+        server = Ionoscloud::Server.new(
+          properties: Ionoscloud::ServerProperties.new({
+            name: config[:name],
+            cores: config[:cores],
+            cpu_family: config[:cpu_family],
+            ram: config[:ram],
+            availability_zone: config[:availability_zone],
+          }.compact),
+          entities: Ionoscloud::ServerEntities.new(
+            volumes: {
+               items: [volume],
+            },
+            nics: {
+              items: [nic],
+            },
+          ),
+        )
+
+        server_api = Ionoscloud::ServerApi.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)
+
+        puts "\n"
+        puts "#{ui.color('ID', :cyan)}: #{server.id}"
+        puts "#{ui.color('Name', :cyan)}: #{server.properties.name}"
+        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