Workflow documentation

.github/workflows/ByoVnetCI.yml

@@ -117,8 +117,7 @@ jobs:
   CostEstimate:
     needs: [ReusableWF, Validation]
     if: github.event_name != 'pull_request' ||  contains( github.event.pull_request.labels.*.name, 'test-deploy-byoconfig')
-    uses: TheCloudTheory/arm-estimator/.github/workflows/estimateFromUrl.yml@main
-    #uses: Gordonby/arm-estimator/.github/workflows/estimateFromUrl.yml@gb-workflowpolish
+    uses: TheCloudTheory/arm-estimator/.github/workflows/[email protected]
     with:
       rg: ${{ needs.ReusableWF.outputs.RG }}
       environment: ${{needs.ReusableWF.outputs.Environment}}

.github/workflows/ByoVnetPrivateCI.yml

@@ -127,14 +127,12 @@ jobs:
   CostEstimate:
     needs: [ReusableWF]
     if: github.event_name != 'pull_request' || contains( github.event.pull_request.labels.*.name, 'test-deploy-privateconfig')
-    uses: TheCloudTheory/arm-estimator/.github/workflows/estimateFromUrl.yml@main
-    #uses: Gordonby/arm-estimator/.github/workflows/estimateFromUrl.yml@gb-workflowpolish
+    uses: TheCloudTheory/arm-estimator/.github/workflows/[email protected]
     with:
       rg: ${{ needs.ReusableWF.outputs.RG }} #Automation-Actions-AksDeployCI #'${{ env.RG }}' There seems to be an issue passing Env variables in reusable workflows
       environment: ${{needs.ReusableWF.outputs.Environment}}
       aceVersion: 1.1-beta2
       templateFileURL: https://github.com/Azure/AKS-Construction/releases/download/${{ needs.ReusableWF.outputs.LatestAkscVersionTag }}/main.json
-      #templateParamFileURL: ${{ needs.ReusableWF.outputs.ParamFilePath }}
       templateParamFileURL: https://raw.githubusercontent.com/Azure/AKS-Construction/${{ github.event_name == 'pull_request' && github.head_ref || github.ref_name }}/${{ needs.ReusableWF.outputs.ParamFilePath }}
 
     secrets:

samples/workflows/README.md

@@ -0,0 +1,30 @@
+# Workflow docs
+
+The AKS Construction repository uses GitHub action workflows extensively, in particular we use reusable workflows to expose common reusable workflows that can be leveraged from your own workflows.
+
+In this section of the samples, various features and workflow jobs will be explained.
+
+## Infrastructure Workflows
+
+### InfraCI - Starter cluster
+
+This workflow is one of the simplest for showing the fundamental steps of a IaC workflow.
+
+1. Validation
+1. Infra Deployment
+1. App Deployment (smoke test)
+1. Infra Cleanup/Destruction
+
+## Reusable Workflows
+
+Workflow | Purpose | Sample
+-------- | ------- | ------
+Deploy | Deploys AKSC infrastructure with minimal inputs |
+Troubleshooting | |
+CleanUp | Iterates over a resource group and removes all resources
+
+## Job Showcase
+
+Job | Purpose | Sample
+--- | ------- | ------
+Azure Cost Estimate | Estimates the monthly cost of an Azure Deployment | [sample](azureCostEstimator.md)

samples/workflows/azureCostEstimator.md

@@ -0,0 +1,12 @@
+# ACE (Azure Cost Estimator)
+
+[ACE](https://github.com/TheCloudTheory/arm-estimator) is a project created by Microsoft MVP [Kamil Mrzygłód](https://github.com/kamil-mrzyglod). It provides a mechanism to take a bicep/arm file with parameters and provide an estimated monthly cost of the deployment.
+
+AKS Construction leverages ACE in two of the deployment workflows to showcase more advanced Infrastructure as Code practices that can be incorporated into workflows.
+
+## The output
+
+In addition to the job output, we persist a json file as an artifact. We could choose to query the costs and fail the workflow if the cost was too high.
+
+## Adding the workflow
+