Skip to content

Commit 5e67a36

Browse files
majanjua-amznmajanjua-amzn
committed
[Native K8s] Use <<-EOF syntax instead of an array of strings
1 parent 99547a8 commit 5e67a36

File tree

3 files changed

+130
-54
lines changed

3 files changed

+130
-54
lines changed

‎.github/workflows/test.yml

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
## Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
2+
## SPDX-License-Identifier: Apache-2.0
3+
4+
## This workflow aims to run the Application Signals end-to-end tests as a canary to
5+
## test the artifacts for App Signals enablement. It will deploy a sample app and remote
6+
## service onto an EKS cluster, call the APIs, and validate the generated telemetry,
7+
## including logs, metrics, and traces.
8+
name: Testing
9+
on:
10+
push:
11+
branches:
12+
- k8s
13+
workflow_dispatch: # be able to run the workflow on demand
14+
15+
concurrency:
16+
group: ${{ github.workflow }}
17+
cancel-in-progress: false
18+
19+
permissions:
20+
id-token: write
21+
contents: read
22+
23+
jobs:
24+
e2e-k8s-test-0:
25+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
26+
secrets: inherit
27+
with:
28+
aws-region: 'us-east-1'
29+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'
30+
e2e-k8s-test-1:
31+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
32+
secrets: inherit
33+
needs: e2e-k8s-test-0
34+
with:
35+
aws-region: 'us-east-1'
36+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'
37+
e2e-k8s-test-2:
38+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
39+
secrets: inherit
40+
needs: e2e-k8s-test-1
41+
with:
42+
aws-region: 'us-east-1'
43+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'
44+
e2e-k8s-test-3:
45+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
46+
secrets: inherit
47+
needs: e2e-k8s-test-2
48+
with:
49+
aws-region: 'us-east-1'
50+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'
51+
e2e-k8s-test-4:
52+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
53+
secrets: inherit
54+
needs: e2e-k8s-test-3
55+
with:
56+
aws-region: 'us-east-1'
57+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'
58+
e2e-k8s-test-5:
59+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
60+
secrets: inherit
61+
needs: e2e-k8s-test-4
62+
with:
63+
aws-region: 'us-east-1'
64+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'
65+
e2e-k8s-test-6:
66+
uses: ./.github/workflows/appsignals-e2e-k8s-test.yml
67+
secrets: inherit
68+
needs: e2e-k8s-test-5
69+
with:
70+
aws-region: 'us-east-1'
71+
caller-workflow-name: 'appsignals-e2e-k8s-canary-test'

‎terraform/k8s/cleanup/main.tf

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,28 @@ resource "null_resource" "cleanup" {
1010

1111
provisioner "remote-exec" {
1212
inline = [
13+
<<-EOF
1314
# Allow terraform to fail any of the following steps without exiting
14-
"set +e",
15+
set +e
1516
1617
# Uninstall the operator and remove the repo from the EC2 instance
17-
"echo \"LOG: Uninstalling CloudWatch Agent Operator\"",
18-
"helm uninstall --debug --namespace amazon-cloudwatch amazon-cloudwatch-operator --ignore-not-found",
19-
"echo \"LOG: Deleting CloudWatch Agent Operator repo from environment\"",
20-
"[ ! -e amazon-cloudwatch-agent-operator ] || sudo rm -r amazon-cloudwatch-agent-operator",
18+
echo "LOG: Uninstalling CloudWatch Agent Operator"
19+
helm uninstall --debug --namespace amazon-cloudwatch amazon-cloudwatch-operator --ignore-not-found
20+
echo "LOG: Deleting CloudWatch Agent Operator repo from environment"
21+
[ ! -e amazon-cloudwatch-agent-operator ] || sudo rm -r amazon-cloudwatch-agent-operator
2122
2223
# Delete sample app resources
23-
"echo \"LOG: Deleting sample app namespace\"",
24-
"kubectl delete namespace sample-app-namespace",
25-
"echo \"LOG: Deleting sample app deployment files\"",
26-
"[ ! -e frontend-service-depl.yaml ] || rm frontend-service-depl.yaml",
27-
"[ ! -e remote-service-depl.yaml ] || rm remote-service-depl.yaml",
28-
"sleep 10",
24+
echo "LOG: Deleting sample app namespace"
25+
kubectl delete namespace sample-app-namespace
26+
echo "LOG: Deleting sample app deployment files"
27+
[ ! -e frontend-service-depl.yaml ] || rm frontend-service-depl.yaml
28+
[ ! -e remote-service-depl.yaml ] || rm remote-service-depl.yaml
29+
sleep 10
2930
3031
# Print cluster state when done clean up procedures
31-
"echo \"LOG: Printing cluster state after cleanup\"",
32-
"kubectl get pods -A",
32+
echo "LOG: Printing cluster state after cleanup"
33+
kubectl get pods -A
34+
EOF
3335
]
3436
}
3537
}

‎terraform/k8s/deploy/main.tf

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -23,66 +23,69 @@ resource "null_resource" "deploy" {
2323

2424
provisioner "remote-exec" {
2525
inline = [
26+
<<-EOF
2627
# Make the Terraform fail if any step throws an error
27-
"set -e",
28+
set -e
2829
2930
# Ensure environment is clean
30-
"echo \"LOG: Rerunning cleanup commands in case of cleanup failure in previous run\"",
31-
"helm uninstall --debug --namespace amazon-cloudwatch amazon-cloudwatch-operator --ignore-not-found",
32-
"kubectl delete namespace sample-app-namespace --ignore-not-found=true",
33-
"[ ! -e amazon-cloudwatch-agent-operator ] || sudo rm -r amazon-cloudwatch-agent-operator",
34-
"[ ! -e frontend-service-depl.yaml ] || rm frontend-service-depl.yaml",
35-
"[ ! -e remote-service-depl.yaml ] || rm remote-service-depl.yaml",
31+
echo "LOG: Rerunning cleanup commands in case of cleanup failure in previous run"
32+
helm uninstall --debug --namespace amazon-cloudwatch amazon-cloudwatch-operator --ignore-not-found
33+
kubectl delete namespace sample-app-namespace --ignore-not-found=true
34+
[ ! -e amazon-cloudwatch-agent-operator ] || sudo rm -r amazon-cloudwatch-agent-operator
35+
[ ! -e frontend-service-depl.yaml ] || rm frontend-service-depl.yaml
36+
[ ! -e remote-service-depl.yaml ] || rm remote-service-depl.yaml
3637
3738
# Clone and install operator onto cluster
38-
"echo \"LOG: Cloning operator repo\"",
39-
"git clone https://github.com/aws/amazon-cloudwatch-agent-operator -q",
40-
"cd amazon-cloudwatch-agent-operator/helm/",
41-
"echo \"LOG: Installing CloudWatch Agent Operator using Helm\"",
42-
"helm upgrade --install --debug --namespace amazon-cloudwatch amazon-cloudwatch-operator ./ --create-namespace --set region=us-east-1 --set clusterName=k8s-cluster-${var.test_id}",
39+
echo "LOG: Cloning operator repo"
40+
git clone https://github.com/aws/amazon-cloudwatch-agent-operator -q
41+
cd amazon-cloudwatch-agent-operator/helm/
42+
echo "LOG: Installing CloudWatch Agent Operator using Helm"
43+
helm upgrade --install --debug --namespace amazon-cloudwatch amazon-cloudwatch-operator ./ --create-namespace --set region=us-east-1 --set clusterName=k8s-cluster-${var.test_id}
4344
44-
"sleep 60", # wait for pods to exist before checking if they're ready
45-
"kubectl wait --for=condition=Ready pods --all --selector=app.kubernetes.io/name=amazon-cloudwatch-observability -n amazon-cloudwatch --timeout=60s",
46-
"kubectl wait --for=condition=Ready pods --all --selector=app.kubernetes.io/name=cloudwatch-agent -n amazon-cloudwatch --timeout=60s",
45+
sleep 60 # wait for pods to exist before checking if they're ready
46+
kubectl wait --for=condition=Ready pods --all --selector=app.kubernetes.io/name=amazon-cloudwatch-observability -n amazon-cloudwatch --timeout=60s
47+
kubectl wait --for=condition=Ready pods --all --selector=app.kubernetes.io/name=cloudwatch-agent -n amazon-cloudwatch --timeout=60s
4748
4849
# Create sample app namespace
49-
"echo \"LOG: Creating sample app namespace\"",
50-
"kubectl create namespace sample-app-namespace",
50+
echo "LOG: Creating sample app namespace"
51+
kubectl create namespace sample-app-namespace
5152
5253
# Set up secret to pull image with
53-
"echo \"LOG: Creating secret \"",
54-
"ACCOUNT=$(aws sts get-caller-identity --query 'Account' --output text)",
55-
"SECRET_NAME=ecr-secret",
56-
"TOKEN=`aws ecr --region=${var.aws_region} get-authorization-token --output text --query authorizationData[].authorizationToken | base64 -d | cut -d: -f2`",
54+
echo "LOG: Creating secret "
55+
ACCOUNT=$(aws sts get-caller-identity --query 'Account' --output text)
56+
SECRET_NAME=ecr-secret
57+
TOKEN=`aws ecr --region=${var.aws_region} get-authorization-token --output text --query authorizationData[].authorizationToken | base64 -d | cut -d: -f2`
5758
58-
"echo \"LOG: Deleting secret if it exists\"",
59-
"kubectl delete secret -n sample-app-namespace --ignore-not-found $SECRET_NAME",
60-
"echo \"LOG: Creating secret for pulling sample app ECR\"",
61-
"kubectl create secret -n sample-app-namespace docker-registry $SECRET_NAME \\",
62-
"--docker-server=https://$ACCOUNT.dkr.ecr.${var.aws_region}.amazonaws.com \\",
63-
"--docker-username=AWS \\",
64-
"--docker-password=\"$${TOKEN}\"",
59+
echo "LOG: Deleting secret if it exists"
60+
kubectl delete secret -n sample-app-namespace --ignore-not-found $SECRET_NAME
61+
echo "LOG: Creating secret for pulling sample app ECR"
62+
kubectl create secret -n sample-app-namespace docker-registry $SECRET_NAME \
63+
--docker-server=https://$ACCOUNT.dkr.ecr.${var.aws_region}.amazonaws.com \
64+
--docker-username=AWS \
65+
--docker-password="$${TOKEN}"
6566
6667
# Deploy sample app
67-
"echo \"LOG: Pulling sample app deployment files\"",
68-
"cd ~", # To ensure everything is downloaded into root directory so cleanup is easy
69-
"aws s3api get-object --bucket aws-appsignals-sample-app-prod-us-east-1 --key frontend-service-depl.yaml frontend-service-depl.yaml",
70-
"aws s3api get-object --bucket aws-appsignals-sample-app-prod-us-east-1 --key remote-service-depl.yaml remote-service-depl.yaml",
71-
"echo \"LOG: Applying sample app deployment files\"",
72-
"kubectl apply -f frontend-service-depl.yaml",
73-
"kubectl apply -f remote-service-depl.yaml",
68+
echo "LOG: Pulling sample app deployment files"
69+
cd ~", # To ensure everything is downloaded into root directory so cleanup is ea
70+
aws s3api get-object --bucket aws-appsignals-sample-app-prod-us-east-1 --key frontend-service-depl.yaml frontend-service-depl.yaml
71+
aws s3api get-object --bucket aws-appsignals-sample-app-prod-us-east-1 --key remote-service-depl.yaml remote-service-depl.yaml
72+
echo "LOG: Applying sample app deployment files"
73+
kubectl apply -f frontend-service-depl.yaml
74+
kubectl apply -f remote-service-depl.yaml
7475
7576
# Expose sample app on port 30100
76-
"echo \"LOG: Exposing main sample app on port 30100\"",
77-
"kubectl expose deployment sample-app-deployment-${var.test_id} -n sample-app-namespace --type=\"NodePort\" --port 8080",
78-
"kubectl patch service sample-app-deployment-${var.test_id} -n sample-app-namespace --type='json' --patch='[{\"op\": \"replace\", \"path\": \"/spec/ports/0/nodePort\", \"value\":30100}]'",
77+
echo "LOG: Exposing main sample app on port 30100"
78+
kubectl expose deployment sample-app-deployment-${var.test_id} -n sample-app-namespace --type="NodePort" --port 8080
79+
kubectl patch service sample-app-deployment-${var.test_id} -n sample-app-namespace --type='json' --patch='[{"op": "replace", "path": "/spec/ports/0/nodePort", "value":30100}]'
7980
8081
# Wait for sample app to be reach ready state
81-
"kubectl wait --for=condition=Ready --request-timeout '5m' pod --all -n sample-app-namespace",
82+
kubectl wait --for=condition=Ready --request-timeout '5m' pod --all -n sample-app-namespace
8283
8384
# Emit remote service pod IP
84-
"echo \"LOG: Outputting remote service pod IP to SSM using put-parameter API\"",
85-
"aws ssm put-parameter --region ${var.aws_region} --name remote-service-ip --type String --overwrite --value $(kubectl get pod --selector=app=remote-app -n sample-app-namespace -o jsonpath='{.items[0].status.podIP}')",
85+
echo "LOG: Outputting remote service pod IP to SSM using put-parameter API"
86+
aws ssm put-parameter --region ${var.aws_region} --name remote-service-ip --type String --overwrite --value $(kubectl get pod --selector=app=remote-app -n sample-app-namespace -o jsonpath='{.items[0].status.podIP}')
87+
88+
EOF
8689
]
8790
}
8891
}

0 commit comments

Comments
 (0)