knife-ionoscloud 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 844d50cdb67740c66e4509ae0d8ad0a95b486c3e31558c30d54f8f96a019f4a2
-  data.tar.gz: b8fdedf4d8c42e69c33306b67580c13c6522d0c2fc5927b5430909fbd6c62d30
+  metadata.gz: 9385d226271569cd7a89fa7d99feb5c96f3d693b5e44d521d706b9d89c40777d
+  data.tar.gz: 6150c9bbc71616e583055427fa7cc973cb65e4dad19fdabe86af50de9a1b02fa
 SHA512:
-  metadata.gz: af364bfbcaa19a9471d22f48e4261a71f941ff2584618587161da76ae4691c0830e20357354a99628661f69bd013f9f6b57f5373d8ffb4ff029ffc270caafb35
-  data.tar.gz: 4a77204a6becf7a87452921a9379a394dbf788e9ad4c3fca24ed349a03d347b7dc1ee6e8495e8c0f27c07084f5f5d1bb1bb4aaf0d9708199076a1ccfdda7b978
+  metadata.gz: 42a7960791b3f0a8bc15bb544afc1f37ceb90f66f99d334ed8668c49109ebfada511829b73a044e47363f6869e86c42e9dd18d91f2fbecbe535eaa6b0f3df904
+  data.tar.gz: 904dc4e6a4efb8b02f8f951dbda26c1209b73b3597837197f431631ed6727ed23bc6e5dc59021b0f4d88e4d5192d28c1c6acdc4a2068946280aa714fe50d5a30

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/docs/docs_generator.rb

@@ -7,22 +7,22 @@ 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',
 }.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 +53,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 +79,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 +89,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 +102,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 +130,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).render)
+end

data/docs/subcommands/dbaas-postgres/dbaas_postgres_backup_get.md

@@ -1,6 +1,6 @@
 # DbaasPostgresBackupGet
 
-Retrieves information about a Ionoscloud DBaaS Cluster Backup.
+Retrieve a PostgreSQL cluster backup by using its ID. This value can be found when you GET a list of PostgreSQL cluster backups.
 
 ```text
 knife ionoscloud dbaas postgres cluster get (options)

data/docs/subcommands/dbaas-postgres/dbaas_postgres_backup_list.md

@@ -1,7 +1,6 @@
 # DbaasPostgresBackupList
 
-If cluster_id is provided, retrieves a list of all backups of the given PostgreSQL cluster,
-        otherwise retrieves a list of all PostgreSQL cluster backups.
+If cluster_id is provided, retrieves a list of all backups of the given PostgreSQL cluster, otherwise retrieves a list of all PostgreSQL cluster backups.
 
 ```text
 knife ionoscloud dbaas postgres backup list (options)

data/docs/subcommands/dbaas-postgres/dbaas_postgres_cluster_create.md

@@ -1,6 +1,6 @@
 # DbaasPostgresClusterCreate
 
-Creates a new PostgreSQL cluster.
+Creates a new PostgreSQL cluster. If the `fromBackup` field is populated, the new cluster will be created based on the given backup.
 
 ```text
 knife ionoscloud dbaas postgres cluster create (options)
@@ -55,6 +55,9 @@ knife ionoscloud dbaas postgres cluster create (options)
                             be where all of your instances live. Property cannot be modified
                             after datacenter creation (disallowed in update requests) (required)
 
+    backup_location: --backup-location BACKUP_LOCATION
+        the S3 location where the backups will be stored.
+
     display_name: --name DISPLAY_NAME, -n DISPLAY_NAME
         the friendly name of your cluster. (required)
 
@@ -68,7 +71,7 @@ knife ionoscloud dbaas postgres cluster create (options)
         day Of the week when to perform the maintenance.
 
     synchronization_mode: --synchronization-mode SYNCHRONIZATION_MODE, -s SYNCHRONIZATION_MODE
-        represents different modes of replication (required)
+        represents different modes of replication. One of [ASYNCHRONOUS, SYNCHRONOUS, STRICTLY_SYNCHRONOUS] (required)
 
     username: --db-user DB_USERNAME
         the username for the initial postgres user.
@@ -96,5 +99,5 @@ knife ionoscloud dbaas postgres cluster create (options)
 ## Example
 
 ```text
-knife ionoscloud dbaas postgres cluster create --extra-config EXTRA_CONFIG_FILE_PATH --postgres-version POSTGRES_VERSION --instances INSTANCES --cores CORES --ram RAM --size STORAGE_SIZE --type STORAGE_TYPE --connections CONNECTIONS --location LOCATION --name DISPLAY_NAME --from-backup FROM_BACKUP --time TIME --day-of-the-week DAY_OF_THE_WEEK --synchronization-mode SYNCHRONIZATION_MODE --db-user DB_USERNAME --db-password DB_PASSWORD --backup-id BACKUP_ID --recovery-target-time RECOVERY_TARGET_TIME --username USERNAME --password PASSWORD --url URL
+knife ionoscloud dbaas postgres cluster create --extra-config EXTRA_CONFIG_FILE_PATH --postgres-version POSTGRES_VERSION --instances INSTANCES --cores CORES --ram RAM --size STORAGE_SIZE --type STORAGE_TYPE --connections CONNECTIONS --location LOCATION --backup-location BACKUP_LOCATION --name DISPLAY_NAME --from-backup FROM_BACKUP --time TIME --day-of-the-week DAY_OF_THE_WEEK --synchronization-mode SYNCHRONIZATION_MODE --db-user DB_USERNAME --db-password DB_PASSWORD --backup-id BACKUP_ID --recovery-target-time RECOVERY_TARGET_TIME --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/dbaas-postgres/dbaas_postgres_cluster_delete.md

@@ -1,6 +1,6 @@
 # DbaasPostgresClusterDelete
 
-Delete a Ionoscloud Dbaas Cluster
+Delete a PostgreSQL cluster.
 
 ```text
 knife ionoscloud dbaas postgres cluster delete CLUSTER_ID [CLUSTER_ID]

data/docs/subcommands/dbaas-postgres/dbaas_postgres_cluster_get.md

@@ -1,6 +1,6 @@
 # DbaasPostgresClusterGet
 
-Retrieves information about a Ionoscloud DBaaS Cluster.
+You can retrieve a PostgreSQL cluster by using its ID. This value can be found in the response body when a PostgreSQL cluster is created or when you GET a list of PostgreSQL clusters.
 
 ```text
 knife ionoscloud dbaas postgres cluster get (options)

data/docs/subcommands/dbaas-postgres/dbaas_postgres_cluster_list.md

@@ -1,6 +1,6 @@
 # DbaasPostgresClusterList
 
-retrieves a list of all PostgreSQL clusters.
+Retrieves a list of PostgreSQL clusters.
 
 ```text
 knife ionoscloud dbaas postgres cluster list

data/docs/subcommands/dbaas-postgres/dbaas_postgres_cluster_restore.md

@@ -1,6 +1,6 @@
 # DbaasPostgresClusterRestore
 
-Restore a Ionoscloud DBaaS Cluster.
+Triggers an in-place restore of the given PostgreSQL.
 
 ```text
 knife ionoscloud dbaas postgres cluster restore (options)

data/docs/subcommands/dbaas-postgres/dbaas_postgres_cluster_update.md

@@ -39,7 +39,7 @@ knife ionoscloud dbaas postgres cluster update (options)
     time: --time TIME
         time Of the day when to perform the maintenance.
 
-    weekday: --weekday WEEKDAY, -d WEEKDAY
+    day_of_the_week: --day-of-the-week DAY_OF_THE_WEEK, -d DAY_OF_THE_WEEK
         day Of the week when to perform the maintenance.
 
     postgres_version: --postgres-version POSTGRES_VERSION
@@ -61,5 +61,5 @@ knife ionoscloud dbaas postgres cluster update (options)
 ## Example
 
 ```text
-knife ionoscloud dbaas postgres cluster update --extra-config EXTRA_CONFIG_FILE_PATH --cluster-id CLUSTER_ID --cores CORES --ram RAM --size STORAGE_SIZE --connections CONNECTIONS --name DISPLAY_NAME --time TIME --weekday WEEKDAY --postgres-version POSTGRES_VERSION --instances INSTANCES --username USERNAME --password PASSWORD --url URL
+knife ionoscloud dbaas postgres cluster update --extra-config EXTRA_CONFIG_FILE_PATH --cluster-id CLUSTER_ID --cores CORES --ram RAM --size STORAGE_SIZE --connections CONNECTIONS --name DISPLAY_NAME --time TIME --day-of-the-week DAY_OF_THE_WEEK --postgres-version POSTGRES_VERSION --instances INSTANCES --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/dbaas-postgres/dbaas_postgres_logs_get.md

@@ -1,6 +1,6 @@
 # DbaasPostgresLogsGet
 
-Get logs of your cluster
+Retrieves PostgreSQL logs based on the given parameters.
 
 ```text
 knife ionoscloud dbaas postgres logs get
@@ -25,10 +25,13 @@ knife ionoscloud dbaas postgres logs get
         the maximal number of log lines to return.
 
     start: --start START
-        the start time for the query in RFC3339 format.
+        the start time for the query in RFC3339 format. Can also be specified as a time delta since the current moment: 2h - 2 hours ago, 20m - 20 minutes ago. Only hours and minutes ar supported, and not at the same time.
 
     end: --end END
-        the end time for the query in RFC3339 format.
+        the end time for the query in RFC3339 format. Can also be specified as a time delta since the current moment: 2h - 2 hours ago, 20m - 20 minutes ago. Only hours and minutes ar supported, and not at the same time.
+
+    direction: --direction DIRECTION
+        the direction in which to scan through the logs. The logs are returned in order of the direction. One of ["BACKWARD", "FORWARD"]
 
     ionoscloud_username: --username USERNAME, -u USERNAME
         your Ionoscloud username (required)
@@ -43,5 +46,5 @@ knife ionoscloud dbaas postgres logs get
 ## Example
 
 ```text
-knife ionoscloud dbaas postgres logs get--extra-config EXTRA_CONFIG_FILE_PATH --cluster-id CLUSTER_ID --limit LIMIT --start START --end END --username USERNAME --password PASSWORD --url URL
+knife ionoscloud dbaas postgres logs get--extra-config EXTRA_CONFIG_FILE_PATH --cluster-id CLUSTER_ID --limit LIMIT --start START --end END --direction DIRECTION --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/dbaas-postgres/dbaas_postgres_version_list.md

@@ -1,7 +1,6 @@
 # DbaasPostgresVersionList
 
-If cluster_id is provided, retrieves a list of all PostgreSQL versions available for a cluster including the current version,
-        otherwise retrieves a list of all available PostgreSQL versions.
+If cluster_id is provided, retrieves a list of all PostgreSQL versions available for a cluster including the current version, otherwise retrieves a list of all available PostgreSQL versions.
 
 ```text
 knife ionoscloud dbaas postgres version list

data/docs/subcommands/kubernetes/k8s_create.md

@@ -24,6 +24,9 @@ knife ionoscloud k8s create (options)
     version: --version VERSION, -v VERSION
         the version for the Kubernetes cluster.
 
+    private: --private
+        the indicator if the cluster is public or private. Be aware that creating a private cluster is currently in beta phase.
+
     maintenance_day: --maintenance-day MAINTENANCE_DAY, -d MAINTENANCE_DAY
         day Of the week when to perform the maintenance.
 
@@ -49,5 +52,5 @@ knife ionoscloud k8s create (options)
 ## Example
 
 ```text
-knife ionoscloud k8s create --extra-config EXTRA_CONFIG_FILE_PATH --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --subnets SUBNET [SUBNET] --buckets S3_BUCKET [S3_BUCKET] --username USERNAME --password PASSWORD --url URL
+knife ionoscloud k8s create --extra-config EXTRA_CONFIG_FILE_PATH --name NAME --version VERSION --private --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --subnets SUBNET [SUBNET] --buckets S3_BUCKET [S3_BUCKET] --username USERNAME --password PASSWORD --url URL
 ```

data/docs/subcommands/kubernetes/nodepool_create.md

@@ -78,6 +78,9 @@ knife ionoscloud nodepool create (options)
     lans: --lans LAN_ID [LAN_ID]
         an array of additional private LANs attached to worker nodes
 
+    gateway_ip: --gateway GATEWAY_IP
+        public IP address for the gateway performing source NAT for the node pool's nodes belonging to a private cluster. Required only if the node pool belongs to a private cluster.
+
     public_ips: --ips PUBLIC_IP [PUBLIC_IP]
         optional array of reserved public IP addresses to be used by the nodes. IPs must be from same location as the data center used for the node pool. The array must contain one extra IP than maximum number of nodes could be. (nodeCount+1 if fixed node amount or maxNodeCount+1 if auto scaling is used) The extra provided IP Will be used during rebuilding of nodes.
 
@@ -100,5 +103,5 @@ knife ionoscloud nodepool create (options)
 ## Example
 
 ```text
-knife ionoscloud nodepool create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --ips PUBLIC_IP [PUBLIC_IP] --labels LABEL [LABEL] --annotations ANNOTATION [ANNOTATION] --username USERNAME --password PASSWORD --url URL
+knife ionoscloud nodepool create --extra-config EXTRA_CONFIG_FILE_PATH --datacenter-id DATACENTER_ID --cluster-id CLUSTER_ID --name NAME --version VERSION --maintenance-day MAINTENANCE_DAY --maintenance-time MAINTENANCE_TIME --node-count NODE_COUNT --cpu-family CPU_FAMILY --cores CORES --ram RAM --availability-zone AVAILABILITY_ZONE --storage-type STORAGE_TYPE --storage-size STORAGE_SIZE --min-node-count MIN_NODE_COUNT --max-node-count MAX_NODE_COUNT --lans LAN_ID [LAN_ID] --gateway GATEWAY_IP --ips PUBLIC_IP [PUBLIC_IP] --labels LABEL [LABEL] --annotations ANNOTATION [ANNOTATION] --username USERNAME --password PASSWORD --url URL
 ```