knife-ionoscloud 5.0.0.beta.1

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec

data/docs/README.md

@@ -0,0 +1,67 @@
+# Ionoscloud Chef Knife Plugin
+
+![CI](https://github.com/ionos-cloud/knife-ionos-cloud/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/knife-ionoscloud.svg)](https://badge.fury.io/rb/knife-ionoscloud)
+[![Gitter](https://badges.gitter.im/ionos-cloud/sdk-general.png)](https://gitter.im/ionos-cloud/sdk-general)
+
+## Overview
+
+Chef is a popular configuration management tool that allows simplified configuration and maintenance of both servers and cloud provider environments through the use of common templates called recipes. The Chef `knife` command line tool allows management of various nodes within those environments. The `knife-ionoscloud` plugin utilizes the Ionoscloud REST API to provision and manage various cloud resources on the Ionoscloud platform.
+
+## Getting Started
+
+Before you begin you will need to have [signed-up](https://www.ionos.com/enterprise-cloud/signup) for a Ionoscloud account. The credentials you establish during sign-up will be used to authenticate against the [Ionoscloud Cloud API](https://devops.ionos.com/api/).
+
+### Installation
+
+The `knife-ionoscloud` plugin can be installed as a gem:
+
+    $ gem install knife-ionoscloud
+
+Or the plugin can be installed by adding the following line to your application's Gemfile:
+
+    gem 'knife-ionoscloud'
+
+And then execute:
+
+    $ bundle
+
+### Configuration
+
+The Ionoscloud account credentials can be added to the `knife.rb` configuration file.
+
+    knife[:ionoscloud_username] = 'username'
+    knife[:ionoscloud_password] = 'password'
+
+If a virtual data center has already been created under the Ionoscloud account, then the data center UUID can be added to the `knife.rb` which reduces the need to include the `--datacenter-id [datacenter_id]` parameter for each action within the data center.
+
+    knife[:datacenter_id] = 'f3f3b6fe-017d-43a3-b42a-a759144b2e99'
+
+    knife[:ionoscloud_debug] = true
+
+The configuration parameters can also be passed using shell environment variables. First, the following should be added to the `knife.rb` configuration file:
+
+    knife[:ionoscloud_username] = ENV['IONOSCLOUD_USERNAME']
+    knife[:ionoscloud_password] = ENV['IONOSCLOUD_PASSWORD']
+
+Now the parameters can be set as environment variables:
+
+    $ export IONOSCLOUD_USERNAME='username'
+    $ export IONOSCLOUD_PASSWORD='password'
+
+### Testing
+
+    $ rspec spec
+
+## 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:
+
+* authentication for API calls
+* handling of asynchronous requests 
+
+## FAQ
+
+1. How can I open a bug/feature request?
+
+Bugs & feature requests can be open on the repository issues: [https://github.com/ionos-cloud/knife-ionos-cloud/issues/new/choose](https://github.com/ionos-cloud/knife-ionos-cloud/issues/new/choose)

data/docs/changelog.md

@@ -0,0 +1 @@
+# CHANGELOG

data/docs/docs_generator.rb

@@ -0,0 +1,107 @@
+#!/usr/bin/env ruby
+
+# This must be run from /docs directory
+
+require 'mustache'
+
+$LOAD_PATH << '.'
+
+Dir["../lib/chef/knife/*.rb"].each { |file| require file }
+
+def underscore_string(s)
+  s.gsub(/::/, '/').
+  gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+  gsub(/([a-z\d])([A-Z])/, '\1_\2').
+  tr("-", "_").
+  downcase
+end
+
+class Subcommand < Mustache
+  self.template_path = './templates'
+  self.template_file = './templates/subcommand_doc.mustache'
+
+  attr_accessor :banner, :options, :example, :description, :name, :required_options
+
+  def initialize(banner, options, description, name, required_options)
+    @banner = banner
+    @options = options || []
+    @example = banner.chomp('(options)').gsub!(/\[.*\] /, '') || banner.chomp('(options)') + (options.map { |el| el[:long] }).join(' ')
+    @description = description
+    @name = name
+    @required_options = required_options || []
+  end
+end
+
+class Summary < Mustache
+  self.template_path = './templates'
+  self.template_file = './templates/summary.mustache'
+
+  attr_accessor :subcommands
+
+  def initialize(subcommands)
+    @subcommands = subcommands || []
+  end
+end
+
+def generate_subcommand_doc(subcommand)
+  options = subcommand.options.map { |key, value|
+    value[:name] = key
+    value[:required] = subcommand.required_options.include? key
+    value[:description][0] = value[:description][0].downcase
+    value
+  }.rotate(2)
+
+  subcommand_name = subcommand.class.to_s
+  subcommand_name.slice!('Chef::Knife::Ionoscloud')
+
+  filename = "subcommands/#{underscore_string(subcommand_name)}.md"
+
+  begin
+    description = subcommand.description
+  rescue NoMethodError
+    description = ''
+  end
+
+  File.open(filename, 'w') { |f|
+    f.write(
+      Subcommand.new(
+        subcommand.banner,
+        options,
+        description,
+        subcommand_name,
+        subcommand.required_options,
+      ).render,
+    )
+  }
+
+  puts "Generated documentation for #{subcommand_name}."
+  return subcommand_name, filename
+end
+
+subcommands = []
+
+begin
+  Chef::Knife.constants.select { |c|
+    Chef::Knife.const_get(c).is_a?(Class) && c.to_s.start_with?('Ionoscloud')
+  }.each {
+    |subcommand|
+    begin
+      subcommand_name, filename = generate_subcommand_doc(Chef::Knife.const_get(subcommand).new)
+      subcommands.append({ title: subcommand_name, filename: filename })
+    rescue Exception => exc
+      puts "Could not generate doc for #{subcommand}. Error: #{exc}"
+      # raise exc
+    end
+  }
+rescue NameError => exc
+  if exc.message == 'uninitialized constant Chef'
+    puts 'This must be run from /docs directory!'
+  end
+  raise exc
+end
+
+subcommands.sort! { |a, b| a[:title] <=> b[:title] }
+
+File.open('summary.md', 'w') { |f|
+  f.write(Summary.new(subcommands).render,)
+}

data/docs/subcommands/backupunit_create.md

@@ -0,0 +1,38 @@
+# BackupunitCreate
+
+Create a new backup unit.
+
+    knife ionoscloud backupunit create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* name
+* password
+* email
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    name: --name NAME, -n NAME
+        alphanumeric name you want assigned to the backup unit (required)
+
+    password: --password PASSWORD, -p PASSWORD
+        alphanumeric password you want assigned to the backup unit (required)
+
+    email: --email EMAIL, -e EMAIL
+        the e-mail address you want assigned to the backup unit. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud backupunit create --name NAME --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD

data/docs/subcommands/backupunit_delete.md

@@ -0,0 +1,26 @@
+# BackupunitDelete
+
+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.
+
+    knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]--username USERNAME --password PASSWORD

data/docs/subcommands/backupunit_list.md

@@ -0,0 +1,26 @@
+# BackupunitList
+
+Retrieve a list of all the backup units the supplied credentials have access to.
+
+    knife ionoscloud backupunit list
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud backupunit list--username USERNAME --password PASSWORD

data/docs/subcommands/backupunit_ssourl.md

@@ -0,0 +1,30 @@
+# BackupunitSsourl
+
+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.
+
+    knife ionoscloud backupunit ssourl (options)
+
+
+## Available options:
+---
+
+### Required options:
+* backupunit_id
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    backupunit_id: --backupunit-id BACKUPUNIT_ID, -B BACKUPUNIT_ID
+        the ID of the Backup unit. (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud backupunit ssourl --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD

data/docs/subcommands/composite_server_create.md

@@ -0,0 +1,97 @@
+# CompositeServerCreate
+
+This creates a new composite server with an attached volume and NIC in a specified virtual data center.
+
+    knife ionoscloud composite server create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* datacenter_id
+* name
+* cores
+* ram
+* size
+* type
+* dhcp
+* lan
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    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)
+
+    cores: --cores CORES, -C CORES
+        (required) The number of processor cores (required)
+
+    cpu_family: --cpu-family CPU_FAMILY, -f CPU_FAMILY
+        the family of processor cores (INTEL_XEON or AMD_OPTERON)
+
+    ram: --ram RAM, -r RAM
+        (required) The amount of RAM in MB (required)
+
+    availability_zone: --availability-zone AVAILABILITY_ZONE, -a AVAILABILITY_ZONE
+        the availability zone of the server
+
+    volume_name: --volume-name NAME
+        name of the volume
+
+    size: --size SIZE, -S SIZE
+        (required) The size of the volume in GB (required)
+
+    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
+
+    image_alias: --image-alias IMAGE_ALIAS
+        (required) The image alias
+
+    type: --type TYPE, -t TYPE
+        (required) The disk type (HDD or SSD) (required)
+
+    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
+
+    volume_availability_zone: --volume-availability-zone AVAILABILITY_ZONE, -Z AVAILABILITY_ZONE
+        the volume availability zone of the server
+
+    ssh_keys: --ssh-keys SSHKEY1,SSHKEY2,..., -K SSHKEY[,SSHKEY,...]
+        a list of public SSH keys to include
+
+    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 (required)
+
+    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
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    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

data/docs/subcommands/contract_list.md

@@ -0,0 +1,26 @@
+# ContractList
+
+Lists information about available contract resources.
+
+    knife ionoscloud contract list
+
+
+## Available options:
+---
+
+### Required options:
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud contract list--username USERNAME --password PASSWORD

data/docs/subcommands/datacenter_create.md

@@ -0,0 +1,41 @@
+# DatacenterCreate
+
+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.
+
+	knife ionoscloud location list
+
+Make a note of the desired location ID and now the data center can be created.
+
+
+    knife ionoscloud datacenter create (options)
+
+
+## Available options:
+---
+
+### Required options:
+* location
+* ionoscloud_username
+* ionoscloud_password
+
+```
+    name: --name NAME, -n NAME
+        name of the data center
+
+    description: --description DESCRIPTION, -D DESCRIPTION
+        description of the data center
+
+    location: --location LOCATION, -l LOCATION
+        location of the data center (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+```
+
+## Example
+
+    knife ionoscloud datacenter create --name NAME --description DESCRIPTION --location LOCATION --username USERNAME --password PASSWORD