Deploy Infrastructure #8
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Infrastructure | |
| # Deploy after CI succeeds on main, or allow manual execution. | |
| on: | |
| workflow_run: | |
| workflows: [CI] | |
| types: [completed] | |
| branches: [main] | |
| workflow_dispatch: | |
| # Prevent overlapping infrastructure deployments. | |
| # Do not cancel an active deployment, since OpenTofu may be modifying resources. | |
| concurrency: | |
| group: infrastructure-deployment | |
| cancel-in-progress: false | |
| permissions: | |
| contents: read | |
| jobs: | |
| deploy-test: | |
| name: Deploy TEST | |
| # Only deploy after successful CI on a push to main, | |
| # or when manually triggered from main. | |
| if: >- | |
| (github.event_name == 'workflow_run' && | |
| github.event.workflow_run.conclusion == 'success' && | |
| github.event.workflow_run.event == 'push' && | |
| github.event.workflow_run.head_branch == 'main') || | |
| (github.event_name == 'workflow_dispatch' && | |
| github.ref == 'refs/heads/main') | |
| runs-on: [self-hosted, linux, assignment2] | |
| timeout-minutes: 45 | |
| environment: TEST | |
| # Authenticate to SkyHiGh using environment-specific credentials. | |
| env: | |
| OS_AUTH_TYPE: v3applicationcredential | |
| OS_AUTH_URL: ${{ vars.OS_AUTH_URL }} | |
| OS_REGION_NAME: ${{ vars.OS_REGION_NAME }} | |
| OS_IDENTITY_API_VERSION: "3" | |
| OS_INTERFACE: public | |
| OS_APPLICATION_CREDENTIAL_ID: ${{ secrets.OS_APPLICATION_CREDENTIAL_ID }} | |
| OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.OS_APPLICATION_CREDENTIAL_SECRET }} | |
| KOPS_STATE_STORE: swift://demo-kops | |
| steps: | |
| # Checkout the exact commit validated by CI. | |
| - name: Checkout | |
| uses: actions/checkout@v5 | |
| with: | |
| ref: ${{ github.event_name == 'workflow_run' && github.event.workflow_run.head_sha || github.sha }} | |
| persist-credentials: false | |
| # Use the same OpenTofu version as the CI workflow. | |
| - name: Setup OpenTofu | |
| uses: opentofu/setup-opentofu@v2 | |
| with: | |
| tofu_version: "1.12.6" | |
| tofu_wrapper: false | |
| # Verify OpenTofu, credentials, and TEST stack configurations. | |
| - name: Preflight checks | |
| shell: bash | |
| run: | | |
| tofu version | |
| test -f environments/test/network/providers.tf | |
| test -f environments/test/frontend/providers.tf | |
| : "${OS_AUTH_URL:?Missing OS_AUTH_URL}" | |
| : "${OS_REGION_NAME:?Missing OS_REGION_NAME}" | |
| : "${OS_APPLICATION_CREDENTIAL_ID:?Missing application credential ID}" | |
| : "${OS_APPLICATION_CREDENTIAL_SECRET:?Missing application credential secret}" | |
| echo "TEST deployment prerequisites are configured." | |
| # Install tools into the job's temporary directory. | |
| - name: Install kOps and kubectl | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| BIN_DIR="$RUNNER_TEMP/tofu-tools" | |
| mkdir -p "$BIN_DIR" | |
| # Kubernetes API server | |
| KUBECTL_VERSION="v1.36.4" | |
| curl -fsSL -o "$BIN_DIR/kubectl" \ | |
| "https://dl.k8s.io/release/${KUBECTL_VERSION}/bin/linux/amd64/kubectl" | |
| curl -fsSL -o "$BIN_DIR/kubectl.sha256" \ | |
| "https://dl.k8s.io/release/${KUBECTL_VERSION}/bin/linux/amd64/kubectl.sha256" | |
| ( | |
| cd "$BIN_DIR" | |
| echo "$(cat kubectl.sha256) kubectl" | sha256sum --check | |
| ) | |
| # Download kOps and verify its checksum. | |
| KOPS_VERSION="v1.36.2" | |
| curl -fsSL -o "$BIN_DIR/kops" \ | |
| "https://github.com/kubernetes/kops/releases/download/${KOPS_VERSION}/kops-linux-amd64" | |
| curl -fsSL -o "$BIN_DIR/kops.sha256" \ | |
| "https://github.com/kubernetes/kops/releases/download/${KOPS_VERSION}/kops-linux-amd64.sha256" | |
| ( | |
| cd "$BIN_DIR" | |
| echo "$(cat kops.sha256) kops" | sha256sum --check | |
| ) | |
| chmod +x "$BIN_DIR/kubectl" "$BIN_DIR/kops" | |
| # Make both tools available to subsequent steps. | |
| echo "$BIN_DIR" >> "$GITHUB_PATH" | |
| - name: Verify installed tools | |
| shell: bash | |
| run: | | |
| kops version | |
| kubectl version --client | |
| - name: Verify kOps state store access | |
| shell: bash | |
| env: | |
| # Override TEST deployment credentials for this step only. | |
| OS_APPLICATION_CREDENTIAL_ID: ${{ secrets.KOPS_APPLICATION_CREDENTIAL_ID }} | |
| OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.KOPS_APPLICATION_CREDENTIAL_SECRET }} | |
| run: | | |
| set -euo pipefail | |
| : "${OS_APPLICATION_CREDENTIAL_ID:?Missing kOps credential ID}" | |
| : "${OS_APPLICATION_CREDENTIAL_SECRET:?Missing kOps credential secret}" | |
| : "${KOPS_STATE_STORE:?Missing kOps state store}" | |
| kops get clusters --state="$KOPS_STATE_STORE" | |
| kops get cluster einalien.k8s.local \ | |
| --state="$KOPS_STATE_STORE" > /dev/null | |
| echo "kOps state store access verified." | |
| # Generate short-lived Kubernetes credentials. | |
| - name: Generate Kubernetes kubeconfig | |
| shell: bash | |
| env: | |
| OS_APPLICATION_CREDENTIAL_ID: ${{ secrets.KOPS_APPLICATION_CREDENTIAL_ID }} | |
| OS_APPLICATION_CREDENTIAL_SECRET: ${{ secrets.KOPS_APPLICATION_CREDENTIAL_SECRET }} | |
| run: | | |
| set -euo pipefail | |
| KUBECONFIG_FILE="$RUNNER_TEMP/assignment2-kubeconfig" | |
| umask 077 | |
| kops export kubeconfig einalien.k8s.local \ | |
| --admin=1h \ | |
| --state="$KOPS_STATE_STORE" \ | |
| --kubeconfig="$KUBECONFIG_FILE" | |
| test -s "$KUBECONFIG_FILE" | |
| chmod 600 "$KUBECONFIG_FILE" | |
| # Verify that the generated configuration contains a cluster context. | |
| KUBECONFIG="$KUBECONFIG_FILE" kubectl config current-context | |
| # Make the kubeconfig available to subsequent steps. | |
| echo "KUBECONFIG=$KUBECONFIG_FILE" >> "$GITHUB_ENV" | |
| echo "KUBE_CONFIG_PATH=$KUBECONFIG_FILE" >> "$GITHUB_ENV" | |
| # Confirm that the runner can communicate with Kubernetes. | |
| - name: Verify Kubernetes state access | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| kubectl --request-timeout=15s get --raw=/readyz | |
| kubectl --request-timeout=15s get namespace iac | |
| # Check the permissions required by the state backend. | |
| kubectl auth can-i get secrets -n iac --quiet | |
| kubectl auth can-i create leases.coordination.k8s.io -n iac --quiet | |
| echo "Kubernetes state backend access verified." | |
| # Verify OpenTofu can access existing TEST remote state. | |
| - name: Verify TEST remote state | |
| shell: bash | |
| run: | | |
| set -euo pipefail | |
| for STACK in network frontend; do | |
| STACK_DIR="environments/test/$STACK" | |
| echo "Initializing TEST $STACK backend..." | |
| tofu -chdir="$STACK_DIR" init \ | |
| -reconfigure \ | |
| -input=false \ | |
| -lockfile=readonly \ | |
| -no-color | |
| echo "Reading TEST $STACK state..." | |
| RESOURCES="$(tofu -chdir="$STACK_DIR" state list)" | |
| if [ -z "$RESOURCES" ]; then | |
| echo "ERROR: No managed resources found in TEST $STACK state." | |
| exit 1 | |
| fi | |
| RESOURCE_COUNT="$(printf '%s\n' "$RESOURCES" | wc -l)" | |
| echo "TEST $STACK: $RESOURCE_COUNT managed resources found." | |
| done | |
| echo "TEST remote state access verified." | |
| # Plan and automatically apply safe TEST infrastructure changes. | |
| - name: Deploy TEST infrastructure | |
| shell: bash | |
| env: | |
| TF_IN_AUTOMATION: "true" | |
| TF_VAR_admin_cidr: ${{ secrets.ADMIN_CIDR }} | |
| TF_VAR_ssh_key_name: ${{ vars.SSH_KEY_NAME }} | |
| run: | | |
| set -euo pipefail | |
| umask 077 | |
| # Verify required variables and configuration files. | |
| : "${TF_VAR_admin_cidr:?Missing ADMIN_CIDR secret}" | |
| : "${TF_VAR_ssh_key_name:?Missing SSH_KEY_NAME variable}" | |
| test -f environments/test/network/deployment.tfvars | |
| test -f environments/test/frontend/deployment.tfvars | |
| # Deploy network before frontend. | |
| for STACK in network frontend; do | |
| STACK_DIR="environments/test/$STACK" | |
| PLAN_FILE="$RUNNER_TEMP/test-$STACK.tfplan" | |
| PLAN_JSON="$RUNNER_TEMP/test-$STACK.plan.json" | |
| PLAN_LOG="$RUNNER_TEMP/test-$STACK.plan.log" | |
| APPLY_LOG="$RUNNER_TEMP/test-$STACK.apply.log" | |
| echo "::group::Deploy TEST $STACK" | |
| # Generate a saved plan. | |
| set +e | |
| tofu -chdir="$STACK_DIR" plan \ | |
| -var-file="deployment.tfvars" \ | |
| -out="$PLAN_FILE" \ | |
| -input=false \ | |
| -no-color \ | |
| -lock-timeout=5m \ | |
| -detailed-exitcode > "$PLAN_LOG" 2>&1 | |
| EXIT_CODE=$? | |
| set -e | |
| # Handle planning errors. | |
| if [ "$EXIT_CODE" -ne 0 ] && [ "$EXIT_CODE" -ne 2 ]; then | |
| echo "::error::TEST $STACK planning failed." | |
| exit 1 | |
| fi | |
| # Skip apply when there are no changes. | |
| if [ "$EXIT_CODE" -eq 0 ]; then | |
| echo "TEST $STACK: No changes required." | |
| echo "::endgroup::" | |
| continue | |
| fi | |
| # Convert the saved plan into JSON for inspection. | |
| test -s "$PLAN_FILE" | |
| tofu -chdir="$STACK_DIR" show -json \ | |
| "$PLAN_FILE" > "$PLAN_JSON" | |
| # Only allow known non-destructive resource actions. | |
| if ! jq -e ' | |
| (.format_version | type == "string") and | |
| (.resource_changes | type == "array") and | |
| all(.resource_changes[]?; | |
| (.change.actions == ["no-op"] or | |
| .change.actions == ["read"] or | |
| .change.actions == ["create"] or | |
| .change.actions == ["update"]) | |
| ) | |
| ' "$PLAN_JSON" > /dev/null; then | |
| echo "::error::TEST $STACK contains invalid or destructive changes." | |
| echo "Automatic apply has been blocked." | |
| exit 1 | |
| fi | |
| # Display resource actions without exposing configuration values. | |
| echo "Planned TEST $STACK changes:" | |
| jq -r ' | |
| .resource_changes[]? | |
| | select(.change.actions != ["no-op"]) | |
| | "\(.address): \(.change.actions | join(", "))" | |
| ' "$PLAN_JSON" | |
| # Apply the exact saved plan. | |
| echo "Applying TEST $STACK..." | |
| if ! tofu -chdir="$STACK_DIR" apply \ | |
| -input=false \ | |
| -no-color \ | |
| -lock-timeout=5m \ | |
| "$PLAN_FILE" > "$APPLY_LOG" 2>&1; then | |
| echo "::error::TEST $STACK apply failed." | |
| exit 1 | |
| fi | |
| echo "TEST $STACK deployed successfully." | |
| echo "::endgroup::" | |
| done | |
| echo "TEST infrastructure deployment completed." | |
| # Remove temporary credentials, saved plans and logs. | |
| - name: Clean up temporary files | |
| if: always() | |
| shell: bash | |
| run: | | |
| rm -f "$RUNNER_TEMP/assignment2-kubeconfig" | |
| rm -f "$RUNNER_TEMP"/test-*.tfplan | |
| rm -f "$RUNNER_TEMP"/test-*.plan.json | |
| rm -f "$RUNNER_TEMP"/test-*.plan.log | |
| rm -f "$RUNNER_TEMP"/test-*.apply.log |