The project is in a healthy, maintained state
Official Chef Knife plugin for Ionoscloud platform using REST API
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 3.10
~> 0.21.2

Runtime

~> 16.10, >= 16.10.17
= 6.1.0
 Project Readme

Knife Plugin for IONOS Cloud

CI Gem Version Gitter Quality Gate Status Bugs Maintainability Rating Reliability Rating Security Rating Vulnerabilities

Alt text

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.

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:

$ 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'

Instead of using username and password to authenticate, one can a Ionoscloud access token, setting it using the :ionoscloud_token argument:.

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

$ rspec spec

Bugs & feature requests can be open on the repository issues: https://github.com/ionos-cloud/knife-ionos-cloud/issues/new/choose