knife-ionoscloud 6.1.0 → 6.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844d50cdb67740c66e4509ae0d8ad0a95b486c3e31558c30d54f8f96a019f4a2
-  data.tar.gz: b8fdedf4d8c42e69c33306b67580c13c6522d0c2fc5927b5430909fbd6c62d30
+  metadata.gz: 71feff7578cd72f6d66fe20aa5b0ddf73d655075ea5d4023fbe505aa961f74c1
+  data.tar.gz: 973e78b70f6d7982c829e754c120474ddbb2de4fd8f7f963d88bd8d9f2c7c61c
 SHA512:
-  metadata.gz: af364bfbcaa19a9471d22f48e4261a71f941ff2584618587161da76ae4691c0830e20357354a99628661f69bd013f9f6b57f5373d8ffb4ff029ffc270caafb35
-  data.tar.gz: 4a77204a6becf7a87452921a9379a394dbf788e9ad4c3fca24ed349a03d347b7dc1ee6e8495e8c0f27c07084f5f5d1bb1bb4aaf0d9708199076a1ccfdda7b978
+  metadata.gz: a4f1412269e2b2f5b554712a5921aecb73918b1f90718d34b1c0aeefe9dd5b6b829bd3e3594a0029cdbebf2b930d1dfaa94fcc1845db83d0238287d2660d8dc4
+  data.tar.gz: 5532f4c4f7c9b3011044871fbafbff63284e288715d82346743b90d15877f852d7bdd6d80090ad1f20c7e1cb3f71ab5fbc6b9dfb70b45c4e86f19331bd2e4ab2

data/.github/workflows/build.yml

@@ -1,3 +1,5 @@
+
+  
 name: Build
 on:
   push:
@@ -13,6 +15,21 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1.61.1
+        with:
+          ruby-version: 2.7
+
+      - name: Install the knife plugin
+        run: bundle
+
+      - name: Run the tests
+        run: rspec
+      
+      - name: Update file paths in coverage.json
+        run: sed -i 's+/home/runner/work/knife-ionos-cloud/knife-ionos-cloud+/github/workspace+g' coverage/coverage.json
+
       - name: SonarCloud Scan
         uses: SonarSource/sonarcloud-github-action@master
         env:

data/.rubocop.yml

@@ -145,3 +145,75 @@ Style/RedundantReturn:
 Style/Semicolon:
   Enabled: true
   AllowAsExpressionSeparator: true
+
+Lint/RescueException:
+  Enabled: true
+
+Style/BlockDelimiters:
+  Enabled: true
+
+Layout/DotPosition:
+  Enabled: true
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/IfUnlessModifier:
+  Enabled: true
+
+Layout/MultilineBlockLayout:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Description: 'Checks for trailing comma in hash literals.'
+  Enabled: true
+  # If `comma`, the cop requires a comma after the last item in a hash,
+  # but only when each item is on its own line.
+  # If `consistent_comma`, the cop requires a comma after the last item of all
+  # non-empty, multiline hash literals.
+  EnforcedStyleForMultiline: consistent_comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+  VersionAdded: '0.53'
+
+Style/TrailingCommaInArguments:
+  Description: 'Checks for trailing comma in argument lists.'
+  StyleGuide: '#no-trailing-params-comma'
+  Enabled: true
+  VersionAdded: '0.36'
+  # If `comma`, the cop requires a comma after the last argument, but only for
+  # parenthesized method calls where each argument is on its own line.
+  # If `consistent_comma`, the cop requires a comma after the last argument,
+  # for all parenthesized method calls with arguments.
+  EnforcedStyleForMultiline: consistent_comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+
+Style/TrailingCommaInArrayLiteral:
+  Description: 'Checks for trailing comma in array literals.'
+  StyleGuide: '#no-trailing-array-commas'
+  Enabled: true
+  VersionAdded: '0.53'
+  # If `comma`, the cop requires a comma after the last item in an array,
+  # but only when each item is on its own line.
+  # If `consistent_comma`, the cop requires a comma after the last item of all
+  # non-empty, multiline array literals.
+  EnforcedStyleForMultiline: consistent_comma
+  SupportedStylesForMultiline:
+    - comma
+    - consistent_comma
+    - no_comma
+
+Lint/UselessAssignment:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: false
+  Max: 120

data/README.md

@@ -12,13 +12,6 @@
 
 ![Alt text](.github/IONOS.CLOUD.BLU.svg?raw=true "Title")
 
-
----
-**NOTE:**
-Be aware that the Chef IonosCloud Provider v6 will become main branch and it will be using the latest stable API Version.
-
----
-
 ## 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 IONOS Cloud REST API to provision and manage various cloud resources on the IONOS Cloud platform.
@@ -34,19 +27,19 @@ An IONOS account is required for access to the Cloud API; credentials from your
 
 The `knife-ionoscloud` plugin can be installed as a gem:
 
-```text
+```shell
 $ gem install knife-ionoscloud
 ```
 
 Or the plugin can be installed by adding the following line to your application's Gemfile:
 
-```text
+```gemfile
 gem 'knife-ionoscloud'
 ```
 
 And then execute:
 
-```text
+```shell
 $ bundle
 ```
 
@@ -54,14 +47,14 @@ $ bundle
 
 The Ionoscloud account credentials can be added to the `knife.rb` configuration file.
 
-```text
+```ruby
 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.
 
-```text
+```ruby
 knife[:datacenter_id] = 'f3f3b6fe-017d-43a3-b42a-a759144b2e99'
 
 knife[:ionoscloud_debug] = true
@@ -69,21 +62,30 @@ 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:
 
-```text
+```ruby
 knife[:ionoscloud_username] = ENV['IONOSCLOUD_USERNAME']
 knife[:ionoscloud_password] = ENV['IONOSCLOUD_PASSWORD']
 ```
 
 Now the parameters can be set as environment variables:
 
-```text
+```shell
 $ export IONOSCLOUD_USERNAME='username'
 $ export IONOSCLOUD_PASSWORD='password'
 ```
 
+Instead of using username and password to authenticate, one can a Ionoscloud access token, setting it using the :ionoscloud_token argument:.
+
+```ruby
+knife[:ionoscloud_token] = '<token>'
+```
+
+**NOTE:**
+Be aware that setting the token makes the username and password be ignored, in order to use the username and password one must unset the token value.
+
 ### Testing
 
-```text
+```shell
 $ rspec spec
 ```
 

data/docs/README.md

@@ -2,12 +2,6 @@
 
 ![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)
 
----
-**NOTE:**
-Be aware that the Chef IonosCloud Provider v6 will become main branch and it will be using the latest stable API Version.
-
----
-
 ## 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 IONOS Cloud REST API to provision and manage various cloud resources on the IONOS Cloud platform.
@@ -20,19 +14,19 @@ An IONOS account is required for access to the Cloud API; credentials from your
 
 The `knife-ionoscloud` plugin can be installed as a gem:
 
-```text
+```shell
 $ gem install knife-ionoscloud
 ```
 
 Or the plugin can be installed by adding the following line to your application's Gemfile:
 
-```text
+```gemfile
 gem 'knife-ionoscloud'
 ```
 
 And then execute:
 
-```text
+```shell
 $ bundle
 ```
 
@@ -40,14 +34,14 @@ $ bundle
 
 The Ionoscloud account credentials can be added to the `knife.rb` configuration file.
 
-```text
+```ruby
 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.
 
-```text
+```ruby
 knife[:datacenter_id] = 'f3f3b6fe-017d-43a3-b42a-a759144b2e99'
 
 knife[:ionoscloud_debug] = true
@@ -55,21 +49,29 @@ 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:
 
-```text
+```ruby
 knife[:ionoscloud_username] = ENV['IONOSCLOUD_USERNAME']
 knife[:ionoscloud_password] = ENV['IONOSCLOUD_PASSWORD']
 ```
 
 Now the parameters can be set as environment variables:
 
-```text
+```shell
 $ export IONOSCLOUD_USERNAME='username'
 $ export IONOSCLOUD_PASSWORD='password'
 ```
 
+Instead of using username and password to authenticate, one can a Ionoscloud access token, setting it using the :ionoscloud_token argument:.
+
+```ruby
+knife[:ionoscloud_token] = '<token>'
+```
+
+**Be aware that setting the token makes the username and password be ignored, in order to use the username and password one must unset the token value.**
+
 ### Testing
 
-```text
+```shell
 $ rspec spec
 ```
 

data/docs/changelog.md

@@ -10,3 +10,20 @@
 
 * added support for Dbaas Postgres
 * restructured documentation
+
+## 6.1.1
+
+### Enhancements:
+
+* added backup_location to dbaas postgres cluster create
+* added direction, since and until arguments to logs get command
+* added private argument to k8s cluster create
+* added gateway_ip argument to nodepool create
+
+## 6.1.2
+
+### Enhancements:
+
+* added token authentication
+* removed private argument from k8s create
+* removed gateway_ip argument from nodepool create

data/docs/docs_generator.rb

@@ -7,22 +7,23 @@ require 'fileutils'
 
 $LOAD_PATH << '.'
 
-Dir["../lib/chef/knife/*.rb"].each { |file| require file }
+Dir['../lib/chef/knife/*.rb'].each { |file| require file }
 
 FOLDER_TO_NAME_MAP = {
   'backup' => 'Managed Backup',
   'user' => 'User Management',
   'compute-engine' => 'Compute Engine',
   'kubernetes' => 'Managed Kubernetes',
-  'dbaas-postgres' => 'DbaaS Postgres',
+  'dbaas-postgres' => 'DBaaS Postgres',
+  'application-loadbalancer' => 'Application Load Balancer',
 }.freeze
 
 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
+  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
@@ -53,12 +54,12 @@ class Summary < Mustache
 end
 
 def generate_subcommand_doc(subcommand)
-  options = subcommand.options.map { |key, value|
+  options = subcommand.options.map do |key, value|
     value[:name] = key
     value[:required] = subcommand.required_options.include? key
     value[:description][0] = value[:description][0].downcase
     value
-  }.rotate(3)
+  end.rotate(3)
 
   subcommand_name = subcommand.class.to_s
   subcommand_name.slice!('Chef::Knife::Ionoscloud')
@@ -79,7 +80,7 @@ def generate_subcommand_doc(subcommand)
 
   FileUtils.mkdir_p(File.dirname(filename)) unless File.directory?(File.dirname(filename))
 
-  File.open(filename, 'w') { |f|
+  File.open(filename, 'w') do |f|
     f.write(
       Subcommand.new(
         subcommand.banner,
@@ -89,7 +90,7 @@ def generate_subcommand_doc(subcommand)
         subcommand.required_options.map { |el| el.to_s.gsub '_', '\_' },
       ).render,
     )
-  }
+  end
 
   puts "Generated documentation for #{subcommand_name}."
   {
@@ -102,23 +103,20 @@ end
 subcommands = []
 
 begin
-  Chef::Knife.constants.select { |c|
+  Chef::Knife.constants.select do |c|
     Chef::Knife.const_get(c).is_a?(Class) && c.to_s.start_with?('Ionoscloud')
-  }.each {
-    |subcommand|
+  end.each do |subcommand|
     # if subcommand.to_s == 'IonoscloudBackupunitCreate'
     begin
       subcommands.append(generate_subcommand_doc(Chef::Knife.const_get(subcommand).new))
-    rescue Exception => exc
+    rescue StandardError => exc
       puts "Could not generate doc for #{subcommand}. Error: #{exc}"
       # raise exc
     end
     # end
-  }
-rescue NameError => exc
-  if exc.message == 'uninitialized constant Chef'
-    puts 'This must be run from /docs directory!'
   end
+rescue NameError => exc
+  puts 'This must be run from /docs directory!' if exc.message == 'uninitialized constant Chef'
   raise exc
 end
 
@@ -133,10 +131,10 @@ subcommands.map do |subcommand|
 end
 
 
-final = []
+final_categories = []
 
-categories.map { |key, value| final << { category: key, subcommands: value } }
+categories.map { |key, value| final_categories << { category: key, subcommands: value.sort_by { |a| a[:title] } } }
 
-File.open('summary.md', 'w') { |f|
-  f.write(Summary.new(final).render)
-}
+File.open('summary.md', 'w') do |f|
+  f.write(Summary.new(final_categories.sort_by { |a| a[:category].to_s }).render)
+end

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_create.md

@@ -0,0 +1,60 @@
+# ApplicationloadbalancerCreate
+
+Creates an Application Load Balancer within the datacenter.
+
+```text
+knife ionoscloud applicationloadbalancer create (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* name
+* listener\_lan
+* target\_lan
+* ips
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    name: --name NAME, -n NAME
+        name of the Application Load Balancer (required)
+
+    listener_lan: --listener-lan LISTENER_LAN_ID, -l LISTENER_LAN_ID
+        id of the listening LAN. (inbound) (required)
+
+    target_lan: --target-lan TARGET_LAN_ID, -t TARGET_LAN_ID
+        id of the balanced private target LAN. (outbound) (required)
+
+    ips: --ips IP[,IP,...], -i IP[,IP,...]
+        collection of IP addresses of the Application Load Balancer. (inbound and outbound) IP of the listenerLan must be a customer reserved IP for the public load balancer and private IP for the private load balancer. (required)
+
+    lb_private_ips: --private-ips IP[,IP,...]
+        collection of private IP addresses with subnet mask of the Application Load Balancer. IPs must contain valid subnet mask. If user will not provide any IP then the system will generate one IP with /24 subnet.
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer create --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --name NAME --listener-lan LISTENER_LAN_ID --target-lan TARGET_LAN_ID --ips IP[,IP,...] --private-ips IP[,IP,...] --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_delete.md

@@ -0,0 +1,41 @@
+# ApplicationloadbalancerDelete
+
+Removes the specified Application Load Balancer.
+
+```text
+knife ionoscloud applicationloadbalancer delete LOAD_BALANCER_ID [LOAD_BALANCER_ID] (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name 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)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer delete LOAD_BALANCER_ID 
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_get.md

@@ -0,0 +1,45 @@
+# ApplicationloadbalancerGet
+
+Retrieves the attributes of a given Application Load Balancer.
+
+```text
+knife ionoscloud applicationloadbalancer get (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        iD of the data center (required)
+
+    application_loadbalancer_id: --application-loadbalancer NETWORK_LOADBALANCER_ID, -L NETWORK_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer get --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer NETWORK_LOADBALANCER_ID --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_list.md

@@ -0,0 +1,41 @@
+# ApplicationloadbalancerList
+
+Retrieve a list of Application Load Balancers within the datacenter.
+
+```text
+knife ionoscloud applicationloadbalancer list (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name 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)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer list --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --username USERNAME --password PASSWORD --token PASSWORD
+```

data/docs/subcommands/application-loadbalancer/applicationloadbalancer_rule_add.md

@@ -0,0 +1,69 @@
+# ApplicationloadbalancerRuleAdd
+
+Adds a Forwarding Rule to a Application Load Balancer under a data center.
+
+```text
+knife ionoscloud applicationloadbalancer rule add (options)
+```
+
+## Available options:
+
+### Required options:
+
+* datacenter\_id
+* application\_loadbalancer\_id
+* name
+* listener\_ip
+* listener\_port
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
+    ionoscloud_url: --url URL
+        the Ionoscloud API URL
+
+    extra_config_file: --extra-config EXTRA_CONFIG_FILE_PATH, -e EXTRA_CONFIG_FILE_PATH
+        path to the additional config file
+
+    datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
+        name of the data center (required)
+
+    application_loadbalancer_id: --application-loadbalancer APPLICATION_LOADBALANCER_ID, -L APPLICATION_LOADBALANCER_ID
+        iD of the Application Loadbalancer (required)
+
+    name: --name NAME, -n NAME
+        a name of that Application Load Balancer forwarding rule (required)
+
+    protocol: --protocol PROTOCOL
+        protocol of the balancing
+
+    listener_ip: --ip LISTENER_IP, -i LISTENER_IP
+        listening IP. (inbound) (required)
+
+    listener_port: --port LISTENER_PORT, -p LISTENER_PORT
+        listening port number. (inbound) (range: 1 to 65535) (required)
+
+    client_timeout: --client-timeout CLIENT_TIMEOUT
+        clientTimeout is expressed in milliseconds. This inactivity timeout applies when the client is expected to acknowledge or send data. If unset the default of 50 seconds will be used.
+
+    server_certificates: --certificates SERVER_CERTIFICATES
+        array of server certificates
+
+    http_rules: --http-rules HTTP_RULES
+        array of HTTP Rules
+
+    ionoscloud_username: --username USERNAME, -u USERNAME
+        your Ionoscloud username (required)
+
+    ionoscloud_password: --password PASSWORD, -p PASSWORD
+        your Ionoscloud password (required)
+
+    ionoscloud_token: --token PASSWORD
+        your Ionoscloud access token
+
+```
+## Example
+
+```text
+knife ionoscloud applicationloadbalancer rule add --url URL --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --application-loadbalancer APPLICATION_LOADBALANCER_ID --name NAME --protocol PROTOCOL --ip LISTENER_IP --port LISTENER_PORT --client-timeout CLIENT_TIMEOUT --certificates SERVER_CERTIFICATES --http-rules HTTP_RULES --username USERNAME --password PASSWORD --token PASSWORD
+```