knife-oneandone 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa0a41498d94a3ca7afad90a25ee6337ec5afbc9
+  data.tar.gz: cb10cddce5a6ee6968c06caaf9ef3484ecffccb1
+SHA512:
+  metadata.gz: aecb3d1339eb0d4ff45c68efaf5b3409af3b21c7c8b11e3ff4f86b008222365aa924a8324abac26b508d4babe762b17d1786f9a381540bf6beb4bd5d891b233f
+  data.tar.gz: 6b7d1068470fab054a277b35753d20c307a026696a009fa3bd01d9a42977f9037361fb1b10b1e1bb524e6f8b2fd7996d97ef1464315cc66e108df250c4592e33

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Ignore gem files
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,26 @@
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Max: 9
+
+Style/Documentation:
+  Enabled: false
+
+Style/GuardClause:
+  Enabled: false
+
+Style/For:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.8
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knife-oneandone.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2016 1&1 Internet SE
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,278 @@
+# Knife::Oneandone
+
+## Description
+
+1&1 Chef Knife plugin for managing 1&1 Cloud servers
+
+## Requirements
+
+* Chef 12.3.0 or higher
+* Ruby 2.1.x or higher
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'knife-oneandone'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knife-oneandone
+
+
+## Configuration
+
+The 1&1 Chef Knife plugin requires a valid 1&1 API key. Add your 1&1 API key in a ```knife.rb``` configuration file (for example in ```~/.chef/knife.rb```).
+
+```ruby
+knife[:oneandone_api_key] = '_YOUR_API_KEY_'
+```
+
+## Sub Commands
+
+The following sub-commands are available with the plugin:
+
+### knife oneandone appliance list
+
+Lists all server appliances.
+
+### knife oneandone datacenter list
+
+Lists all data centers.
+
+### knife oneandone firewall create
+
+Creates a new firewall policy.
+
+### knife oneandone firewall delete
+
+Deletes one or more firewall policies.
+
+### knife oneandone firewall list
+
+Lists available firewall policies.
+
+### knife oneandone ip list
+
+Lists allocated public IPs.
+
+### knife oneandone loadbalancer create
+
+Creates a new load balancer.
+
+### knife oneandone loadbalancer delete
+
+Deletes one or more load balancers.
+
+### knife oneandone loadbalancer list
+
+Lists available load balancers.
+
+### knife oneandone mp list
+
+Lists available monitoring policies.
+
+### knife oneandone server create
+
+Creates a new server.
+
+### knife oneandone server delete
+
+Deletes one or more servers.
+
+### knife oneandone server hdd add
+
+Adds one or more hard disks to server.
+
+### knife oneandone server hdd delete
+
+Removes server's hard disk.
+
+### knife oneandone server hdd list
+
+Lists server's hard disks.
+
+### knife oneandone server hdd resize
+
+Resizes server's hard disk.
+
+### knife oneandone server list
+
+Lists available servers.
+
+### knife oneandone server modify
+
+Modifies server's hardware configuration: CPU/cores count, RAM amount and/or fixed server size.
+
+### knife oneandone server reboot
+
+Reboots one or more servers.
+
+### knife oneandone server rename
+
+Updates server's name and/or description.
+
+### knife oneandone server size list
+
+Lists available fixed-server-size configurations.
+
+### knife oneandone server start
+
+Starts one or more servers.
+
+### knife oneandone server stop
+
+Stops one or more servers.
+
+## Usage
+
+Before deploying a server to your 1&1 Cloud environment, you may want set up a dedicated firewall policy or a load balancer for the server.
+
+To create a firewall policy and allow the access from any IP address:
+
+```
+knife oneandone firewall create -n my-firewall -p TCP,UDP,ICMP --port-from 80,161 --port-to 80,162
+```
+
+A load balancer can be created as follows:
+
+```
+knife oneandone loadbalancer create -n my-LB -m ROUND_ROBIN \
+  -p TCP,UDP --port-balancer 80,161 --port-server 8080,161
+```
+
+To restrict the access to a particular IP address or network, specify ```--source``` option for the load balancer and firewall policy. 
+
+**Note:** When multiple (firewall or load balancer) rules are specified, make sure that the protocols, ports and sources are separated by a comma and in the same order. In a firewall policy create command, specify GRE, ICMP and IPSEC protocols last, for instance 
+```--protocol TCP,TCP,UDP,TCP/UDP,GRE,ICMP,IPSEC```.
+
+
+Furthermore, use the list commands to find out IDs of the fixed-size configurations, server appliances, monitoring policies, existing IPs, data centers etc.
+
+```
+knife oneandone server size list
+ID                                Name  RAM (GB)  Processor No.  Cores per Processor  Disk Size (GB)
+65929629F35BBFBA63022008F773F3EB  M     1         1              1                    40
+591A7FEF641A98B38D1C4F7C99910121  L     2         2              1                    80
+E903FA4F907B5AAF17A7E987FFCDCC6B  XL    4         2              1                    120
+57862AE452473D551B1673938DD3DFFE  XXL   8         4              1                    160
+3D4C49EAEDD42FBC23DB58FE3DEF464F  S     0.5       1              1                    30
+6A2383038420110058C77057D261A07C  3XL   16        8              1                    240
+EED49B709368C3715382730A604E9F6A  4XL   32        12             1                    360
+EE48ACD55FEFE57E2651862A348D1254  5XL   48        16             1                    500
+```
+
+The format option may be used with the list commands to output JSON or yaml (e.g. ```-F json```, ```--format yaml```).
+
+
+To create a server, you can either specify a fixed-size ID or a flex configuration of the hardware.
+
+```
+knife oneandone server create -n Demo-Server \
+  --appliance-id  FF696FFE6FB96FC54638DB47E9321E25 \
+  --datacenter-id 5091F6D8CBFEF9C26ACE957C652D5D49 \
+  --fixed-size-id 65929629F35BBFBA63022008F773F3EB
+Deploying, wait for the operation to complete...
+        ID: D67F6B24C9C0AED76B8573D267B0EDAB
+        Name: Demo-Server
+        First IP: 109.228.53.48
+        First Password: Qc9knjVAK1
+done
+```
+
+```
+knife oneandone server create -n FS1 -I B5F778B85C041347BCDCFC3172AB3F3C -P 2 -C 1 -r 2 -H 40 -F yaml
+Deploying, wait for the operation to complete...
+---
+id: 341EB3FF15E861309C4D1C3BC6A8B17B
+cloudpanel_id: 23A0543
+name: FS1
+description: ''
+datacenter:
+  id: 908DC2072407C94C8054610AD5A53B8C
+  country_code: US
+  location: United States of America
+creation_date: '2016-08-05T12:26:27+00:00'
+first_password: Zf1jtd1WH9
+rsa_key: 0
+status:
+  state: POWERED_ON
+  percent:
+hardware:
+  fixed_instance_size_id:
+  vcore: 2
+  cores_per_processor: 1
+  ram: 2
+  hdds:
+  - id: 430C1E70E1737690E5A71F9D63BE80B2
+    size: 40
+    is_main: true
+image:
+  id: B5F778B85C041347BCDCFC3172AB3F3C
+  name: centos7-64std
+dvd:
+snapshot:
+ips:
+- id: DC9F635EA2B3144FC047532C6FD56B84
+  ip: 62.151.178.250
+  type: IPV4
+  reverse_dns:
+  firewall_policy:
+    id: A4D6302FA44955C797772E34880CBA42
+    name: centos7-64cpanel
+  load_balancers: []
+alerts: []
+monitoring_policy:
+private_networks:
+```
+
+To attach new hard disks to the server, specify a size for each new volume:
+
+```
+knife oneandone server hdd add 20 80 160 --server-id 341EB3FF15E861309C4D1C3BC6A8B17B
+```
+
+List the server disks in the following way:
+
+```
+knife oneandone server hdd list 341EB3FF15E861309C4D1C3BC6A8B17B
+ID                                Size (GB)  Main
+430C1E70E1737690E5A71F9D63BE80B2  40         true
+26D593F10CF0FE666004A594A08B5C0A  20         false
+602690CAA4BFE5724356148112918C79  80         false
+BA5486B5C0F1861307F80DEB880A4041  160        false
+```
+
+Specify the ID of any server you intend to start, stop, reboot or delete. The next example shows a delete operation 
+with auto-confirming all prompts for deletion.
+
+```
+knife oneandone server delete 341EB3FF15E861309C4D1C3BC6A8B17B D67F6B24C9C0AED76B8573D267B0EDAB -y
+```
+
+## Development
+
+After checking out the repository, run `bundle install` to install dependencies.
+
+Use the bundler to run the tests. Declare ONEANDONE_API_KEY environment variable before running the tests.
+
+    $ export ONEANDONE_API_KEY="_YOUR_API_KEY_"
+    $ bundle exec rspec
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+1. Fork the repository (`https://github.com/1and1/oneandone-cloudserver-chef/fork`).
+2. Create a new feature branch (`git checkout -b my-new-feature`).
+3. Commit the changes (`git commit -am 'New feature description'`).
+4. Push to the branch (`git push origin my-new-feature`).
+5. Create a new pull request.
+
+Bug reports and pull requests are welcome.