aws-eni 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f19e4e251a90092251316683eb8f3562300422e5
-  data.tar.gz: eb37b04707d8d8817fd247a3d440bc44d310dae2
+  metadata.gz: 14eb7ab252066d43cf0f289c7d5de6e796fe6b95
+  data.tar.gz: b96f9a46cc748d54bbef973a5af74fca467a7b22
 SHA512:
-  metadata.gz: 56f2fca8525b755a14d3a78d654bdb5e148e593e53ba74bf193ad57e18ba25955ef5a8697ab2fc83184c6e5c43a3e3c67e80bedeb268884f2fe1c6af7e255497
-  data.tar.gz: ae0239c63b23e14433074b71afad75f0ceda79954d5aa5adacbae4f9fcc559d577fe1280029aedf8da181777e4d11e113153cc413598926db8dedb9d3108e5ac
+  metadata.gz: 48d1acfaaac7ca2ea0777305388fa1cac6f48c1b0a368dc9b08e493ff4a52274fc1813a34027b0c0858c27c4e3c91f3396df2090f1c9152f520133f0b0abbc75
+  data.tar.gz: fb0c4f4a9b9309b8236c729c7ac438f62579a057accf41488c5e3822cb0cb509d52f30aa6dc393ea2f6253cf4c720f568a0ef45e3628ad368c2b2e659210dc7d

data/README.md

@@ -1,6 +1,10 @@
 # aws-eni
 
-A command line tool and client library to manage AWS Elastic Network Interfaces from within an EC2 instance.
+A command line tool and ruby library to manage AWS Elastic Network Interfaces from within an EC2 instance.
+
+## Notes
+
+Your AWS access credentials will be introspected from either the environment variables or the EC2 instance meta-data (see AWS IAM instance role documentation).  Any command which requires a modification of the machine's interface configuration will require super-user privileges to access `/sbin/ip`.
 
 ## Installation
 
@@ -18,45 +22,98 @@ Or install it yourself as:
 
     $ gem install aws-eni
 
-## Usage
+## Command Line Usage
 
 Synchronize your EC2 instance network interface config with AWS.
 
-    $ aws-eni sync
+    $ aws-eni config
+    synchronized interface config
 
 List all interface cards, their IPs, and their associations
 
     $ aws-eni list
-    eth0:
-      10.0.1.23
-    eth1:
-      10.0.2.54 => 54.25.169.87 (EIP)
-      10.0.2.72 => 52.82.17.251 (EIP)
+    eth0:   ID eni-c02ef998  HWaddr 0e:96:b1:4a:15:2c  Status UP
+            10.0.0.152 => 52.5.179.113
+    eth1:   ID eni-585afa03  HWaddr 0e:90:7a:00:bf:7d  Status UP
+            10.0.0.55
+
+Add a secondary private IP
+
+    $ aws-eni assign eth1
+    IP 10.0.0.45 assigned to eth1 (eni-585afa03)
+
+    $ aws-eni list eth1
+    eth1:   ID eni-585afa03  HWaddr 0e:90:7a:00:bf:7d  Status UP
+            10.0.0.55
+            10.0.0.45
 
-Add a new private IP
+Associate a new Elastic IP
 
-    $ aws-eni add eth1
-    added 10.0.2.81
+    $ aws-eni assoc 10.0.0.45
+    EIP 52.5.141.210 (eipalloc-52117737) associated with 10.0.0.45 on eth1 (eni-585afa03)
 
-Associate a new elastic IP
+    $ aws-eni list eth1
+    eth1:   ID eni-585afa03  HWaddr 0e:90:7a:00:bf:7d  Status UP
+            10.0.0.55
+            10.0.0.45 => 52.5.141.210
 
-    $ aws-eni associate 10.0.2.81
-    associated 10.0.2.81 => 52.171.254.36
+Test a WAN connection through our newly associated Elastic IP
+
+    $ aws-eni test 52.5.141.210
+    EIP 52.5.141.210 connection successful
+
+    $ curl --interface 10.0.0.45 ifconfig.me/ip
+    52.5.141.210
 
 Dissociate an elastic IP
 
-    $ aws-eni dissociate 10.0.2.81
-    dissociated 52.171.254.36 from 10.0.2.81
+    $ aws-eni dissoc 52.5.141.210
+    EIP 52.5.141.210 (eipalloc-52117737) dissociated with 10.0.0.45 on eth1 (eni-585afa03)
+
+    $ aws-eni list eth1
+    eth1:   ID eni-585afa03  HWaddr 0e:90:7a:00:bf:7d  Status UP
+            10.0.0.55
+            10.0.0.45
 
-Remove a private IP
+Remove a secondary private IP
 
-    $ aws-eni remove 10.0.2.81
-    removed 10.0.2.81 from eth1
+    $ aws-eni unassign 10.0.0.45
+    IP 10.0.0.45 removed from eth1 (eni-585afa03)
+
+    $ aws-eni list
+    eth0:   ID eni-c02ef998  HWaddr 0e:96:b1:4a:15:2c  Status UP
+            10.0.0.152 => 52.5.179.113
+    eth1:   ID eni-585afa03  HWaddr 0e:90:7a:00:bf:7d  Status UP
+            10.0.0.55
+
+## Library Usage
+
+```ruby
+require 'aws-eni'
+
+# create and attach a new interface
+interface = Aws::ENI.create_interface
+Aws::ENI.attach_interface(interface[:interface_id])
+
+puts "Attached #{interface[:interface_id]} to #{interface[:device_name]}"
+
+# add a secondary private IP to our new interface and associate an EIP
+assign = Aws::ENI.assign_secondary_ip(interface[:device_name])
+assoc = Aws::ENI.associate_elastic_ip(assign[:private_ip], block: false)
+
+puts "Associated #{assoc[:public_ip]} with #{assoc[:private_ip]} on #{assoc[:device_name]}"
+
+# verify our new public IP address (associate_elastic_ip normally does this
+# automatically if 'block' option is not false)
+if Aws::ENI.test_association(assoc[:public_ip])
+  puts "#{assoc[:public_ip]} can successfully connect to the internet via #{assoc[:private_ip]}"
+else
+```
 
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/aws-eni/fork )
+1. Fork it ( https://github.com/pixelcog/aws-eni/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`)

data/lib/aws-eni/client.rb

@@ -26,6 +26,7 @@ module Aws
       def client
         @client ||= EC2::Client.new(region: region)
       rescue StandardError => e
+        raise if e === Errors::ServiceError
         raise Errors::EnvironmentError, 'Unable to initialize EC2 client'
       end
 
@@ -145,7 +146,7 @@ module Aws
             true
           rescue EC2::Errors::UnauthorizedOperation
             false
-          rescue
+          rescue EC2::Errors::ServiceError
             raise Errors::ClientOperationError, 'Unexpected behavior while testing EC2 client permissions'
           else
             raise Errors::ClientOperationError, 'Unexpected behavior while testing EC2 client permissions'

data/lib/aws-eni/version.rb

@@ -1,5 +1,5 @@
 module Aws
   module ENI
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-eni
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Mike Greiling