Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

sortinghat

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

sortinghat

  • 0.3.4.develop
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

Sortinghat

Gem Version Total Gem Downloads Build Status Build Status

Sortinghat is a unqiue Ruby gem that allows AWS AutoScaling instances to name themselves.

We all understand that naming your cattle is bad, they shouldn't be pets.. but hostnames are handy and readable, and [insert reason].

When the Sorting Hat is given specific arguments, it can find the gaps in current prefixes or +1 from the last current prefix and name the instance accordingly; along with updating Route53.

It follows a specific pattern for hostnames/fqdn:

[client]-[environment]-[type][suffix]-[region].[domain].com.

For example:

nike-prod-nginx09-us-west-2.prod-nike.com

Installation:

Install however you please to your AMI(s) with:

$ gem install sortinghat

Requirements:

The gem itself was developed under Ruby 2.0.0 to work with CentOS 7.

It requires the following gems:

  • aws-sdk 2.1.2
  • pure_json

During actually usage, the gem requires that the instance have the following IAM actions allowed via policy:

  • autoscaling:DescribeAutoScalingInstances
  • autoscaling:DescribeAutoScalingGroups
  • ec2:DescribeInstances
  • ec2:CreateTags
  • route53:ListHostedZones
  • route53:ChangeResourceRecordSets

Usage:

Note: The Sorting Hat requires root privileges to write to files under /etc/.

Have cloud-init, cfn-init, or [x/y/z], issue the following command:

$ sortinghat -c [client] -e [environment] -t [type] -r [region] -z [domain]

Note: [domain] should be in the format of [domain].com, just like the AWS Console reports for the HostedZone. No need to add the trailing dot, it will be added should you forget.

The Sorting Hat will log to syslog for information.

The Sorting Hat may be re-run, provided you remove the empty file located at '/etc/.sorted'.

Development

Need to develop on an EC2 instance with metadata available or spoof it somehow.

Clone:

$ git clone https://github.com/praymann/sortinghat

Execute:

$ bundle install

Run:

$ bundle exec bin/sortinghat -h

Credits

Kudos to nerk01 for help and guidance with anything Ruby! He is also a contributor to this project.

Kudos to jrbeilke for help and guidance with Ruby and the "rubber duck debugging" support.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/praymann/sortinghat.

License

The gem is available as open source under the terms of the MIT License.

FAQs

Package last updated on 17 May 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc