Updated readme

Author: kyletbase2

README.md

@@ -1,30 +1,95 @@
-![build-status](https://travis-ci.com/theonestack/hl-component-aurora-postgres.svg?branch=master)
+# aurora (Postgres) CfHighlander component
+## Parameters
 
-### Cfhighlander Aurora Postgres component
+| Name | Use | Default | Global | Type | Allowed Values |
+| ---- | --- | ------- | ------ | ---- | -------------- |
+| EnvironmentName | Tagging | dev | true | string
+| EnvironmentType | Tagging | development | true | string | ['development','production']
+| VPCId | Security Groups | None | false | AWS::EC2::VPC::Id
+| DnsDomain | DNS domain to use | None | true | string
+| SubnetIds | List of subnets | None | false | CommaDelimitedList
+| KmsKeyId | KMS ID | None | false | string (arn)
+| NamespaceId | Service discovery namespace ID | None | false | string
+| SnapshotId | Snapshot ID to provision from | None | false | string
+| WriterInstanceType | Writer instance type *if engine is set to provisioned* | None | false | string
+| ReaderInstanceType | Reader instance type *if engine is set to provisioned* | None | false | string
+## Outputs/Exports
 
-```bash
+| Name | Value | Exported |
+| ---- | ----- | -------- |
+| SecurityGroup | Security Group name | true
+| ServiceRegistry | CloudMap service registry ID | true
+| DBClusterId | Database Cluster ID | true
+
+## Included Components
 
-# install highlander gem
-$ gem install cfhighlander
+[lib-ec2](https://github.com/theonestack/hl-component-lib-ec2)
 
-# build and validate standalone component
-$ cfcompile --validate
+## Example Configuration
+### Highlander
+```
+  Component name:'database', template: 'aurora-postgres' do
+    parameter name: 'DnsDomain', value: root_domain
+    parameter name: 'DnsFormat', value: FnSub("${EnvironmentName}.#{root_domain}")
+    parameter name: 'SubnetIds', value: cfout('vpcv2', 'PersistenceSubnets')
+    parameter name: 'WriterInstanceType', value: writer_instance
+    parameter name: 'ReaderInstanceType', value: reader_instance
+    parameter name: 'EnableReader', value: 'true'
+    parameter name: 'StackOctet', value: '80'
+    parameter name: 'NamespaceId', value: cfout('servicediscovery', 'NamespaceId')
+  end
+```
 
+### Aurora Postgres Configuration
 ```
-### Usage
+hostname: db
+database_name: appdb
+dns_format: ${DnsFormat}
+
+storage_encrypted: true
+engine: aurora-postgres
+engine_version: '13.4'
+
+writer_instance: db.r3.large
+reader_instance: db.r3.large
+
+master_login: 
+    username_ssm_param: /${EnvironmentName}/myapp/dbuser
+    password_ssm_param: /${EnvironmentName}/myapp/dbpass
 
-### Configuration options
+security_group:
+  -
+    rules:
+      -
+        IpProtocol: tcp
+        FromPort: 5432
+        ToPort: 5432
+    ips:
+      - stack
+      - company_office
+      - company_client_vpn
 
-TBD
+service_discovery:
+  name: db
+```
 
-### Parameters
+## Cfhighlander Setup
 
-TBD
+install cfhighlander [gem](https://github.com/theonestack/cfhighlander)
 
-### Configuration options
+```bash
+gem install cfhighlander
+```
 
-TBD
+or via docker
 
-### Outputs
+```bash
+docker pull theonestack/cfhighlander
+```
+## Testing Components
+
+Running the tests
 
-TBD
+```bash
+cfhighlander cftest aurora-postgres
+```