knife-clc 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97c31a07e22d6dadf6bdfa8ab6707c349a68b913
+  data.tar.gz: 77bb79351906757778b74a98baf4039fd2bc5ce5
+SHA512:
+  metadata.gz: bef4cf732c524b397ea546d49b5c61c552cc2d8b50c3a50764a708f80c02b24e118e4691a01a1ecb9483b1250a277b62274ec6a2aeef7270dd407fb8cd3da863
+  data.tar.gz: 998b3be79cce601c3cb8bc84b330668e76c2ba51be40893fb71cc24ab8c96965de197746d492ecc17d1fab219fb0fac4687cee534b942c706ceeae97f002e0fe

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 {yyyy} {name of copyright owner}
+
+   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,295 @@
+[![Build Status](https://travis-ci.com/CenturyLinkCloud/clc-knife.svg?branch=master&token=LhLVx9NS1UaceLVeEbZK)](https://travis-ci.com/CenturyLinkCloud/clc-knife)
+
+# Knife CLC
+
+This is the Chef Knife plugin for CenturyLink Cloud. It gives Knife the ability to manage servers and query for additional resources like datacenters, templates and groups.
+
+## Installation
+
+If you're using [ChefDK](https://downloads.chef.io/chef-dk/), simply install the Gem:
+
+```bash
+$ chef gem install knife-clc
+```
+
+If you're using Bundler, add this line to your application's Gemfile:
+
+```ruby
+gem 'knife-clc'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install knife-clc
+```
+
+## Configuration
+In order to use CLC API, user must supply API username & password. This can be done in several ways:
+
+### knife.rb
+Credentials can be specified in [knife.rb](https://docs.chef.io/config_rb_knife.html) file:
+
+```ruby
+knife[:clc_username] = "CLC API Username"
+knife[:clc_password] = "CLC API Password"
+```
+
+Note: If your `knife.rb` file will be checked into a source control management system, or will be otherwise accessible by others, you may want to use one of the other configuration methods to avoid exposing your credentials.
+
+### ENV & knife.rb
+It is also possible to specify credentials as environment variables. Here's an example:
+
+```ruby
+knife[:clc_username] = ENV['CLC_USERNAME']
+knife[:clc_password] = ENV['CLC_PASSWORD']
+```
+
+Note that since most CLC tools use the same set of ENV variables, plugin would read `CLC_USERNAME` and `CLC_PASSWORD` variables automatically if no other options were specified in `knife.rb`.
+
+### CLI Arguments
+If you prefer to specify credentials on per-command basis, you can do it with CLI arguments:
+
+```bash
+$ knife clc datacenter list \
+--username 'api_username' \ 
+--password 'api_password'
+```
+
+## Advanced Configuration
+In order to speed up your workflow, you can specify some defaults for every command option in `knife.rb`. Since `knife.rb` is basically a Ruby file, we use `snake_case` notation there. Also, we prefix CLC options with `clc_`. It means that `--source-server` turns into `clc_source_server`:
+
+```ruby
+knife[:clc_name] = 'QAEnv'
+knife[:clc_description] = 'Automatic UI testing node'
+knife[:clc_group] = '675b79g94b84122ea1c920111967a33c'
+knife[:clc_source_server] = 'DEBIAN-7-64-TEMPLATE'
+knife[:clc_cpu] = 2
+knife[:clc_memory] = 2
+```
+Options like `--disk`, `--custom-field`, `--package` can be specified several times. In configuration file they will look like an Array with plural config option name:
+
+```ruby
+knife[:clc_custom_fields] = [
+  'KEY=VALUE', 
+  'ANOTHER=VALUE'
+]
+
+knife[:clc_disks] = [
+  '/dev/sdb,10,raw'
+]
+```
+
+## Supported Commands
+This plugin provides the following Knife subcommands. Specific command options can be found by invoking the subcommand with a `--help` flag:
+
+* [knife clc datacenter list (options)](#knife-clc-datacenter-list)
+* [knife clc group create (options)](#knife-clc-group-create)
+* [knife clc group list (options)](#knife-clc-group-list)
+* [knife clc ip create (options)](#knife-clc-ip-create)
+* [knife clc ip delete IP (options)](#knife-clc-ip-delete)
+* [knife clc operation show ID (options)](#knife-clc-operation-show)
+* [knife clc server create (options)](#knife-clc-server-create)
+* [knife clc server delete ID (options)](#knife-clc-server-delete)
+* [knife clc server list (options)](#knife-clc-server-list)
+* [knife clc server power_off ID (options)](#knife-clc-server-power_off)
+* [knife clc server power_on ID (options)](#knife-clc-server-power_on)
+* [knife clc server reboot ID (options)](#knife-clc-server-reboot)
+* [knife clc server show ID (options)](#knife-clc-server-show)
+* [knife clc template list (options)](#knife-clc-template-list)
+
+Note that some commands provide an access to long-running cloud operations. These commands are **asynchronous** by default (they don't wait for completion and return some output immediately). All of them support `--wait` option which makes command to wait until operation is completed or failed.
+
+Several types of resources are **scoped by datacenter** they reside in. Commands querying for these resources support `--datacenter ID` option. Some of them support `--all` option to return all resources from all datacenters (which is much slower).
+
+Also, resources like ip addresses are **scoped by server** they belong to. Related commands require `--server ID` option.
+
+### `knife clc datacenter list`
+Outputs list of all available CLC datacenters.
+
+```bash
+$ knife clc datacenter list
+```
+
+### `knife clc group create`
+Creates a child group for specified parent. Unlike other modification operations, that command is synchronous and does not support `--wait` flag.
+
+```bash
+$ knife clc group create --name 'Custom Group' \
+--description 'Manual Test Group' \
+--parent bcda7f994b844521111920325qrta33c
+```
+
+### `knife clc group list`
+**Scoped by datacenter**. Outputs list of datacenter groups. By default, reflects logical group structure as a tree. Supports `--view` option with values `table` and `tree`.
+
+```
+$ knife clc group list --datacenter ca1 --view table
+```
+
+### `knife clc ip create`
+**Asynchronous**. **Scoped by server**. Assigns a public IP to specified server. Applies passes protocol and source restrictions. While CLC API supports TCP, UDP and ICMP permissions only, this command provides several useful aliases to most ofthen used protocols: `ssh`, `sftp`, `ftp`, `http`, `https`, `ftp`, `ftps`. Same options can be provided during server creation.
+
+```bash
+$ knife clc ip create --server ca1altdqasrv01 \
+--allow tcp:66-67 \
+--allow udp:68 \
+--allow icmp \
+--allow ssh \
+--allow http \
+--allow ftp \
+--source 10.0.0.0/32 \
+--source 172.0.0.0/32 \
+--wait
+```
+
+### `knife clc ip delete`
+**Asynchronous**. **Scoped by server**. Deletes previously assigned public IP of the server.
+
+```bash
+$ knife clc ip delete 65.39.184.23 --server ca1altdqasrv01 --wait
+```
+
+### `knife clc operation show`
+**Asynchronous**. Outputs current operation status. User can use `--wait` flag to wait for operation completion. Operation IDs are usually printed by other asynchronous commands when they are executed without `--wait` option.
+
+```bash
+$ knife clc operation show ca1-43089 --wait
+```
+
+### `knife clc server create`
+**Asynchronous**. Launches a server using specified parameters. It is recommended to allow SSH/RDP access to the server if user plans to use it from external network later.
+
+```bash
+$ knife clc server create --name 'QASrv' \
+--group 675b79g94b84122ea1c920111967a33c \
+--source-server DEBIAN-7-64-TEMPLATE \
+--cpu 1 \
+--memory 1 \
+--type standard \
+--allow icmp \
+--allow ssh \
+--wait
+```
+
+Command supports `--bootstrap` flag which allows to connect launched machine to your Chef Server installation. Only **Linux** platform is supported.
+
+Async bootstrap variant does not require public IP access to the machine. Chef Server credentials and other parameters will be sent to the server. They will be used by Chef Client installation script during launch. Note that bootstrapping errors cancel launch operation.
+
+```bash
+$ knife clc server create --name 'QASrv' \
+--group 675b79g94b84122ea1c920111967a33c \
+--source-server DEBIAN-7-64-TEMPLATE \
+--cpu 1 \
+--memory 1 \
+--type standard \
+--bootstrap \
+--run-list recipe[chef-client] \
+--tags one,two,three
+```
+
+Sync bootstrap is very similar to bootstrap from other Knife plugins. It requires SSH connection to the server. Note that plugin will refuse to launch a server unless public IP with SSH access is requested. Example for custom SSH port:
+
+```bash
+$ knife clc server create --name 'QASrv' \
+--group 675b79g94b84122ea1c920111967a33c \
+--source-server DEBIAN-7-64-TEMPLATE \
+--cpu 1 \
+--memory 1 \
+--type standard \
+--allow tcp:55 \
+--bootstrap \
+--ssh-port 55 \
+--run-list recipe[chef-client] \
+--tags one,two,three \
+--no-host-key-verify \
+--wait
+```
+
+It is also possible to bootstrap a machine without public IP. If there's a machine with opened SSH access and it belongs to the same network, it can be used as a SSH gateway via `--ssh-gateway` option. Another way is to run Knife plugin inside of the network with `--bootstrap-private` flag to skip public IP checks.
+
+```bash
+$ knife clc server create --name 'QASrv' \
+--group 675b79g94b84122ea1c920111967a33c \
+--source-server DEBIAN-7-64-TEMPLATE \
+--cpu 1 \
+--memory 1 \
+--type standard \
+--bootstrap \
+--bootstrap-private \
+--run-list recipe[chef-client] \
+--tags one,two,three \
+--no-host-key-verify \
+--wait
+```
+
+### `knife clc server delete`
+**Asynchronous**. Deletes an existing server by its ID. Note that Chef Server objects (if there are any) are left intact.
+
+```bash
+$ knife clc server delete ca1altdqasrv01 --wait
+```
+
+### `knife clc server list`
+**Scoped by datacenter**. Outputs a list of all servers in specified datacenter. Can be used with `--chef-nodes` option to add `Chef Node` column. Servers managed by Chef Server will have their node names there. Note that Chef API credentials are required for this to work. Supports `--all` option.
+
+```bash
+$ knife clc server list --datacenter ca1 --chef-nodes
+```
+
+### `knife clc server power_off`
+**Asynchronous**. Turns server power off. Note that all SSH/RDP sessions will be forcibly closed.
+
+```bash
+$ knife clc server power_off ca1altdqasrv01 --wait
+```
+
+### `knife clc server power_on`
+**Asynchronous**. Turns server power on. The server will be available for connections after operation is completed.
+
+```bash
+$ knife clc server power_off ca1altdqasrv01 --wait
+```
+
+### `knife clc server reboot`
+**Asynchronous**. Performs OS-level reboot on the server. All applications will be requested to finish current tasks and close.
+
+```bash
+$ knife clc server reboot ca1altdqasrv01 --wait
+```
+
+### `knife clc server show`
+Outputs details for specified server ID. Supports `--uuid` flag to interpret primary argument as UUID. By default, does not show server credentials and opened ports. User may request more information with `--creds` and `--ports` options. Requesting additional information slows command down.
+
+```bash
+$ knife clc server show 406282c5116443029576a2b9ac56f5cc \
+--uuid \ 
+--creds
+
+$ knife clc server show ca1altdqasrv01 --ports
+```
+
+### `knife clc template list`
+**Scoped by datacenter**. Outputs available server templates. Supports `--all` option.
+
+```bash
+$ knife clc template list --datacenter ca1
+```
+
+## Contributing
+
+1. Fork it [https://github.com/CenturyLinkCloud/clc-knife/fork](https://github.com/CenturyLinkCloud/clc-knife/fork)
+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 a new Pull Request
+6. Specs and Code Style checks should pass before Code Review.
+
+## License
+The project is licensed under the [Apache License v2.0](http://www.apache.org/licenses/LICENSE-2.0.html).

data/lib/chef/knife/clc_base.rb

@@ -0,0 +1,71 @@
+require 'knife-clc/version'
+require 'hirb'
+require 'clc'
+
+class Chef
+  class Knife
+    module ClcBase
+      def self.included(klass)
+        klass.class_eval do
+          option :clc_username,
+            :long => '--username NAME',
+            :description => 'Name of the user to access CLC API',
+            :on => :head
+
+          option :clc_password,
+            :long => '--password PASSWORD',
+            :description => 'Password for CLC user account',
+            :on => :head
+
+          option :clc_endpoint,
+            :long => '--endpoint URL',
+            :description => 'Alternative CLC API URL',
+            :on => :head
+
+          def connection
+            @connection ||= ::Clc::Client.new(
+              :username => config[:clc_username],
+              :password => config[:clc_password],
+              :endpoint => config[:clc_endpoint],
+              :verbosity => config[:verbosity]
+            )
+          end
+
+          attr_writer :context
+
+          def context
+            @context ||= {}
+          end
+
+          def run
+            $stdout.sync = true
+
+            parse_and_validate_parameters
+
+            if errors.any?
+              show_errors
+              show_usage
+              exit 1
+            else
+              execute
+            end
+          end
+
+          def parse_and_validate_parameters
+          end
+
+          def execute
+          end
+
+          def errors
+            @errors ||= []
+          end
+
+          def show_errors
+            errors.each { |message| ui.error message }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/clc_datacenter_list.rb

@@ -0,0 +1,35 @@
+require 'chef/knife/clc_base'
+
+class Chef
+  class Knife
+    class ClcDatacenterList < Knife
+      include Knife::ClcBase
+
+      banner 'knife clc datacenter list (options)'
+
+      def execute
+        context[:datacenters] = connection.list_datacenters
+        render
+      end
+
+      def fields
+        %w(name id)
+      end
+
+      def headers
+        {
+          'name' => 'Name',
+          'id' => 'ID'
+        }
+      end
+
+      def render
+        ui.info Hirb::Helpers::AutoTable.render(context[:datacenters],
+          :fields => fields,
+          :headers => headers,
+          :resize => false,
+          :description => false)
+      end
+    end
+  end
+end