aws-rds 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b1c285ef2c67a30c80ce7fd061f7273bcd45900108bfaad8ab58a8fe989b1b7
-  data.tar.gz: 79b4b75bde18f848c3ec519688240a039a2b735361b6fe462dc8a55caf0000fe
+  metadata.gz: 67a21766fc05be67a2e13015eb1fa96aa637b1239dc72d7c110aa157b118465f
+  data.tar.gz: 1629c91ad379854e0ea48a41a66336d445fc65c70aed374eba017959e2aab00f
 SHA512:
-  metadata.gz: a93719e69cf274d15a7d05eccab34346c2e0b532b4fe633f13ca36071cfe1ff0b718d9db83d0c95529a5b7e39957c6d8cd4f47d03c1125bd1333abb54c7dbb07
-  data.tar.gz: ee807978b0406cc7444b713a4b53f5773d347f0f15a4e3a6d294025082c81abb8fc5e01c496f8933a66c8664fc9698364bffa47c22c82fe5462f79c24e329752
+  metadata.gz: 339e3c3604a9cc23f2fc2e3d46b4e422af8aba231b5e6d6abb4ac270e1390deddfc2fee23231ae0cc4c10913730909c38f0f3ee7937e4dd4d0bbcd3ec49452a8
+  data.tar.gz: 2218830413ef1e53ffda3fbd1832968bddc7c400b633bcbe84213afea9cf67dad24e20ba3ad723cc1c83e84c423165063f7d89ba74b837e24ce837ff8f6d494b

data/CHANGELOG.md

@@ -3,5 +3,8 @@
 All notable changes to this project will be documented in this file.
 This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.1.1]
+- comment out auto name tagging of security group for now
+
 ## [0.1.0]
 - initial release

data/README.md

@@ -16,7 +16,7 @@ aws-rds create mydb --profile mydb --db-name mydbname
 * mydb will be the RDS database identifier show on the AWS console
 * mydbname is the database name that contains the tables
 
-In a nutshell, the profile parameters are passed to the ruby aws-sdk [AWS::RDS::Client#create_db_instance](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/Client.html#create_db_instance-instance_method) method.  So you can specify any parameter you wish that is available there.
+In a nutshell, the profile parameters are passed to the ruby aws-sdk [AWS::RDS::Client#create_db_instance](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/Client.html#create_db_instance-instance_method) method.  So you can specify any parameter you wish that is available there.  To check out what a profile looks like look at the [example default](example/profiles/default.yml)
 
 ## config
 
@@ -42,6 +42,15 @@ aws-rds create mydb --security-group-name mydb --profile mydb
 aws-rds create mydb # same as above
 ```
 
+## More Help
+
+```sh
+aws-rds create help
+aws-rds help # general help
+```
+
+Examples are in the [example](example) folder.  You will have to update settings.
+
 ## Installation
 
 ```sh

data/example/README.md

@@ -0,0 +1,26 @@
+# RDS Profiles
+
+This folder contains RDS profile files that can be used with the [aws-rds](https://github.com/tongueroo/aws-rds) tool to quickly launch RDS instances consistently with some pre-configured settings.
+
+As mentioned in the aws-rds README, the script ultimately uses the parameters in the profile files and pass them to the [create_db_instance](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/RDS/Client.html#create_db_instance-instance_method) method of the ruby aws-sdk.  So you can use any parameter available there to configure the RDS instance settings.
+
+Check out [profiles/default.yml](profiles/default.yml) for the common settings.
+
+## Creating RDS Databases
+
+To create your own RDS instance for testing you can run:
+
+```sh
+aws-rds create mydb --security-group-name mydbsg
+```
+
+## Test Connection
+
+Ssh into an instance that has access to the server and verify that you can connect.
+
+```
+ssh ec2-user@ec2-xxx.com # ssh into one of your instances
+ping xxx.us-east-1.rds.amazonaws.com # test if you can get through firewall
+PGPASSWORD=xxx psql -h xxx.us-east-1.rds.amazonaws.com -U xxx # replace the xxx values with the real values
+  # this can be found in profiles/default.yml if you are using the default profile
+```

data/example/config/development.yml

@@ -0,0 +1,3 @@
+---
+vpc_id: vpc-123 # custom main vpc, use this when not specified in profile
+db_subnet_group_name: private-db-subnet-group # private subnet group

data/example/profiles/default.yml

@@ -0,0 +1,10 @@
+---
+allocated_storage: 20
+db_instance_class: db.t2.micro
+master_user_password: changeme
+master_username: changeme
+engine: postgres
+
+# db_name: mydb # can be overridden at the cli
+# vpc_security_group_ids: # automatically created for you if not set
+# db_instance_identifier: not respected here. always set from the cli

data/example/profiles/mydb.yml

@@ -0,0 +1 @@
+db_name: demo

data/lib/aws_rds/security_group.rb

@@ -20,10 +20,11 @@ module AwsRds
         description: name,
         vpc_id: AwsRds.config["vpc_id"],
       )
-      ec2.create_tags(
-        resources: [result.group_id],
-        tags: [{ key: "Name", value: name }],
-      )
+      # TODO: add waiter
+      # ec2.create_tags(
+      #   resources: [result.group_id],
+      #   tags: [{ key: "Name", value: name }],
+      # )
       resp = ec2.describe_security_groups(group_ids: [result.group_id])
       resp.security_groups.first
     end

data/lib/aws_rds/version.rb

@@ -1,3 +1,3 @@
 module AwsRds
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws-rds
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tung Nguyen
@@ -169,6 +169,10 @@ files:
 - README.md
 - Rakefile
 - aws-rds.gemspec
+- example/README.md
+- example/config/development.yml
+- example/profiles/default.yml
+- example/profiles/mydb.yml
 - exe/aws-rds
 - lib/aws-rds.rb
 - lib/aws_rds/aws_services.rb