feat(event): do not create/update tags during delete (#16)

* process event requestType to not run when delete
* add taints example to documentation
* add examples with multiple tags combination
* add docker tag documentation

Author: portellaa

README.md

@@ -12,6 +12,18 @@ It's user responsability to specify the cluster the pools and the tags for each
 
 ## How to use
 
+### Push to AWS ECR
+
+Our pipelines publish which new release to the docker hub, but in order to call it from a lambda, it needs to be in the AWS account of your private ECR.
+
+Example, but you can tag it with the name you want:
+
+```bash
+docker pull ydata/aws-asg-tags-lambda:1.0.0
+docker tag ydata/aws-asg-tags-lambda:1.0.0 <your private ECR>/aws-asg-tags-lambda:1.0.0
+docker push <your private ECR>/aws-asg-tags-lambda:1.0.0
+```
+
 ### CloudFormation
 
 The execution role, it's necessary to connect to the EKS and EC2 for the auto scaling groups
@@ -76,26 +88,85 @@ EKSASGTagLambdaInvoke:
     Region: !Ref AWS::Region
     ClusterName: "the EKS cluster name"
     CommonTags:
-    - Name: "A Tag"
-      Value: "A value for the tag"
+    - Name: "ENVIRONMENT"
+      Value: "dev"
+      PropagateAtLaunch: true
     NodePools:
-    - Name: "A node pool name"
+    - Name: "system-nodepool"
       Tags:
-      - Name: "Another Tag"
-        Value: "A value for another tag"
-    - Name: "Another pool name"
-      Tags:
-      - Name: "Another Tag"
-        Value: "A value for another tag"
+      - Name: 'k8s.io/cluster-autoscaler/node-template/taint/TAINT'
+        Value: 'NoSchedule'
+        PropagateAtLaunch: true
+      - Name: 'k8s.io/cluster-autoscaler/node-template/label/LABEL'
+        Value: 'LABEL_VALUE'
+        PropagateAtLaunch: true
+    - Name: "another-pool"
+
+```
+
+Both `CommonTags` and `Tags` of each NodePool are optional, but if you don't specify `CommonTags` neither `Tags` for each NodePool, it will not do anything.
+
+Check the following examples for other valid combinations
 
+An example with only `CommonTags`
+
+```yaml
+EKSASGTagLambdaInvoke:
+  Type: AWS::CloudFormation::CustomResource
+  DependsOn: EKSASGTagLambdaFunction
+  Version: "1.0"
+  Properties:
+    ServiceToken: !GetAtt EKSASGTagLambdaFunction.Arn
+    StackID: !Ref AWS::StackId
+    AccountID: !Ref AWS::AccountId
+    Region: !Ref AWS::Region
+    ClusterName: "the EKS cluster name"
+    CommonTags:
+    - Name: "ENVIRONMENT"
+      Value: "prod"
+      PropagateAtLaunch: true
+    NodePools:
+    - Name: "system-nodepool"
+    - Name: "applications-nodepool"
 ```
 
+An example with only `Tags` for the NodePool
+
+```yaml
+EKSASGTagLambdaInvoke:
+  Type: AWS::CloudFormation::CustomResource
+  DependsOn: EKSASGTagLambdaFunction
+  Version: "1.0"
+  Properties:
+    ServiceToken: !GetAtt EKSASGTagLambdaFunction.Arn
+    StackID: !Ref AWS::StackId
+    AccountID: !Ref AWS::AccountId
+    Region: !Ref AWS::Region
+    ClusterName: "the EKS cluster name"
+    NodePools:
+    - Name: "system-nodepool"
+      Tags:
+      - Name: 'k8s.io/cluster-autoscaler/node-template/taint/TAINT'
+        Value: 'NoSchedule'
+        PropagateAtLaunch: true
+      - Name: 'k8s.io/cluster-autoscaler/node-template/label/LABEL'
+        Value: 'LABEL_VALUE'
+        PropagateAtLaunch: true
+    - Name: "application-nodepool"
+      Tags:
+      - Name: 'k8s.io/cluster-autoscaler/node-template/taint/TAINT'
+        Value: 'NoSchedule'
+        PropagateAtLaunch: true
+      - Name: 'k8s.io/cluster-autoscaler/node-template/label/LABEL'
+        Value: 'LABEL_VALUE'
+        PropagateAtLaunch: true
+```
 
 ## TODO
 - [ ] Add generic context
 - [ ] Tests
 - [ ] Better Documentation
-- [ ] Support other methods of usage
+- [ ] Support other methods of invocation
 
 
 ## About 👯‍♂️

Sources/CloudFormation/run.swift

@@ -26,6 +26,13 @@ struct CloudFormationHandler: LambdaHandler {
   func handle(_ event: Event, context: LambdaContext) async throws -> Output {
     context.logger.info("running lambda with event \n\(event)")
 
+    switch event.requestType {
+    case .create, .update: return try await createOrUpdate(event, context)
+    case .delete: return try await delete(event, context)
+    }
+  }
+
+  private func createOrUpdate(_ event: Event, _ context: LambdaContext) async throws -> Output {
     guard let resourceProperties = event.resourceProperties else {
       return try await terminate(with: event, result: .failure(Error.missingResourceProperties))
     }
@@ -39,6 +46,10 @@ struct CloudFormationHandler: LambdaHandler {
     try await terminate(with: event, result: result)
   }
 
+  private func delete(_ event: Event, _ context: LambdaContext) async throws -> Output {
+    try await terminate(with: event, result: LambdaResult<Error>.success(()))
+  }
+
   private func terminate<E: Swift.Error>(with event: Event, result: LambdaResult<E>) async throws {
     try await httpClient.terminateCloudFormationInvocation(event.responseURL, event: result.encode(for: event))
   }