knife-ec2 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 902fa10935b516871981f149f29fe37890bfd3a3
-  data.tar.gz: 84519150709c6e46de97de7cbd1be1100bad8c50
+  metadata.gz: 734b0e6c5929ce79f6ddf8a829920e8789fa3e8c
+  data.tar.gz: abcebcb7e4ae42eef0051b0aa505bc89c4d72873
 SHA512:
-  metadata.gz: c66211a3338d6ef2ff6c954c33dbb85f71b82faf8e625f0c07bf27f9f73e5d5c599dadf798b56e09ce1ec27ce8e8fd37cb346f78369bd843c7face475325b24a
-  data.tar.gz: d0d18e02338ffb8007b6b6ee6c3d8f280adfa2fd1b5c2b22109ea335ae132f9fa47fe0c9eae117fece8b6b86f141a7aa72b0126b36fdb7f0e4cee352f232e8a8
+  metadata.gz: dafdfbaf8f511db58a17e0bc519ffeae58be4805247068aecf73e3f4d67ab7a5fcc8fb681450e0d4515171e557cd294375477fb72d51928943872e0f8b0518e4
+  data.tar.gz: 1ecf06ea19040b5b893e4d987b5049e0c87549b63447161bcf08507275ecdc5e0333fa4f6b98ef0d5b24e6404f141e709c217cce82226c1f105311b68ee98211

data/CHANGELOG.md

@@ -5,12 +5,15 @@ Note: this log contains only changes from knife-ec2 release 0.8.0 and later
 prior to release 0.8.0, please visit the [source repository](https://github.com/chef/knife-ec2/commits).
 
 
-## Latest Release 0.17.0 (2018-02-07)
+## Latest Release 0.18.0 (2018-04-05)
+* [knife-ec2:#520](https://github.com/chef/knife-ec2/pull/520) Options `--aws-tag` and `--chef-tag` are added for tagging EC2 instance in AWS and Chef separately.
+
+## Release 0.17.0 (2018-02-07)
 * [knife-ec2:#515](https://github.com/chef/knife-ec2/pull/515) Allow re-use of existing ENI for primary interface.
 * [knife-ec2:#514](https://github.com/chef/knife-ec2/pull/514) Add `--instance-initiated-shutdown-behavior` option.
 * [knife-ec2:#513](https://github.com/chef/knife-ec2/pull/513) require `rb-readline` to avoid ruby 2.4 warnings about `Fixnum`.
 
-## Latest Release 0.16.0 (2017-11-07)
+## Release 0.16.0 (2017-11-07)
 * [knife-ec2:#503](https://github.com/chef/knife-ec2/pull/503) Update list of instance_types that support ebs-encryption.
 * [knife-ec2:#496](https://github.com/chef/knife-ec2/pull/496) Change Winrm cert to 10 year expiry.
 * [knife-ec2:#492](https://github.com/chef/knife-ec2/pull/492) Added support to tag node details to chef.
@@ -19,7 +22,7 @@ prior to release 0.8.0, please visit the [source repository](https://github.com/
 * [knife-ec2:#488](https://github.com/chef/knife-ec2/pull/488) Added support to tag EBS volumes on node creation.
 * [knife-ec2:#487](https://github.com/chef/knife-ec2/pull/487) Added new column description in EC2 AMIs list.
 
-## Latest Release 0.15.0 (2017-02-15)
+## Release 0.15.0 (2017-02-15)
 * [knife-ec2:#484](https://github.com/chef/knife-ec2/pull/484) sleep for collecting windows password
 * [knife-ec2:#481](https://github.com/chef/knife-ec2/pull/481) Updated readme for EC2 AMI list
 * [knife-ec2:#482](https://github.com/chef/knife-ec2/pull/482) Allow search for EC2 AMIs
@@ -30,7 +33,7 @@ prior to release 0.8.0, please visit the [source repository](https://github.com/
 * [knife-ec2:#468](https://github.com/chef/knife-ec2/pull/468) In VPC mode use private IP when public IP and DNS not available 
 * [knife-ec2:#464](https://github.com/chef/knife-ec2/pull/464) default value and desription is changed for --ebs-volume-type 
 
-## Latest Release 0.14.0 (2016-12-02)
+## Release 0.14.0 (2016-12-02)
 * `knife-ec2` requires `chef-client 12.14` or newer.
 * [knife-ec2:#442](https://github.com/chef/knife-ec2/pull/442) Added support to show flavor list in json format.
 * [knife-ec2:#439](https://github.com/chef/knife-ec2/pull/439) Allow to accept multiple security group ids using --security-group-id option multiple times and added deprecated message for comma seprated --security-group-ids option.

data/DOC_CHANGES.md

@@ -4,14 +4,14 @@ This file is reset everytime when a new release is done. Contents of this file i
 
 # knife-ec2 doc changes
 
-Documentation changes are given below for **knife-ec2 version 0.17.0**.
+Documentation changes are given below for **knife-ec2 version 0.18.0**.
 
 ## `knife ec2 server create` subcommand changes
 
-### `--instance-initiated-shutdown-behavior` option
+### `--aws-tag` option
 
-The `--instance-initiated-shutdown-behavior` option indicates whether an instance stops or terminates when you initiate shutdown from the instance. Possible values are 'stop' and 'terminate', default is 'stop'.
+The `--aws-tag` option is used for tagging the EC2 instances in AWS as `key=value` pair. Use this option like e.g. `--aws-tag <key1=value1>`. Multiple tags can be added by specifying the option multiple times.
 
-### `--primary-eni` option
+### `--chef-tag` option
 
-Specify a pre-existing ENI for primary interface when building the instance.
+The `--chef-tag` option is used for tagging the EC2 instances on the Chef server. Use this option like e.g. `--chef-tag <myTag>`. Multiple tags can be added by specifying the option multiple times.

data/RELEASE_NOTES.md

@@ -7,16 +7,11 @@ Example Note:
 Details about the thing that changed that needs to get included in the Release Notes in markdown.
 -->
 
-# knife-ec2 0.17.0 release notes:
-In this release we have added features for adding exisiting ENI to server using `--primary-eni option`. Also added option `--instance-initiated-shutdown-behavior` to stop or terminate the instance on shutdown. There are a couple of bug fixes and enhancement as well.
+# knife-ec2 0.18.0 release notes:
+In this release we have added separate features for tagging EC2 instances in AWS and Chef. Option `--aws-tag` is used for tagging the node in AWS and option `--chef-tag` is used for tagging the node in Chef. Subsequently the `--tag-node-in-chef` and `--tags` are now deprecated.
 
-## Features added in knife-ec2 0.17.0
+## Features added in knife-ec2 0.18.0
+* Added support for tagging node in AWS as well as in Chef with separate options `--aws-tag` and `--chef-tag`. PR: [520](https://github.com/chef/knife-ec2/pull/520).
 
-* Added support to add existing ENI to server while node creation using `--primary-eni` option. PR: [515](https://github.com/chef/knife-ec2/pull/515).
-
-* Added support to set the `--instance-initiated-shutdown-behavior` with the option to set "stop" or "terminate" the instance on shutdown. The default is "stop". PR: [514](https://github.com/chef/knife-ec2/pull/514).
-
-
-## Enhancement in knife-ec2 0.17.0
-
-* require `rb-readline` to avoid ruby 2.4 warnings about `Fixnum` PR: [513](https://github.com/chef/knife-ec2/pull/513)
+## Enhancement in knife-ec2 0.18.0
+* No enhancements.

data/lib/chef/knife/ec2_server_create.rb

@@ -110,8 +110,11 @@ class Chef
       option :tags,
         :short => "-T T=V[,T=V,...]",
         :long => "--tags Tag=Value[,Tag=Value...]",
-        :description => "The tags for this server",
-        :proc => Proc.new { |tags| tags.split(',') }
+        :description => "The tags for this server. [DEPRECATED] Use --aws-tag instead.",
+        :proc => Proc.new { |v|
+          Chef::Log.warn("[DEPRECATED] --tags option is deprecated. Use --aws-tag option instead.")
+          v
+        }
 
       option :availability_zone,
         :short => "-Z ZONE",
@@ -453,7 +456,11 @@ class Chef
 
       option :tag_node_in_chef,
         :long => "--tag-node-in-chef",
-        :description => "Flag for tagging node in ec2 and chef both",
+        :description => "Flag for tagging node in ec2 and chef both. [DEPRECATED] Use --chef-tag instead.",
+        :proc        => Proc.new { |v|
+          Chef::Log.warn("[DEPRECATED] --tag-node-in-chef option is deprecated. Use --chef-tag option instead.")
+          v
+        },
         :boolean => true,
         :default => false
 
@@ -461,6 +468,24 @@ class Chef
         :long => "--instance-initiated-shutdown-behavior SHUTDOWN_BEHAVIOR",
         :description => "Indicates whether an instance stops or terminates when you initiate shutdown from the instance. Possible values are 'stop' and 'terminate', default is 'stop'."
 
+      option :chef_tag,
+        :long => "--chef-tag CHEF_TAG",
+        :description => "Use to tag the node in chef server; Provide --chef-tag option multiple times when specifying multiple tags e.g. --chef-tag tag1 --chef-tag tag2.",
+        :proc => Proc.new { |chef_tag|
+          Chef::Config[:knife][:chef_tag] ||= []
+          Chef::Config[:knife][:chef_tag].push(chef_tag)
+          Chef::Config[:knife][:chef_tag]
+        }
+
+      option :aws_tag,
+        :long => "--aws-tag AWS_TAG",
+        :description => "AWS tag for this server; Use the --aws-tag option multiple times when specifying multiple tags e.g. --aws-tag key1=value1 --aws-tag key2=value2.",
+        :proc => Proc.new { |aws_tag|
+          Chef::Config[:knife][:aws_tag] ||= []
+          Chef::Config[:knife][:aws_tag].push(aws_tag)
+          Chef::Config[:knife][:aws_tag]
+        }
+
       def run
         $stdout.sync = true
         validate!
@@ -527,7 +552,7 @@ class Chef
           end
         end
 
-        printed_tags = hashed_tags.map{ |tag, val| "#{tag}: #{val}" }.join(", ")
+        printed_aws_tags = hashed_tags.map{ |tag, val| "#{tag}: #{val}" }.join(", ")
 
         hashed_volume_tags={}
         volume_tags = locate_config_value(:volume_tags)
@@ -554,7 +579,7 @@ class Chef
 
         msg_pair("IAM Profile", locate_config_value(:iam_instance_profile))
 
-        msg_pair("Tags", printed_tags)
+        msg_pair("AWS Tags", printed_aws_tags)
         msg_pair("Volume Tags", printed_volume_tags)
         msg_pair("SSH Key", @server.key_name)
 
@@ -641,7 +666,8 @@ class Chef
         msg_pair("Security Group Ids", printed_security_group_ids) if vpc_mode? or @server.security_group_ids
         msg_pair("IAM Profile", locate_config_value(:iam_instance_profile)) if locate_config_value(:iam_instance_profile)
         msg_pair("Primary ENI", locate_config_value(:primary_eni)) if locate_config_value(:primary_eni)
-        msg_pair("Tags", printed_tags)
+        msg_pair("AWS Tags", printed_aws_tags)
+        msg_pair("Chef Tags", locate_config_value(:chef_tag)) if locate_config_value(:chef_tag)
         msg_pair("SSH Key", @server.key_name)
         msg_pair("Root Device Type", @server.root_device_type)
         msg_pair("Root Volume Tags", printed_volume_tags)
@@ -771,6 +797,7 @@ class Chef
         bootstrap.config[:bootstrap_vault_item] = locate_config_value(:bootstrap_vault_item)
         bootstrap.config[:use_sudo_password] = locate_config_value(:use_sudo_password)
         bootstrap.config[:yes] = locate_config_value(:yes)
+        bootstrap.config[:tags] = config[:chef_tag] if locate_config_value(:chef_tag)
         # Modify global configuration state to ensure hint gets set by
         # knife-bootstrap
         Chef::Config[:knife][:hints] ||= {}
@@ -1004,12 +1031,15 @@ class Chef
           end
         end
 
+        if locate_config_value(:tag_node_in_chef)
+          ui.warn("[DEPRECATED] --tag-node-in-chef option is deprecated. Use --chef-tag option instead.")
+        end
       end
 
       def tags
-       tags = locate_config_value(:tags)
+       tags = locate_config_value(:aws_tag)
         if !tags.nil? and tags.length != tags.to_s.count('=')
-          ui.error("Tags should be entered in a key = value pair")
+          ui.error("AWS Tags should be entered in a key = value pair")
           exit 1
         end
        tags
@@ -1219,7 +1249,7 @@ EOH
         server_def[:disable_api_termination] = locate_config_value(:disable_api_termination) if locate_config_value(:spot_price).nil?
 
         server_def[:instance_initiated_shutdown_behavior] = locate_config_value(:instance_initiated_shutdown_behavior)
-
+        server_def[:chef_tag] = locate_config_value(:chef_tag)
         server_def
       end
 

data/lib/knife-ec2/version.rb

@@ -1,6 +1,6 @@
 module Knife
   module Ec2
-    VERSION = "0.17.0"
+    VERSION = "0.18.0"
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

data/spec/unit/ec2_server_create_spec.rb

@@ -134,7 +134,8 @@ describe Chef::Knife::Ec2ServerCreate do
           :placement_group => nil,
           :iam_instance_profile_name => nil,
           :ebs_optimized => "false",
-          :instance_initiated_shutdown_behavior => nil
+          :instance_initiated_shutdown_behavior => nil,
+          :chef_tag => nil
         }
       allow(@bootstrap).to receive(:run)
     end
@@ -476,16 +477,16 @@ describe Chef::Knife::Ec2ServerCreate do
       knife_ec2_create.run
     end
 
-    it "sets the Name tag to the specified name when given --tags Name=NAME" do
-      knife_ec2_create.config[:tags] = ["Name=bobcat"]
+    it "sets the Name tag to the specified name when given --aws-tag Name=NAME" do
+      knife_ec2_create.config[:aws_tag] = ["Name=bobcat"]
       expect(ec2_connection.tags).to receive(:create).with(:key => "Name",
                                                         :value => "bobcat",
                                                         :resource_id => new_ec2_server.id)
       knife_ec2_create.run
     end
 
-    it "sets arbitrary tags" do
-      knife_ec2_create.config[:tags] = ["foo=bar"]
+    it "sets arbitrary aws tags" do
+      knife_ec2_create.config[:aws_tag] = ["foo=bar"]
       expect(ec2_connection.tags).to receive(:create).with(:key => "foo",
                                                         :value => "bar",
                                                         :resource_id => new_ec2_server.id)
@@ -2571,6 +2572,64 @@ netstat > c:\\netstat_data.txt
     end
   end
 
+  describe '--chef-tag option' do
+    before do
+      allow(Fog::Compute::AWS).to receive(:new).and_return(ec2_connection)
+    end
+
+    context 'when mulitple values provided from cli for e.g. --chef-tag "foo" --chef-tag "bar"' do
+      let(:ec2_server_create) { Chef::Knife::Ec2ServerCreate.new(['--chef-tag', 'foo', '--chef-tag', 'bar'])}
+      it 'creates array of chef tag' do
+        server_def = ec2_server_create.create_server_def
+        expect(server_def[:chef_tag]).to eq(['foo', 'bar'])
+      end
+    end
+
+    context 'when single value provided from cli for e.g. --chef-tag foo' do
+      let(:ec2_server_create) { Chef::Knife::Ec2ServerCreate.new(['--chef-tag', 'foo'])}
+      it 'creates array of chef tag' do
+        server_def = ec2_server_create.create_server_def
+        expect(server_def[:chef_tag]).to eq(['foo'])
+      end
+    end
+  end
+
+  describe '--aws-tag option' do
+    before do
+      allow(Fog::Compute::AWS).to receive(:new).and_return(ec2_connection)
+    end
+
+    context 'when mulitple values provided from cli for e.g. --aws-tag "foo=bar" --aws-tag "foo1=bar1"' do
+      let(:ec2_server_create) { Chef::Knife::Ec2ServerCreate.new(['--aws-tag', 'foo=bar', '--aws-tag', 'foo1=bar1'])}
+      it 'creates array of aws tag' do
+        server_def = ec2_server_create.config
+        expect(server_def[:aws_tag]).to eq(['foo=bar', 'foo1=bar1'])
+      end
+    end
+
+    context 'when single value provided from cli for e.g. --aws-tag foo=bar' do
+      let(:ec2_server_create) { Chef::Knife::Ec2ServerCreate.new(['--aws-tag', 'foo=bar'])}
+      it 'creates array of aws tag' do
+        server_def = ec2_server_create.config
+        expect(server_def[:aws_tag]).to eq(['foo=bar'])
+      end
+    end
+  end
+
+  describe '--tag-node-in-chef option' do
+    before do
+      allow(Fog::Compute::AWS).to receive(:new).and_return(ec2_connection)
+    end
+
+    context 'when provided from cli for e.g. --tag-node-in-chef' do
+      let(:ec2_server_create) { Chef::Knife::Ec2ServerCreate.new(['--tag-node-in-chef'])}
+      it 'raises deprecated warning "[DEPRECATED] --tag-node-in-chef option is deprecated. Use --chef-tag option instead."' do
+        expect(ec2_server_create.ui).to receive(:warn).with("[DEPRECATED] --tag-node-in-chef option is deprecated. Use --chef-tag option instead.")
+        ec2_server_create.validate!
+      end
+    end
+  end
+
   describe 'evaluate_node_name' do
     before do
       knife_ec2_create.instance_variable_set(:@server, server)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-ec2
 version: !ruby/object:Gem::Version
-  version: 0.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Adam Jacob
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-07 00:00:00.000000000 Z
+date: 2018-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-aws
@@ -165,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: EC2 Support for Chef's Knife Command