knife-awscleaner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8568d4e9549f0a2d5afb84c0a9e1648d5135164b
+  data.tar.gz: 1d6f82b6d0f258b75a27cf33395780c5554c21c0
+SHA512:
+  metadata.gz: a44a465e0f935e82366452ca972222ff11951c658b29d6d686ca33d7de635e5b02e99b4df1ebd33ba9cb1aafb16e0481396cd9847629c57c476864c289f4e101
+  data.tar.gz: feac34a8aa74d0a6a3d88640ff1690f07173da6803ed447bec94c1587ee0b9958d0c5f853ef3d08df9a5102df2517da644ee636fe282006407f1c817bcf687dd

data/LICENSE

@@ -0,0 +1,175 @@
+                              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.
+

data/README.md

@@ -0,0 +1,29 @@
+# Knife AWS Cleaner
+
+## DESCRIPTION:
+
+This is a knife plugin to clean up old nodes and clients no longer found in a set of AWS accounts
+
+## INSTALLATION:
+
+    gem install knife-awscleaner
+
+## USAGE:
+
+## LICENSE
+
+Author:: Paul Mooring (paul@chef.io)
+Copyright:: Copyright (c) 2016, Chef Software, Inc.
+License:: Apache License, Version 2.0
+
+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/lib/chef/knife/awscleaner.rb

@@ -0,0 +1,143 @@
+# Author:: Paul Mooring <paul@opscode.com>
+# Copyright:: Copyright (c) 2016, Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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.
+#
+
+module KnifeAwscleaner
+  # This class definies all the logic
+  class Awscleaner < Chef::Knife
+    banner 'knife awscleaner [options]'
+
+    # Don't lazy load or you'll get an error
+    require 'chef/search/query'
+    # Do lazy load this stuff
+    deps do
+      require 'aws-sdk'
+    end
+
+    option :profiles,
+           short: '-p PROFILES',
+           long: '--profiles PROFILES',
+           description: 'Profile name and regions for AWS accounts',
+           proc: proc { |profiles|
+             profiles.split(';').map do |p|
+               p.split(',')
+             end
+           },
+           default: [{ 'default' => 'us-east-1' }]
+
+    option :safe_mode,
+           short: '-S',
+           long: '--safe',
+           description: 'Display what would be deleted, without deleting',
+           boolean: true,
+           default: false
+
+    option :remove_never_rans,
+           short: '-N',
+           long: '--never-rans',
+           description: 'Delete non-AWS nodes that have never ran',
+           boolean: true,
+           default: false
+
+    def aws_instances
+      AwsAccounts.new(config[:profiles]).all_instances
+    end
+
+    def aws_nodes
+      Chef::Search::Query.new.search(
+        :node,
+        'ec2:*',
+        filter_result: {
+          node_name: ['name'],
+          instance_id: %w(ec2 instance_id),
+          ohai_time: ['ohai_time']
+        }
+      )
+    end
+
+    def non_aws_nodes
+      Chef::Search::Query.new.search(
+        :node,
+        'NOT ec2:*',
+        filter_result: {
+          node_name: ['name'],
+          ohai_time: ['ohai_time']
+        }
+      )
+    end
+
+    def dead_aws_nodes
+      missing_nodes = []
+
+      actual_instances = aws_instances
+      aws_nodes.first.each do |nd|
+        unless actual_instances.include? nd['instance_id']
+          missing_nodes << nd
+        end
+      end
+
+      missing_nodes
+    end
+
+    def run
+      if config[:safe_mode]
+        puts 'Running in safe mode, these nodes would be deleted:'
+      end
+      dead_aws_nodes.each do |node|
+        if config[:safe_mode]
+          last_run = Time.at(node['ohai_time'])
+          puts "Node Name: #{node['node_name']}"
+          puts "    Instance ID: #{node['instance_id']}"
+          puts "    Last Run: #{last_run}"
+
+          next unless config[:remove_never_rans]
+        end
+
+        delete_object(Chef::Node, node['node_name'])
+        delete_object(Chef::ApiClientV1, node['node_name'])
+      end
+
+      non_aws = non_aws_nodes
+      puts 'Found non-AWS nodes:' unless non_aws.empty?
+      non_aws_nodes.first.each do |node|
+        last_run = node['ohai_time'].nil? ? 'never' : Time.at(node['ohai_time'])
+        puts "Node Name: #{node['node_name']}"
+        puts "    Last Run: #{last_run}"
+      end
+    end
+  end
+
+  # AwsAccounts abstracts the AWS connection and query logic
+  class AwsAccounts
+    def initialize(profiles)
+      @accounts = []
+      profiles.each do |profile|
+        @accounts << Aws::EC2::Resource.new(
+          region: profile[1],
+          credentials: Aws::SharedCredentials.new(profile_name: profile[0])
+        )
+      end
+    end
+
+    def all_instances
+      all_instanaces = []
+
+      @accounts.each do |acct|
+        all_instanaces += acct.instances.map(&:instance_id)
+      end
+    end
+  end
+end

data/lib/knife-awscleaner/version.rb

@@ -0,0 +1,5 @@
+# knife-plugin module for awscleaner
+module KnifeAwscleaner
+  VERSION = '0.0.1'.freeze
+  MAJOR, MINOR, TINY = VERSION.split('.')
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: knife-awscleaner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paul Mooring
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.0.0
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Cleans up nodes not found in provided AWS accounts
+email:
+- paul@chef.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/chef/knife/awscleaner.rb
+- lib/knife-awscleaner/version.rb
+homepage: https://github.com/paulmooring/knife-awscleaner
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Cleans up nodes not found in provided AWS accounts
+test_files: []