Merge pull request #10 from kyletbase2/master

Added service discovery function

Author: Guslington

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
+```

aurora-postgres.cfhighlander.rb

@@ -13,6 +13,8 @@
     ComponentParam 'VPCId', type: 'AWS::EC2::VPC::Id'
     ComponentParam 'SubnetIds', type: 'CommaDelimitedList'
     ComponentParam 'KmsKeyId' if (defined? kms) && (kms)
+
+    ComponentParam 'NamespaceId' if defined? service_discovery
   end
-  
+
 end

aurora-postgres.cfndsl.rb

@@ -21,8 +21,8 @@
     }
     if rule['security_group_id']
       sg_rule['SourceSecurityGroupId'] = FnSub(rule['security_group_id'])
-    else 
-      sg_rule['CidrIp'] = FnSub(rule['ip']) 
+    else
+      sg_rule['CidrIp'] = FnSub(rule['ip'])
     end
     if rule['desc']
       sg_rule['Description'] = FnSub(rule['desc'])
@@ -40,7 +40,7 @@
         Description: "outbound all for ports",
         IpProtocol: -1,
       }
-    ]) 
+    ])
     Tags aurora_tags
   end
 
@@ -110,7 +110,7 @@
     DBInstanceClass Ref(:ReaderInstanceType)
     Tags aurora_tags
   }
-  
+
   Route53_RecordSet(:DBClusterReaderRecord) {
     Condition(:CreateReaderRecord)
     HostedZoneName FnJoin('', [ Ref('EnvironmentName'), '.', Ref('DnsDomain'), '.'])
@@ -129,6 +129,40 @@
     ResourceRecords [ FnGetAtt('DBCluster','Endpoint.Address') ]
   }
 
+  registry = {}
+  service_discovery = external_parameters.fetch(:service_discovery, {})
+
+  unless service_discovery.empty?
+    ServiceDiscovery_Service(:ServiceRegistry) {
+      NamespaceId Ref(:NamespaceId)
+      Name service_discovery['name']  if service_discovery.has_key? 'name'
+      DnsConfig({
+        DnsRecords: [{
+          TTL: 60,
+          Type: 'CNAME'
+        }],
+        RoutingPolicy: 'WEIGHTED'
+      })
+      if service_discovery.has_key? 'healthcheck'
+        HealthCheckConfig service_discovery['healthcheck']
+      else
+        HealthCheckCustomConfig ({ FailureThreshold: (service_discovery['failure_threshold'] || 1) })
+      end
+    }
+
+    ServiceDiscovery_Instance(:RegisterInstance) {
+      InstanceAttributes(
+        AWS_INSTANCE_CNAME: FnGetAtt('DBCluster','Endpoint.Address')
+      )
+      ServiceId Ref(:ServiceRegistry)
+    }
+
+    Output(:ServiceRegistry) {
+      Value(Ref(:ServiceRegistry))
+      Export FnSub("${EnvironmentName}-#{external_parameters[:component_name]}-CloudMapService")
+    }
+  end
+
   Output(:DBClusterId) {
     Value(Ref(:DBCluster))
     Export FnSub("${EnvironmentName}-#{external_parameters[:component_name]}-dbcluster-id")

tests/service_registry.test.yaml

@@ -0,0 +1,7 @@
+test_metadata:
+  type: config
+  name: enable service registry
+  description: If you specify service_registry in the config, it should then expect the namespace component paremeter, and add service_discovery['name'] as the record
+
+service_discovery:
+  name: db