knife-ionoscloud 5.0.0.beta.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbe911ee22d8bcb3ce365bcbaa01e4f694f204bf87863f3b732b634bf15da4e9
-  data.tar.gz: 78618ab79c08a9a86286e0016d547f1c8e85415fe5cffde4a0de2470f33cd69b
+  metadata.gz: c6f600f5f7cde46e790731b30ffd8180db5d375c4d6fd1b9b10647ee77bade25
+  data.tar.gz: 62d7fea589b66d308cee20a9849246fb31a983b6c919f91f910c2d718bf79652
 SHA512:
-  metadata.gz: 473405e0ff5e916d40bba13014e3aa97cd44ee810e982ab809c1249122176f805429edf99cde6cce082d2e7c5b40a2838df2bd1fc068021b93aec17b86843c7e
-  data.tar.gz: a6a7a513bd6ff8f561f7000f156e93614afdc3a1cc248abd18f25973aba4a804511be8766f1b07466d1bdca8c0ca399fb4baef4122c9cf35ed691a0e0de35e3c
+  metadata.gz: f76084ab2fc1e1ef87e597a353442f91f7fe7ff3937b0bad75c26891aafb715f4f4260bbb383a718e335e28bc1009d97d1d470a1c27fb0ad95431ed0ecbb13ca
+  data.tar.gz: d23d88f3b5fcbb650cc6fdbe02c60c74451e67e990eb2652de9b6b4056e57d55c4fc9c9cc78265b2e50099bfe3a546ea335d6f4e29f00b8144f4a874f84409c2

data/.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    types: [opened, synchronize, reopened]
+jobs:
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
+      - name: SonarCloud Scan
+        uses: SonarSource/sonarcloud-github-action@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}  # Needed to get PR information, if any
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

data/.github/workflows/publish.yml

@@ -3,11 +3,9 @@
 name: Publish
 
 on:
-  workflow_dispatch:
-    inputs:
-      version:
-        description: 'Version to publish (e.g. v1.2.3)'
-        required: true
+  push:
+    tags:
+      - 'v*'
 
 jobs:
   publish:
@@ -19,15 +17,9 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v2
-
-      - name: Validate the version
-        shell: bash
-        run: |
-          if [ "${{ github.event.inputs.version }}" != cat lib/knife-ionoscloud/version.rb | grep 'VERSION =' | tr -s ' ' | cut -d ' ' -f 4 | sed 's/^.//;s/.$//' ]; then
-            echo "Specified version does not match the one from version.rb!"
-            exit 1
-          fi
-          echo Next version will be: v${{ github.event.inputs.version }}
+      
+      - name: Unshallow
+        run: git fetch --prune --unshallow
 
       - name: Setup Ruby
         uses: ruby/setup-ruby@v1.61.1
@@ -46,6 +38,21 @@ jobs:
       - name: Run the tests
         run: rspec
 
+      - name: Get the new version
+        id: new_version
+        run: echo ::set-output name=VERSION::$(git tag --list "v*" --sort=version:refname | tail -n 1)
+
+      - name: Get the old version
+        id: old_version
+        run: echo ::set-output name=VERSION::$(git tag --list "v*" --sort=version:refname | tail -n 2 | head -n 1)
+
+      - name: Check Version
+        run: |
+          if [ "${{ steps.new_version.outputs.VERSION }}" != v$(cat lib/knife-ionoscloud/version.rb | grep 'VERSION =' | tr -s ' ' | cut -d ' ' -f 4 | sed 's/^.//;s/.$//') ]; then
+            echo "Tag version does not match the one from version.rb!"
+            exit 1
+          fi
+
       - name: Create RubyGems release of the Knife plugin
         shell: bash
         run: |
@@ -56,3 +63,7 @@ jobs:
           EOF
           chmod 0600 ~/.gem/credentials
           gem push $(gem build knife-ionoscloud.gemspec | grep 'File' | tr -s ' ' | cut -d ' ' -f 3)
+
+      - name: Check version and create GitHub branch
+        run: |
+          /usr/bin/bash ./git-versioning.sh ${{ steps.new_version.outputs.VERSION }} ${{ steps.old_version.outputs.VERSION }}

data/README.md

@@ -0,0 +1,81 @@
+# Knife Plugin for IONOS Cloud
+
+![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)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=knife-plugin&metric=alert_status)](https://sonarcloud.io/dashboard?id=knife-plugin)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=knife-plugin&metric=bugs)](https://sonarcloud.io/dashboard?id=knife-plugin)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=knife-plugin&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=knife-plugin)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=knife-plugin&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=knife-plugin)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=knife-plugin&metric=security_rating)](https://sonarcloud.io/dashboard?id=knife-plugin)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=knife-plugin&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=knife-plugin)
+
+## 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.
+
+In depth documaentation can be found at [here](https://docs.ionos.com/knife-plugin).
+
+
+## Getting Started
+
+An IONOS account is required for access to the Cloud API; credentials from your registration are used to authenticate against the IONOS Cloud API.
+
+### Installation
+
+The `knife-ionoscloud` plugin can be installed as a gem:
+
+```text
+$ gem install knife-ionoscloud
+```
+
+Or the plugin can be installed by adding the following line to your application's Gemfile:
+
+```text
+gem 'knife-ionoscloud'
+```
+
+And then execute:
+
+```text
+$ bundle
+```
+
+### Configuration
+
+The Ionoscloud account credentials can be added to the `knife.rb` configuration file.
+
+```text
+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
+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:
+
+```text
+knife[:ionoscloud_username] = ENV['IONOSCLOUD_USERNAME']
+knife[:ionoscloud_password] = ENV['IONOSCLOUD_PASSWORD']
+```
+
+Now the parameters can be set as environment variables:
+
+```text
+$ export IONOSCLOUD_USERNAME='username'
+$ export IONOSCLOUD_PASSWORD='password'
+```
+
+### Testing
+
+```text
+$ rspec spec
+```
+
+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/README.md

@@ -1,57 +1,71 @@
-# Ionoscloud Chef Knife Plugin
+# Introduction
 
-![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)
+![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.
+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.
 
 ## 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/).
+An IONOS account is required for access to the Cloud API; credentials from your registration are used to authenticate against the IONOS Cloud API.
 
 ### Installation
 
 The `knife-ionoscloud` plugin can be installed as a gem:
 
-    $ gem install knife-ionoscloud
+```text
+$ gem install knife-ionoscloud
+```
 
 Or the plugin can be installed by adding the following line to your application's Gemfile:
 
-    gem 'knife-ionoscloud'
+```text
+gem 'knife-ionoscloud'
+```
 
 And then execute:
 
-    $ bundle
+```text
+$ bundle
+```
 
 ### Configuration
 
 The Ionoscloud account credentials can be added to the `knife.rb` configuration file.
 
-    knife[:ionoscloud_username] = 'username'
-    knife[:ionoscloud_password] = 'password'
+```text
+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'
+```text
+knife[:datacenter_id] = 'f3f3b6fe-017d-43a3-b42a-a759144b2e99'
 
-    knife[:ionoscloud_debug] = true
+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']
+```text
+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'
+```text
+$ export IONOSCLOUD_USERNAME='username'
+$ export IONOSCLOUD_PASSWORD='password'
+```
 
 ### Testing
 
-    $ rspec spec
+```text
+$ rspec spec
+```
 
 ## Feature Reference
 
@@ -65,3 +79,4 @@ The IONOS Cloud plugin for Knife aims to offer access to all resources in the IO
 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

@@ -1 +1,2 @@
-# CHANGELOG
+# Changelog
+

data/docs/subcommands/backupunit_create.md

@@ -2,20 +2,21 @@
 
 Create a new backup unit.
 
-    knife ionoscloud backupunit create (options)
-
+```text
+knife ionoscloud backupunit create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
+
 * name
 * password
 * email
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     name: --name NAME, -n NAME
         alphanumeric name you want assigned to the backup unit (required)
 
@@ -30,9 +31,11 @@ Create a new backup unit.
 
     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
+```text
+knife ionoscloud backupunit create --name NAME --password PASSWORD --email EMAIL --username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/backupunit_delete.md

@@ -2,25 +2,28 @@
 
 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]
-
+```text
+knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     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
+```text
+knife ionoscloud backupunit delete BACKUPUNIT_ID [BACKUPUNIT_ID]--username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/backupunit_list.md

@@ -2,25 +2,28 @@
 
 Retrieve a list of all the backup units the supplied credentials have access to.
 
-    knife ionoscloud backupunit list
-
+```text
+knife ionoscloud backupunit list
+```
 
 ## Available options:
----
 
 ### Required options:
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     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
+```text
+knife ionoscloud backupunit list--username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/backupunit_ssourl.md

@@ -1,19 +1,20 @@
 # 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)
+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.
 
+```text
+knife ionoscloud backupunit ssourl (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* backupunit_id
-* ionoscloud_username
-* ionoscloud_password
 
-```
+* backupunit\_id
+* ionoscloud\_username
+* ionoscloud\_password
+
+```text
     backupunit_id: --backupunit-id BACKUPUNIT_ID, -B BACKUPUNIT_ID
         the ID of the Backup unit. (required)
 
@@ -22,9 +23,11 @@ The ProfitBricks backup system features a web-based GUI. Once you have created a
 
     ionoscloud_password: --password PASSWORD, -p PASSWORD
         your Ionoscloud password (required)
-
 ```
 
 ## Example
 
-    knife ionoscloud backupunit ssourl --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD
+```text
+knife ionoscloud backupunit ssourl --backupunit-id BACKUPUNIT_ID --username USERNAME --password PASSWORD
+```
+

data/docs/subcommands/composite_server_create.md

@@ -2,14 +2,15 @@
 
 This creates a new composite server with an attached volume and NIC in a specified virtual data center.
 
-    knife ionoscloud composite server create (options)
-
+```text
+knife ionoscloud composite server create (options)
+```
 
 ## Available options:
----
 
 ### Required options:
-* datacenter_id
+
+* datacenter\_id
 * name
 * cores
 * ram
@@ -17,10 +18,10 @@ This creates a new composite server with an attached volume and NIC in a specifi
 * type
 * dhcp
 * lan
-* ionoscloud_username
-* ionoscloud_password
+* ionoscloud\_username
+* ionoscloud\_password
 
-```
+```text
     datacenter_id: --datacenter-id DATACENTER_ID, -D DATACENTER_ID
         name of the virtual datacenter (required)
 
@@ -89,9 +90,11 @@ This creates a new composite server with an attached volume and NIC in a specifi
 
     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
+```text
+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
+```
+