Project

knife-scaleway

0.0
No commit activity in last 3 years
No release in over 3 years
knife-scalewaylukasskywalker/knife-scalewayHomepageDocumentationSource CodeBug TrackerWiki
A plugin for chef's knife to manage instances of Scaleway servers
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,655
Stars
2
Forks
0
Watchers
2
 Releases
Current version
0.1.0
Total releases
1
First release
2016-09-05
Latest release
2016-09-05
 Development
Primary Language
Ruby
Licenses
Apache 2.0
Average date of last 50 commits
2015-09-06
Reverse Dependencies
0

 Dependencies

Development

countloc
>= 0
coveralls
>= 0
guard
~> 2.8
guard-rspec
~> 4.3
knife-solo
>= 0
knife-zero
>= 0
rake
>= 0
rspec
~> 3.1
rubocop
~> 0.27
simplecov
>= 0
simplecov-console
>= 0
vcr
~> 2.9
webmock
~> 1.20

Runtime

chef
>= 10.18
 Project Readme

Knife::Scaleway

A knife plugin to deal with the Scaleway.com Cloud services.

This is a plugin for Chef's knife tool. It allows you to bootstrap virtual machines with Scaleway.com including the initial bootstrapping of chef on that system. You can also use knife-solo or knife-zero for chef bootstrapping or skip it altogether for another solution.

This knife plugin uses the scaleway ruby library.

Knife::Scaleway supports Chef 12.

Installation

when using ChefDK

➜ chef gem install knife-scaleway

in typical Ruby setup

➜ gem install knife-scaleway

Overview

This plugin provides the following sub-commands:

  • knife scaleway server create (options)
    Creates a virtual machine with or without bootstrapping chef

  • knife scaleway server list (options)
    Lists currently running virtual machines

  • knife scaleway server power (options)
    Turn a server On/Off

  • knife scaleway image list (options)
    Lists available images (snapshots, backups, OS-images)

  • knife scaleway region list (options)
    Lists the server regions/locations/data-center

  • knife scaleway volume list (options)
    Lists the storage volumes

  • knife scaleway ip list (options)
    Lists the reserved ip addresses

Configuration

The best way is to put your API-credentials of Scaleway in your knife.rb file of choice (e.g. in ~/.chef/knife.rb):

knife[:scaleway_access_key]   = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'
knife[:scaleway_token]        = 'YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY'

Usage

Create a Server

There are three different ways of creating a server instance:

If you just want to launch an instance form the command line without any bootstrapping, go for option D. If you use knife-zero try C, if you use knife-solo try B and if you are a chef-server-fan use method A:

A. With bootstrapping in an chef-server environment:

Examples

➜ knife scaleway server create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
➜ knife scaleway server create --server-name awesome-vm2.vm.io \
                                      --image debian-7.0-x64 \
                                      --location sfo1 \
                                      --size 512mb \
                                      --ssh-keys 1234,1235 \
                                      --bootstrap \
                                      --bootstrap-version 11.16.4-1
                                      --run-list "role[base],role[webserver]" \
                                      --secret-file "/home/user/.ssh/secret_file" \
                                      --ssh-port 22 \
                                      --identity-file "~/.ssh/id_rsa" \
                                      --private_networking

Syntax

➜ knife scaleway server create --server-name <FQDN> \
                                      --image <IMAGE SLUG> \
                                      --location <REGION SLUG> \
                                      --size <SIZE SLUG> \
                                      --ssh-keys <SSH KEY-ID(s), comma-separated> \
                                      --ssh-port <SSH PORT> \
                                      --bootstrap \
                                      --bootstrap-version <VERSION NUMBER>
                                      --run-list "<RUNLIST>" \
                                      --secret-file "<FILENAME>" \
                                      --private_networking
                                      --ipv6-enabled

Short Syntax

➜ knife scaleway server create -N <FQDN> \
                                      -I <IMAGE SLUG> \
                                      -L <REGION SLUG> \
                                      -S <SIZE SLUG> \
                                      -K <SSH KEY-ID(s), comma-separated> \
                                      -p <SSH PORT> \
                                      -B \
                                      -r "<RUNLIST>"
                                      -6

B. With knife-solo bootstrapping

You need to have knife-solo gem installed.

This will create a server and run knife solo bootstrap <IP> equivalent for it. Please consult the knife-solo documentation for further details.

Example

➜ knife scaleway server create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location lon1 \
                                      --size 2gb \
                                      --ssh-keys 1234,4567 \
                                      --run-list "<RUNLIST>" \
                                      --solo

C. With knife-zero bootstrapping

You need to have knife-zero gem installed.

This will create a server and run knife zero bootstrap <IP> equivalent for it. Please consult the knife-zero documentation for further details.

Example

➜ knife scaleway server create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location lon1 \
                                      --size 2gb \
                                      --ssh-keys 1234,4567 \
                                      --run-list "<RUNLIST>" \
                                      --zero

D. With your custom external bootstrapping script or without chef at all

This will just create a server and return its IP-address. Nothing else. You can now run your custom solution to provision the server.

Example

➜ knife scaleway server create --server-name awesome-vm1.vm.io \
                                      --image debian-7-0-x64 \
                                      --location lon1 \
                                      --size 2gb \
                                      --ssh-keys 1234,4567

List running servers (servers)

➜ knife scaleway server list
ID     Name                  Size   Region       IPv4            Image                            Status
12345  app20.ams.nl.vm.io  1gb    Amsterdam 1  185.14.123.123  25306 (Ubuntu 12.10 x32 Server)  active
23456  awesome-vm1.vm.io   512mb  Amsterdam 1  185.14.124.125  25306 (Ubuntu 12.10 x32 Server)  active

!WARNING! Destroy a server (server) including all of its data!

Destroy server by id

➜ knife scaleway server destroy -S 23456
OK

Destroy all servers

➜ knife scaleway server destroy --all
Delete server with id: 1824315
Delete server with id: 1824316
Delete server with id: 1824317

Reboot A Server

➜ knife scaleway server reboot -I 1824315
OK

Turn Power On/Off

➜ knife scaleway power -I 1824315 -a on
OK
➜ knife scaleway power -I 1824315 -a off
OK

Powercycle A Server

➜ knife scaleway powercycle -I 1824315
OK

Rebuild A Server

➜ knife scaleway rebuild --server-id 1824315 --image-id 65420
OK

Rename A Server

➜ knife scaleway rename -I 1824315 -N 'myserverrocks.com'
OK

Resize A Server

➜ knife scaleway rename -I 1824315 -s 1gb
OK

Create a server from a Snapshot

➜ knife scaleway snapshot -I 1824315 -N 'my-super-awesome-snapshot'
OK

List regions

➜ knife scaleway region list
Name             Slug
Amsterdam 1      ams1
Amsterdam 2      ams2
Amsterdam 3      ams3
Frankfurt 1      fra1
London 1         lon1
New York 1       nyc1
New York 2       nyc2
New York 3       nyc3
San Francisco 1  sfo1
Singapore 1      sgp1

List sizes (instance types)

➜ knife scaleway size list
Slug
512mb
1gb
2gb
4gb
8gb
16gb
32gb
48gb
64gb

List images

Custom images (snapshots, backups) (default)

➜ knife scaleway image list
ID     Distribution  Name
11111  Ubuntu        app100.ams.nlxxxxx.net 2013-02-01
11112  Ubuntu        app100.ams.nlxxxxx.net 2013-02-03
11113  Ubuntu        init

Public images (OS)

➜ knife scaleway image list --public
ID        Distribution  Name                                      Slug       
10322623  CentOS        7 x64                                     centos-7-0-x64  
6372425   CentOS        5.10 x32                                  centos-5-8-x32  
6372321   CentOS        5.10 x64                                  centos-5-8-x64  
10325992  CentOS        6.5 x32                                   centos-6-5-x32  
10325922  CentOS        6.5 x64                                   centos-6-5-x64  
10679356  CoreOS        557.2.0 (stable)                          coreos-stable   
10679369  CoreOS        593.0.0 (alpha)                           coreos-alpha    
10692842  CoreOS        584.0.0 (beta)                            coreos-beta     
10322059  Debian        7.0 x64                                   debian-7-0-x64  
6372581   Debian        6.0 x64                                   debian-6-0-x64  
6372662   Debian        6.0 x32                                   debian-6-0-x32  
10322378  Debian        7.0 x32                                   debian-7-0-x32  
9640922   Fedora        21 x64                                    fedora-21-x64   
6370969   Fedora        19 x32                                    fedora-19-x32   
6370882   Fedora        20 x64                                    fedora-20-x64   
6370968   Fedora        19 x64                                    fedora-19-x64   
6370885   Fedora        20 x32                                    fedora-20-x32   
10163059  FreeBSD       FreeBSD AMP on 10.1                       freebsd-amp     
10144573  FreeBSD       10.1                                      freebsd-10-1-x64
6732690   Ubuntu        LEMP on 14.04                             lemp            
10321870  Ubuntu        10.04 x32                                 ubuntu-10-04-x32
10321777  Ubuntu        12.04.5 x32                               ubuntu-12-04-x32
10321756  Ubuntu        12.04.5 x64                               ubuntu-12-04-x64
9801948   Ubuntu        14.04 x32                                 ubuntu-14-04-x32
9801954   Ubuntu        14.10 x64                                 ubuntu-14-10-x64
9801951   Ubuntu        14.10 x32                                 ubuntu-14-10-x32
6376601   Ubuntu        Ruby on Rails on 14.04 (Nginx + Unicorn)  ruby-on-rails   
6423475   Ubuntu        WordPress on 14.04                        wordpress       
10321819  Ubuntu        10.04 x64                                 ubuntu-10-04-x64
6732691   Ubuntu        LAMP on 14.04                             lamp            
6798184   Ubuntu        MEAN on 14.04                             mean            
8375425   Ubuntu        Drupal 7.34 on 14.04                      drupal          
8412876   Ubuntu        Magento 1.9.1.0 on 14.04                  magento         
8953301   Ubuntu        ELK Logging Stack on 14.04                elk             
9918633   Ubuntu        Ghost 0.5.8 on 14.04                      ghost           
9967718   Ubuntu        Django on 14.04                           django          
9801950   Ubuntu        14.04 x64                                 ubuntu-14-04-x64
10274087  Ubuntu        GitLab 7.7.1 CE on 14.04                  gitlab          
10321359  Ubuntu        MediaWiki 1.24.0 on 14.04                 mediawiki       
10462503  Ubuntu        Drone on 14.04                            drone           
10507592  Ubuntu        node-v0.12.0 on 14.04                     node            
10563620  Ubuntu        Dokku v0.3.14 on 14.04                    dokku           
10565666  Ubuntu        ownCloud 8.0 on 14.04                     owncloud        
10581649  Ubuntu        Docker 1.5.0 on 14.04                     docker          
7572830   Ubuntu        Redmine on 14.04                          redmine

Destroy Private Images

➜ knife scaleway image destroy -I 11112
OK

Transfer Private Images to Another Region

➜ knife scaleway image destroy -I 11112 -R ams1

SSH keys

List SSH keys

➜ knife scaleway sshkey list
ID    Name    Fingerprint
1234  Alice   e0:1a:1b:30:7f:bd:b2:cf:f2:4f:3b:35:3c:87:46:1c
1235  Bob     b0:ca:40:36:7f:bd:b2:cf:f2:4f:2b:45:3c:28:41:5f
1236  Chuck   g0:da:3e:15:7f:bd:b2:cf:f2:4f:3a:26:3c:34:52:2b
1237  Craig   f0:fa:2b:22:7f:bd:b2:cf:f2:4f:4c:18:3c:66:54:1c

Create a SSH key

➜ knife scaleway sshkey create -i ~/.ssh/id_rsa.pub -n Bob

Destroy a SSH key

➜ knife scaleway sshkey destroy -i 1236
OK

DNS

Create a domain

➜ knife scaleway domain create -N example.com -I 192.168.1.1

Destroy a domain

➜ knife scaleway domain destroy -D example.com
OK

List domains

➜ knife scaleway domain list
Name         TTL
example.com  1800

Create a domain record

➜ knife scaleway domain record create -D example.com -T CNAME -N www -a @

Destroy a domain record

➜ knife scaleway domain record destroy -D example.com -R 3355880
OK

List domain records

➜ knife scaleway domain record list -D example.com
ID       Type  Name  Data
3355877  NS    @     ns1.scaleway.com
3355878  NS    @     ns2.scaleway.com
3355879  NS    @     ns3.scaleway.com
3355880  A     @     192.168.1.1

Account Info

➜ knife scaleway account info
UUID                                      Email           Server Limit  Email Verified
58e2e737d3b7407b042aa7f99f4da4229166f2a1  joe@example.com 10             true

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

RuboCop / Ruby Style Guide

We want to make sure that our code complies with the Ruby Style Guide:

see:

Contributors

For more information and a complete list see the contributor page on GitHub.

License

Apache 2.0 (like Chef itself), see LICENSE.txt file.

Copyright

Copyright © 2015 Roland Moriz, Moriz GmbH
Copyright © 2015 Greg Fitzgerald