Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(ci): use action-oc-runner in action.yml #101

Merged
merged 15 commits into from
Jan 28, 2025
Merged

chore(ci): use action-oc-runner in action.yml #101

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
4cac86a
chore(ci): use action-oc-runner in action.yml
DerekRoberts Jan 23, 2025
377ed6f
Always checkout code
DerekRoberts Jan 23, 2025
00ec6c1
Always checkout code
DerekRoberts Jan 23, 2025
b753f3c
Conflicting job ids
DerekRoberts Jan 23, 2025
6a8cbfc
Remove extra oc logins
DerekRoberts Jan 23, 2025
7c3412c
Remove extra oc logins
DerekRoberts Jan 23, 2025
aac8942
Use action for triggers
DerekRoberts Jan 23, 2025
5cb9096
Roll oc setup and vars together
DerekRoberts Jan 23, 2025
ae358fb
Move ImageStream handling into own step
DerekRoberts Jan 23, 2025
7a22b20
Cleanup
DerekRoberts Jan 23, 2025
6689a58
Find deployments, not pass them
DerekRoberts Jan 23, 2025
b3e619b
Find URL_HOST_PATH, not pass
DerekRoberts Jan 23, 2025
baa1528
Replace needs conditionals with action triggers
DerekRoberts Jan 28, 2025
f98b3ad
Replace needs conditionals with action triggers
DerekRoberts Jan 28, 2025
6fec5fa
Output trigger from deploy job
DerekRoberts Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
243 changes: 113 additions & 130 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ inputs:
repository:
description: Optionally, specify a different repo to clone
default: ${{ github.repository }}

verification_retry_attempts:
description: Number of times to attempt deployment verification
default: "3"
Expand All @@ -69,7 +68,7 @@ inputs:
outputs:
triggered:
description: Did a deployment trigger? [true|false]
value: ${{ steps.diff.outputs.triggered }}
value: ${{ steps.deploy.outputs.triggered }}

runs:
using: composite
Expand Down Expand Up @@ -97,146 +96,130 @@ runs:
exit 1
fi

# Send triggers to diff action
- id: diff
uses: bcgov/[email protected]
- uses: actions/checkout@v4
with:
triggers: ${{ inputs.triggers }}
diff_branch: ${{ inputs.diff_branch }}
repository: ${{ inputs.repository }}

# Override OpenShift version, if specified
- name: Install CLI tools from OpenShift Mirror
uses: redhat-actions/openshift-tools-installer@v1
- uses: bcgov/[email protected]
with:
oc: ${{ inputs.oc_version || '4' }}

# Process variables and inputs
# Remote/override repo is required if one has been specified (input)
- name: Checkout remote/override repo
if: github.repository != inputs.repository
uses: actions/checkout@v4
oc_namespace: ${{ inputs.oc_namespace }}
oc_token: ${{ inputs.oc_token }}
oc_server: ${{ inputs.oc_server }}
triggers: ${{ inputs.triggers }}
commands: |
# Remove any conflicting ImageStreams

# Process template, consuming variables/parameters
TEMPLATE="$(oc process -f ${{ inputs.file }} ${{ inputs.parameters }} --local)"

# Clean any previous ImageStreams
IS=$(jq -rn "${TEMPLATE} | .items[] | select(.kind==\"ImageStream\").metadata.name //empty")
IFS=" " read -ra IS <<< "${IS}"
for i in "${IS[@]}"
do
[ ! $(oc get is -o name | grep ^imagestream.image.openshift.io/${i}$) ]|| oc delete is/${i}
done

- uses: bcgov/[email protected]
id: deploy
with:
repository: ${{ inputs.repository }}
- id: vars
shell: bash
run: |
# Expand for inputs and variables
set -eu
oc_namespace: ${{ inputs.oc_namespace }}
oc_token: ${{ inputs.oc_token }}
oc_server: ${{ inputs.oc_server }}
triggers: ${{ inputs.triggers }}
commands: |
# Expand for deployment steps

# Allow pipefail, since we could be catching oc create errors
set +o pipefail

# Apply (overwrites) or create (does not overwrite) using processed template
TEMPLATE="$(oc process -f ${{ inputs.file }} ${{ inputs.parameters }} --local)"
if [ "${{ inputs.overwrite }}" == "true" ]; then
oc apply --timeout=${{ inputs.timeout || '15m' }} -f - <<< "${TEMPLATE}"
else
# Suppress AlreadyExists errors and expected failure
oc create -f - 2>&1 <<< "${TEMPLATE}" | sed 's/.*: //'
fi

# Process template, consuming variables/parameters
TEMPLATE="$(oc process -f ${{ inputs.file }} ${{ inputs.parameters }} --local)"

# ImageStream, Deployment and Route Host from template (note: DeploymentConfig is deprecated, but still supported)
DDC=$(jq -rn "${TEMPLATE} | .items[] | select([.kind] | inside([\"Deployment\", \"DeploymentConfig\"])).metadata.name //empty")
IS=$(jq -rn "${TEMPLATE} | .items[] | select(.kind==\"ImageStream\").metadata.name //empty")
echo imageStream=${IS} >> $GITHUB_OUTPUT
echo deployment=${DDC} >> $GITHUB_OUTPUT

# Output URL (host + path), but only if ROUTE_HOST is populated
ROUTE_HOST=$(jq -rn "${TEMPLATE} | .items[] | select(.kind==\"Route\").spec.host //empty")
if [ ! -z ${ROUTE_HOST} ]; then
# Path from inputs takes priority over template
ROUTE_PATH=${{ inputs.verification_path }}
[ ! -z ${ROUTE_PATH} ]|| \
ROUTE_PATH=$(jq -rn "${TEMPLATE} | .items[] | select(.kind==\"Route\").spec.path //empty")

# Remove any duplicate slashes and pass to GITHUB_OUTPUT
echo url="${ROUTE_HOST}/${ROUTE_PATH}" | sed 's // / g' >> $GITHUB_OUTPUT
fi
# Deployment and Route Host from template (note: DeploymentConfig is deprecated, but still supported)
DDC="$(jq -rn "${TEMPLATE} | .items[] | select([.kind] | inside([\"Deployment\", \"DeploymentConfig\"])).metadata.name //empty")"

- name: Deploy
if: steps.diff.outputs.triggered == 'true'
shell: bash
run: |
# Expand for deployment steps

# Allow pipefail, since we could be catching oc create errors
set +o pipefail

oc login --token=${{ inputs.oc_token }} --server=${{ inputs.oc_server }}
oc project ${{ inputs.oc_namespace }} #Safeguard!

# Clean any previous ImageStreams
IFS=" " read -ra IS <<< "${{ steps.vars.outputs.imageStream }}"
for i in "${IS[@]}"
do
[ ! $(oc get is -o name | grep ^imagestream.image.openshift.io/${i}$) ]|| oc delete is/${i}
done

# Apply (overwrites) or create (does not overwrite) using processed template
TEMPLATE="$(oc process -f ${{ inputs.file }} ${{ inputs.parameters }} --local)"
if [ "${{ inputs.overwrite }}" == "true" ]; then
oc apply --timeout=${{ inputs.timeout || '15m' }} -f - <<< "${TEMPLATE}"
else
# Suppress AlreadyExists errors and expected failure
oc create -f - 2>&1 <<< "${TEMPLATE}" | sed 's/.*: //'
fi
# Follow any active rollouts; temporary support for DeploymentConfigs
if [ ! -z "${DDC}" ]&&[ ! -z $(oc get deployment ${DDC} -o name --ignore-not-found) ]; then
oc rollout status deployment/${DDC} -w
elif [ ! -z "${DDC}" ]&&[ ! -z $(oc get deploymentconfig ${DDC} -o name --ignore-not-found) ]; then
oc rollout status deploymentconfig/${DDC} -w
fi

# Follow any active rollouts; temporary support for DeploymentConfigs
DDC=${{ steps.vars.outputs.deployment }}
if [ ! -z "${DDC}" ]&&[ ! -z $(oc get deployment ${DDC} -o name --ignore-not-found) ]; then
# oc rollout restart deployment/${DDC}
oc rollout status deployment/${DDC} -w
elif [ ! -z "${DDC}" ]&&[ ! -z $(oc get deploymentconfig ${DDC} -o name --ignore-not-found) ]; then
oc rollout status deploymentconfig/${DDC} -w
fi

- name: Route Verification
if: steps.vars.outputs.url &&
( steps.diff.outputs.triggered == 'true' )
shell: bash
run: |
# Expand for route verification
- uses: bcgov/[email protected]
with:
oc_namespace: ${{ inputs.oc_namespace }}
oc_token: ${{ inputs.oc_token }}
oc_server: ${{ inputs.oc_server }}
triggers: ${{ inputs.triggers }}
commands: |
# Expand for route verification

# Process template, consuming variables/parameters
TEMPLATE="$(oc process -f ${{ inputs.file }} ${{ inputs.parameters }} --local)"

# Output URL (host + path), but only if ROUTE_HOST is populated
ROUTE_HOST=$(jq -rn "${TEMPLATE} | .items[] | select(.kind==\"Route\").spec.host //empty")
if [ ! -z ${ROUTE_HOST} ]; then
# Path from inputs takes priority over template
ROUTE_PATH=${{ inputs.verification_path }}
[ ! -z ${ROUTE_PATH} ]|| \
ROUTE_PATH=$(jq -rn "${TEMPLATE} | .items[] | select(.kind==\"Route\").spec.path //empty")

# Remove any duplicate slashes and pass to GITHUB_OUTPUT
URL=$(echo "${ROUTE_HOST}/${ROUTE_PATH}" | sed 's // / g')
fi

# Check for URL (route + path)
URL_HOST_PATH=${{ steps.vars.outputs.url }}
if [ -z "${URL_HOST_PATH}" ]; then
echo "No route found. Skipping."
exit 0
fi
echo -e "URL: http://${URL_HOST_PATH}"

# Curl and verify
TRIES="${{ inputs.verification_retry_attempts }} || 3"
SECONDS="${{ inputs.verification_retry_seconds }} || 10"
for (( i=0; i<"${TRIES}"; i++ )); do
HTTP_CODE=$(curl -Lso /dev/null -w "%{http_code}" "${URL_HOST_PATH}")
if [ "${HTTP_CODE}" -eq 200 ]; then
echo -e "Route verification successful!\n"
# Check for URL (route + path)
URL_HOST_PATH=${URL:-}
if [ -z "${URL_HOST_PATH}" ]; then
echo "No route found. Skipping."
exit 0
fi
echo -e "HTTP_CODE:${HTTP_CODE}, Try: #${i}"
sleep "${SECONDS}"
done
echo -e "\nRoute verification failed"
exit 1
echo -e "URL: http://${URL_HOST_PATH}"

# Curl and verify
TRIES="${{ inputs.verification_retry_attempts }} || 3"
SECONDS="${{ inputs.verification_retry_seconds }} || 10"
for (( i=0; i<"${TRIES}"; i++ )); do
HTTP_CODE=$(curl -Lso /dev/null -w "%{http_code}" "${URL_HOST_PATH}")
if [ "${HTTP_CODE}" -eq 200 ]; then
echo -e "Route verification successful!\n"
exit 0
fi
echo -e "HTTP_CODE:${HTTP_CODE}, Try: #${i}"
sleep "${SECONDS}"
done
echo -e "\nRoute verification failed"
exit 1

- name: Post-Deployment
if: inputs.post_rollout != '' && steps.diff.outputs.triggered == 'true'
shell: bash
run: |
# Expand for post-deployment steps (optional)

# Allow pipefail, since we could be catching oc create errors
set +o pipefail

oc login --token=${{ inputs.oc_token }} --server=${{ inputs.oc_server }}
oc project ${{ inputs.oc_namespace }} #Safeguard!

# Run post deployment command
${{ inputs.post_rollout }}

- if: inputs.delete_completed == 'true' && steps.diff.outputs.triggered == 'true'
shell: bash
run: |
# Expand for succeeded pod cleanup (optional)

# Pod Cleanup
oc login --token=${{ inputs.oc_token }} --server=${{ inputs.oc_server }}
oc project ${{ inputs.oc_namespace }} #Safeguard!
- uses: bcgov/[email protected]
if: inputs.post_rollout != ''
with:
oc_namespace: ${{ inputs.oc_namespace }}
oc_token: ${{ inputs.oc_token }}
oc_server: ${{ inputs.oc_server }}
triggers: ${{ inputs.triggers }}
commands: |
# Run post deployment command (optional)
${{ inputs.post_rollout }}

# Cleanup completed pods
oc delete po --field-selector=status.phase==Succeeded
- uses: bcgov/[email protected]
if: inputs.delete_completed == 'true'
with:
oc_namespace: ${{ inputs.oc_namespace }}
oc_token: ${{ inputs.oc_token }}
oc_server: ${{ inputs.oc_server }}
triggers: ${{ inputs.triggers }}
commands: |
# Cleanup completed pods
oc delete po --field-selector=status.phase==Succeeded

# Action repo needs to be present for cleanup/tests
- name: Checkout local repo to make sure action.yml is present
Expand Down