Skip to content

Commit 016481d

Browse files
matifalimatifali
committed
Add Instatus integration for module checks
- Introduced environment variables for Instatus API. - Automated component status updates and incident creation. - Ensured environment variables are set before proceeding. - Enhanced module accessibility checks with detailed output.
2 parents 728992b + 5101c27 commit 016481d

File tree

3 files changed

+94
-13
lines changed

3 files changed

+94
-13
lines changed

‎.github/scripts/check.sh

+84-7
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,85 @@
11
#!/usr/bin/env bash
22
set -o pipefail
3-
REGISTRY_BASE_URL="${REGISTRY_BASE_URL:-https://registry.coder.com}"
43
set -u
54

6-
if [[ -n "${VERBOSE:-}" ]]; then
7-
set -x
8-
fi
5+
# List of required environment variables
6+
required_vars=(
7+
"INSTATUS_API_KEY"
8+
"INSTATUS_PAGE_ID"
9+
"INSTATUS_COMPONENT_ID"
10+
)
11+
12+
# Check if each required variable is set
13+
for var in "${required_vars[@]}"; do
14+
if [[ -z "${!var:-}" ]]; then
15+
echo "Error: Environment variable '$var' is not set."
16+
exit 1
17+
fi
18+
done
19+
20+
REGISTRY_BASE_URL="${REGISTRY_BASE_URL:-https://registry.coder.com}"
921

1022
status=0
1123
declare -a modules=()
1224
declare -a failures=()
25+
26+
# Collect all module directories containing a main.tf file
1327
for path in $(find . -not -path '*/.*' -type f -name main.tf -maxdepth 2 | cut -d '/' -f 2 | sort -u); do
1428
modules+=("${path}")
1529
done
30+
1631
echo "Checking modules: ${modules[*]}"
32+
33+
# Function to update the component status on Instatus
34+
update_component_status() {
35+
local component_status=$1
36+
# see https://instatus.com/help/api/components
37+
(curl -X PUT "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/components/$INSTATUS_COMPONENT_ID" \
38+
-H "Authorization: Bearer $INSTATUS_API_KEY" \
39+
-H "Content-Type: application/json" \
40+
-d "{\"status\": \"$component_status\"}")
41+
}
42+
43+
# Function to create an incident
44+
create_incident() {
45+
local incident_name="Testing Instatus"
46+
local message="The following modules are experiencing issues:\n"
47+
for i in "${!failures[@]}"; do
48+
message+="$(($i + 1)). ${failures[$i]}\n"
49+
done
50+
51+
component_status="PARTIALOUTAGE"
52+
if (( ${#failures[@]} == ${#modules[@]} )); then
53+
component_status="MAJOROUTAGE"
54+
fi
55+
# see https://instatus.com/help/api/incidents
56+
response=$(curl -s -X POST "https://api.instatus.com/v1/$INSTATUS_PAGE_ID/incidents" \
57+
-H "Authorization: Bearer $INSTATUS_API_KEY" \
58+
-H "Content-Type: application/json" \
59+
-d "{
60+
\"name\": \"$incident_name\",
61+
\"message\": \"$message\",
62+
\"components\": [\"$INSTATUS_COMPONENT_ID\"],
63+
\"status\": \"INVESTIGATING\",
64+
\"notify\": true,
65+
\"statuses\": [
66+
{
67+
\"id\": \"$INSTATUS_COMPONENT_ID\",
68+
\"status\": \"PARTIALOUTAGE\"
69+
}
70+
]
71+
}")
72+
73+
incident_id=$(echo "$response" | jq -r '.id')
74+
echo "$incident_id"
75+
}
76+
77+
# Check each module's accessibility
1778
for module in "${modules[@]}"; do
1879
# Trim leading/trailing whitespace from module name
1980
module=$(echo "${module}" | xargs)
2081
url="${REGISTRY_BASE_URL}/modules/${module}"
21-
printf "=== Check module %s at %s\n" "${module}" "${url}"
82+
printf "=== Checking module %s at %s\n" "${module}" "${url}"
2283
status_code=$(curl --output /dev/null --head --silent --fail --location "${url}" --retry 3 --write-out "%{http_code}")
2384
# shellcheck disable=SC2181
2485
if (( status_code != 200 )); then
@@ -30,7 +91,23 @@ for module in "${modules[@]}"; do
3091
fi
3192
done
3293

33-
if (( status != 0 )); then
34-
echo "The following modules appear to have issues: ${failures[*]}"
94+
# Determine overall status and update Instatus component
95+
if (( status == 0 )); then
96+
echo "All modules are operational."
97+
# set to
98+
update_component_status "OPERATIONAL"
99+
else
100+
echo "The following modules have issues: ${failures[*]}"
101+
# check if all modules are down
102+
if (( ${#failures[@]} == ${#modules[@]} )); then
103+
update_component_status "MAJOROUTAGE"
104+
else
105+
update_component_status "PARTIALOUTAGE"
106+
fi
107+
108+
# Create a new incident
109+
incident_id=$(create_incident)
110+
echo "Created incident with ID: $incident_id"
35111
fi
112+
36113
exit "${status}"

‎.github/workflows/check.yaml

+5-1
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@ jobs:
1111

1212
steps:
1313
- name: Checkout repository
14-
uses: actions/checkout@v2
14+
uses: actions/checkout@v4
1515

1616
- name: Run check.sh
1717
run: |
1818
./.github/scripts/check.sh
19+
env:
20+
INSTATUS_API_KEY: ${{ secrets.INSTATUS_API_KEY }}
21+
INSTATUS_PAGE_ID: ${{ secrets.INSTATUS_PAGE_ID }}
22+
INSTATUS_COMPONENT_ID: ${{ secrets.INSTATUS_COMPONENT_ID }}

‎amazon-dcv-windows/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ Enable DCV Server and Web Client on Windows workspaces.
1616

1717
```tf
1818
module "dcv" {
19-
count = data.coder_workspace.me.start_count
20-
source = "registry.coder.com/modules/amazon-dcv-windows/coder"
21-
version = "1.0.24"
22-
agent_id = resource.coder_agent.main.id
19+
count = data.coder_workspace.me.start_count
20+
source = "registry.coder.com/modules/amazon-dcv-windows/coder"
21+
version = "1.0.24"
22+
agent_id = resource.coder_agent.main.id
2323
}
2424
2525
@@ -45,4 +45,4 @@ resource "coder_metadata" "dcv" {
4545

4646
## License
4747

48-
Amazon DCV is free to use on AWS EC2 instances but requires a license for other cloud providers. Please see the instructions [here](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-license.html#setting-up-license-ec2) for more information.
48+
Amazon DCV is free to use on AWS EC2 instances but requires a license for other cloud providers. Please see the instructions [here](https://docs.aws.amazon.com/dcv/latest/adminguide/setting-up-license.html#setting-up-license-ec2) for more information.

0 commit comments

Comments
 (0)