https://github.com/ionos-cloud/knife-ionos-cloud
https://github.com/ionos-cloud/knife-ionos-cloud
Last synced: 30 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ionos-cloud/knife-ionos-cloud
- Owner: ionos-cloud
- License: apache-2.0
- Created: 2021-01-14T09:51:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-13T10:47:54.000Z (about 1 year ago)
- Last Synced: 2025-03-03T04:33:07.307Z (about 2 months ago)
- Language: Ruby
- Size: 1.27 MB
- Stars: 0
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Knife Plugin for IONOS Cloud
[](https://badge.fury.io/rb/knife-ionoscloud)
[](https://gitter.im/ionos-cloud/sdk-general)
[](https://sonarcloud.io/dashboard?id=knife-plugin)
[](https://sonarcloud.io/dashboard?id=knife-plugin)
[](https://sonarcloud.io/dashboard?id=knife-plugin)
[](https://sonarcloud.io/dashboard?id=knife-plugin)
[](https://sonarcloud.io/dashboard?id=knife-plugin)
[](https://sonarcloud.io/dashboard?id=knife-plugin)
---
### Warning: API Basic Authentication Deprecation Notice
Effective March 15, 2024, IONOS account holders using 2-Factor Authentication will no longer be able to utilize Basic Authentication for accessing our APIs, SDKs, and all related tools. Token creation and deletion via APIs and ionosCTL will also be restricted.
Affected users are required to switch to token-based authorization. These tokens will be accessible through our new Token Manager in the Data Center Designer, launching at the beginning of February 2024. More information can be found [here](https://docs.ionos.com/cloud/getting-started/basic-tutorials/deprecation-basic-authentication/basic-authentication-deprecation-faqs).
---
## 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:
```shell
$ gem install knife-ionoscloud
```
Or the plugin can be installed by adding the following line to your application's Gemfile:
```gemfile
gem 'knife-ionoscloud'
```
And then execute:
```shell
$ bundle
```
### Configuration
The Ionoscloud account credentials can be added to the `knife.rb` configuration file.
```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.
```ruby
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:
```ruby
knife[:ionoscloud_username] = ENV['IONOSCLOUD_USERNAME']
knife[:ionoscloud_password] = ENV['IONOSCLOUD_PASSWORD']
```
Now the parameters can be set as environment variables:
```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] = ''
```
**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
```shell
$ 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)