knife-topo 0.0.11 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8793bcf153624c108933962031fa78522ad5a92
-  data.tar.gz: ccb909fe254ec685604d94a36bdacb342be00ae0
+  metadata.gz: 619e9151cea8acad0dfa7f85237ba3fd5da2c1b5
+  data.tar.gz: ba63cad394ff705eed82414025ba1b016de444cd
 SHA512:
-  metadata.gz: e0fcdc312e8574d8dd7575ac1a22c9115fd2ea1e24235b92752bf1b6f4939f08d4ccdfb9078aa00ea1b46bbb4eb94d577afbb633e3f742dd2e0997daa954a7bd
-  data.tar.gz: fd58817d5fd0479352bcabcaa390086fd61504dc797ed6266fafd29b4c2683419a1237ea28c20bcec2390644599cd071d073ffda1f078aa40eebaae1caa49c25
+  metadata.gz: 14d7c03dc1fa49c70c074a1fa2e19ab35ad4e5e9369f895eccc34a5b3fd08fab574423387a4b236f6380d9292a0928735f30c6f65848caaaa0dc87fb02ea8c1e
+  data.tar.gz: 1ec1fc82d300e4d8973fddd3684f11f9e46808554a04751375352ffc652a62d0542d4a04d745f7b79fb17bbbdfc5944c79ae64c5153687c9a59991e222386ec1

data/README.md

@@ -22,8 +22,8 @@ topologies but differences in their configuration details.
 [Download the latest knife-topo release](http://github.com/christinedraper/knife-topo/releases/latest), 
 unzip and copy `lib/chef/knife` into your plugin directory, e.g.:
 
-	$ unzip knife-topo-0.0.10.zip -d ~
-	$ cd ~/knife-topo-0.0.10
+	$ unzip knife-topo-0.0.12.zip -d ~
+	$ cd ~/knife-topo-0.0.12
 	$ mkdir -p ~/.chef/plugins/knife
 	$ cp lib/chef/knife/* ~/.chef/plugins/knife
 
@@ -59,7 +59,7 @@ Try out this plugin using a [test-repo](test-repo) provided in the knife-topo gi
 [Download the latest knife-topo release](http://github.com/christinedraper/knife-topo/releases/latest)
 and unzip it, then follow the [Instructions](test-repo/Instructions.md) for the example.
 
-The instructions assume you have [chefDK](http://www.getchef.com/downloads/chef-dk/)
+The instructions assume you have [chefDK](https://downloads.chef.io/chef-dk/)
  or equivalent installed and working with Vagrant and VirtualBox, but
  none of these are requirements to use the knife-topo plugin. 
  
@@ -225,13 +225,14 @@ workflow:
 * [knife topo cookbook create](#cookbook-create) - Generate the topology cookbooks
 * [knife topo cookbook upload](#cookbook-upload) - Upload the topology cookbooks
 * [knife export](#export) - Export data from a topology (or from nodes that you want in a topology)
+* [knife topo list](#list) - List the topologies
+* [knife topo search](#search) - Search for nodes that are in a topology, or in no topology
+* [knife topo delete](#delete) - Delete a topology, but not the nodes in the topology
 
 The topologies are data bag items in the 'topologies' data bag, so 
 you can also use knife commands such as:
 
-* `knife data bag show topologies` - List the topologies
-* `knife data bag show topologies test1` - Show details of the test1 topology
-* `knife data bag delete topologies test1` - Delete the test1 topology 
+* `knife data bag show topologies test1` - Show details of the test1 topology data bag
 
 ### Common Options:
 
@@ -338,6 +339,14 @@ or upload topology cookbooks.
 
 $ knife topo create test1 --disable-upload
 
+## knife topo delete <a name="delete"></a>
+
+	knife topo delete TOPOLOGY
+
+Deletes the specified topology. Does not delete the nodes in the topology, but does
+remove them from the topology by removing the `['topo']['name']` attribute 
+which is used by `knife topo search`.
+
 ## knife topo export <a name="export"></a>
 
 	knife topo export [ TOPOLOGY [ NODE ... ] 
@@ -375,6 +384,7 @@ The following will create an outline for a new topology called  'christine_test'
 	$ knife topo export christine_test > christine_test.json
 
 
+
 ## knife topo import <a name="import"></a>
 
 	knife topo import [ TOPOLOGY_FILE [ TOPOLOGY ... ]] 
@@ -395,6 +405,48 @@ The following will import the 'test1' topology
 
 	$ knife topo import topology.json test1
 
+## knife topo list <a name="list"></a>
+
+	knife topo list
+
+Lists the topologies that have been created on the server.
+
+## knife topo search <a name="search"></a>
+
+	knife topo search [ QUERY ]
+  
+Searches for nodes that are in a topology and satisfy the query. With no options,
+this searches for nodes in any topology. Use `--topo=topo_name` to search
+within a specific topology. Use `--no-topo` to search for nodes in no topology.
+
+`knife topo search` uses the `['topo']['name']` attribute to identify which nodes 
+are in which topology.
+  
+### Examples:
+
+The following will search for nodes in any topology that have a name starting with "tst".
+
+	$ knife topo search "name:tst*"
+  
+The following will search for nodes in the "prod" chef environment that are not in a topology.
+
+	$ knife topo search "chef_environment:prod" --no-topo
+  
+The following will search for all nodes in the "systest" topology.
+
+	$ knife topo search --topo=systest
+  
+### Options:
+
+The knife topo search subcommand supports the following additional options.
+
+Option        | Description
+------------  | -----------
+--topo    | Search for nodes in the specified topology
+--no-topo | Search for nodes that are not in any topology
+See [knife search](http://docs.chef.io/knife_search.html)  | Options supported by `knife search` are passed through to the search command
+
+
 ## knife topo update <a name="update"></a>
 
 	knife topo update [ TOPOLOGY ] 
@@ -409,7 +461,7 @@ will be updated.
 Option        | Description
 ------------  | -----------
 --bootstrap    | Bootstrap the topology (see [topo bootstrap](#bootstrap))
-See [knife bootstrap](http://docs.opscode.com/knife_bootstrap.html)  | Options supported by `knife bootstrap` are passed through to the bootstrap command
+See [knife bootstrap](http://docs.chef.io/knife_bootstrap.html)  | Options supported by `knife bootstrap` are passed through to the bootstrap command
 --disable-upload   | Do not upload topology cookbooks
 
 ### Examples:
@@ -426,7 +478,7 @@ The following will update all topologies in the 'topologies' data bag.
 
 Author:: Christine Draper (christine_draper@thirdwaveinsights.com)
 
-Copyright:: Copyright (c) 2014 ThirdWave Insights, LLC
+Copyright:: Copyright (c) 2014-2015 ThirdWave Insights, LLC
 
 License:: Apache License, Version 2.0
 

data/knife-topo.gemspec

@@ -8,11 +8,13 @@ Gem::Specification.new do |spec|
   spec.version       = Knife::Topo::VERSION
   spec.authors       = ["Christine Draper"]
   spec.email         = ["christine_draper@thirdwaveinsights.com"]
-  spec.summary       = "Knife plugin that to manage topologies of nodes"
-  spec.description   = spec.summary
+  spec.summary       = "Knife plugin to manage topologies of nodes"
+  spec.description   = "Knife-topo uses a JSON file to capture a topology of nodes, which can be loaded into Chef and bootstrapped"
   spec.homepage      = "https://github.com/christinedraper/knife-topo"
   spec.license       = "Apache License (2.0)"
   
+  spec.add_runtime_dependency 'chef', '>=11.8',  '<13.0'
+  
   spec.files         = Dir.glob("{lib}/**/*")  +
     ['LICENSE', 'README.md', __FILE__]
   spec.require_paths = ["lib"]

data/lib/chef/knife/topo/version.rb

@@ -1,5 +1,5 @@
 module Knife
   module Topo
-    VERSION = "0.0.11"
+    VERSION = "0.1.1"
   end
 end

data/lib/chef/knife/topo_cookbook_upload.rb

@@ -76,7 +76,7 @@ class Chef
           end
           run_cmd(Chef::Knife::CookbookUpload, @topo_upload_args)
         else
-          ui.info("No cookbooks found for topology #{display_name[topo]}")
+          ui.info("No cookbooks found for topology #{display_name(topo)}")
         end                      
       end
 

data/lib/chef/knife/topo_delete.rb

@@ -0,0 +1,96 @@
+#
+# Author:: Christine Draper (<christine_draper@thirdwaveinsights.com>)
+# Copyright:: Copyright (c) 2014 ThirdWave Insights LLC
+# 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.
+#
+
+require 'chef/knife'
+require_relative 'topology_helper'
+
+class Chef
+  class Knife
+    class TopoDelete < Chef::Knife
+
+      deps do
+        require 'chef/data_bag'
+      end
+
+      banner "knife topo delete TOPOLOGY (options)"
+
+      option :data_bag,
+      :short => '-D DATA_BAG',
+      :long => "--data-bag DATA_BAG",
+      :description => "The data bag the topologies are stored in"
+ 
+
+      def run
+
+        topo_bag = topo_bag_name(config[:data_bag])
+        @topo_name = @name_args[0]
+          
+        if @name_args.length == 1
+          
+          # remove each node
+          
+          unless topo = load_from_server(topo_bag, @topo_name)
+            ui.info "Topology #{topo_bag}/#{@topo_name} does not exist on server"
+            exit(0)
+          end
+          
+          confirm("Do you want to delete topology #{@topo_name} - this does not delete nodes")
+          
+          topo['nodes'].each do | node |
+            remove_node_from_topology(node['name'])
+          end if topo['nodes']
+          
+          # delete the data bag item
+          topo.destroy(topo_bag, @topo_name)
+
+          ui.info "Deleted topology #{@topo_name}"
+        else
+          show_usage
+          ui.fatal("You must specify a topology name")
+          exit 1
+        end
+       end
+       
+      # Remove the topo name attribute from all nodes, so topo search knows they are not in the topology
+      def remove_node_from_topology(node_name)
+      
+        config[:disable_editing] = true      
+        begin
+          
+          # load then update and save the node
+          node = Chef::Node.load(node_name)
+          
+          if node.normal['topo'] && node.normal['topo']['name'] == @topo_name
+            node.normal['topo'].delete('name') 
+            ui.info "Removing node #{node.name} from topology"
+            node.save
+          end
+  
+        rescue Net::HTTPServerException => e
+          raise unless e.to_s =~ /^404/
+          # Node has not been created
+        end
+        
+        return node
+      end
+      
+      include Chef::Knife::TopologyHelper
+
+    end
+  end
+end

data/lib/chef/knife/topo_list.rb

@@ -0,0 +1,48 @@
+#
+# Author:: Christine Draper (<christine_draper@thirdwaveinsights.com>)
+# Copyright:: Copyright (c) 2014 ThirdWave Insights LLC
+# 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.
+#
+
+require 'chef/knife'
+require_relative 'topology_helper'
+
+class Chef
+  class Knife
+    class TopoList < Chef::Knife
+
+      deps do
+        require 'chef/data_bag'
+      end
+
+      banner "knife topo list (options)"
+
+      option :data_bag,
+      :short => '-D DATA_BAG',
+      :long => "--data-bag DATA_BAG",
+      :description => "The data bag the topologies are stored in"
+ 
+
+      def run
+
+        topo_bag = topo_bag_name(config[:data_bag])
+        output(format_list_for_display(Chef::DataBag.load(topo_bag)))
+
+      end
+      
+      include Chef::Knife::TopologyHelper
+    end
+  end
+end

data/lib/chef/knife/topo_search.rb

@@ -0,0 +1,93 @@
+#
+# Author:: Christine Draper (<christine_draper@thirdwaveinsights.com>)
+# Copyright:: Copyright (c) 2014 ThirdWave Insights LLC
+# 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.
+#
+
+require_relative 'topology_helper'
+require 'chef/knife/search'
+
+class Chef
+  class Knife
+    class TopoSearch < Chef::Knife::Search
+
+      banner "knife topo search [ QUERY ] (options)"
+      
+      option :topo,
+      :long => "--topo TOPOLOGY",
+      :description => "Restrict search to nodes in the specified topology"
+      
+      option :no_topo,
+      :long => "--no-topo",
+      :description => "Restrict search to nodes that are not in any topology",
+      :boolean => true,
+      :default => true
+
+      # Make the base search options available on topo search
+      self.options = (Chef::Knife::Search.options).merge(self.options)
+
+      def initialize (args)
+        super
+        topo_query = constrain_query(@name_args[0] || config[:query], config[:topo], !config[:no_topo].nil?)
+
+        # force a node search
+        @name_args[0] = "node"
+
+        # override any query 
+        if config[:query]
+          config[:query] = topo_query
+        else
+          @name_args[1] = topo_query          
+        end
+
+      end
+
+      def run
+        begin
+          super
+        rescue Exception => e
+          raise if Chef::Config[:verbosity] == 2
+          ui.error "Topology search for \"#{@query}\" exited with error"
+          humanize_exception(e)
+        end
+      end
+
+      private
+
+      include Chef::Knife::TopologyHelper
+      
+      def constrain_query(query, topo_name, no_topo)
+        
+        # group existing query
+        # workaround for strange behavior with NOTs and invalid query if put brackets round them
+        group_query = query && !query.start_with?("NOT") ? "(#{query})" : query
+        
+        # search specific topologies or all/none
+        constraint = (topo_name) ? "topo_name:" + topo_name : "topo_name:*" 
+        
+        # combine the grouped query and constraint
+        if no_topo
+          result = query ? "#{group_query} NOT #{constraint}" : "NOT #{constraint}"
+        else
+          result = query ? "#{constraint} AND #{group_query}" : constraint
+        end
+        
+        result
+      end
+      
+       
+    end
+  end
+end

data/lib/chef/knife/topology_helper.rb

@@ -107,6 +107,8 @@ class Chef
             normal_defaults = topo_hash['normal'] ? topo_hash['normal'].clone : {}
             nodeprops['normal'] ||= {}
             nodeprops['normal'] = prop_merge!(normal_defaults, nodeprops['normal'])
+            nodeprops['normal'] = prop_merge!(nodeprops['normal'], nodeprops['attributes']) if nodeprops['attributes']
+            nodeprops['normal']  = prop_merge!(nodeprops['normal'], { "topo" => { "name" => topo_hash['name'] }})
 
             nodeprops['chef_environment'] ||=  topo_hash['chef_environment'] if topo_hash['chef_environment']
 

metadata

@@ -1,16 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: knife-topo
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.1
 platform: ruby
 authors:
 - Christine Draper
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-01 00:00:00.000000000 Z
-dependencies: []
-description: Knife plugin that to manage topologies of nodes
+date: 2015-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '11.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Knife-topo uses a JSON file to capture a topology of nodes, which can
+  be loaded into Chef and bootstrapped
 email:
 - christine_draper@thirdwaveinsights.com
 executables: []
@@ -25,8 +46,11 @@ files:
 - lib/chef/knife/topo_cookbook_create.rb
 - lib/chef/knife/topo_cookbook_upload.rb
 - lib/chef/knife/topo_create.rb
+- lib/chef/knife/topo_delete.rb
 - lib/chef/knife/topo_export.rb
 - lib/chef/knife/topo_import.rb
+- lib/chef/knife/topo_list.rb
+- lib/chef/knife/topo_search.rb
 - lib/chef/knife/topo_update.rb
 - lib/chef/knife/topology_helper.rb
 homepage: https://github.com/christinedraper/knife-topo
@@ -52,6 +76,6 @@ rubyforge_project:
 rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
-summary: Knife plugin that to manage topologies of nodes
+summary: Knife plugin to manage topologies of nodes
 test_files: []
 has_rdoc: