Skip to content

Commit

Permalink
Adding "Mature Steps" back into the repo docs (#394)
Browse files Browse the repository at this point in the history
* Microsoft.OperationsManagement error

* Recreating the "mature steps"

* Linking to advanced scenarios

* Added  GitHub Action Workflow

* Added the helper component

* Update README.md

* Update README.md
  • Loading branch information
Gordon Byers committed Sep 13, 2022
1 parent 578d511 commit cb82e75
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,16 @@ Building a complete Kubernetes operational environment is hard work! __AKS Accel

![](docs/images/helper-deploy.jpg)

## Advanced Scenarios

The QuickStart provides a nice easy way of creating your AKS Environment, once you've done this it's likely you'll want to consume AKS Construction in a more [advanced scenario](docs/AdvancedUsage.md).

## Project components

### Helper

The Helper is a website that provides a guided experience to creating your AKS environment. It dynamically generates the parameters to call the IaC, and provides deployment options using the Azure CLI, GitHub Actions or Terraform.

### IaC - Bicep code files

IaC (Infrastructure as Code) code files have been modularised into their component areas. [Main.bicep](bicep/main.bicep) references them and they are expected to be present in the same directory. The Deployment Helper leverages an Arm json compiled version of all the bicep files.
Expand Down Expand Up @@ -79,6 +87,13 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

## FAQ / Troubleshooting

### Subscription is not registered to use namespace Microsoft.OperationsManagement

Azure Subscriptions use resource providers to be able to create Azure Services. Sometimes it can be the case that core RP's are not properly registered in your subscription. Take time to read the error message, and follow the steps to resolve. [https://docs.microsoft.com/azure/azure-resource-manager/troubleshooting/error-register-resource-provider?tabs=azure-cli](https://docs.microsoft.com/azure/azure-resource-manager/troubleshooting/error-register-resource-provider?tabs=azure-cli)


## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
Expand Down
23 changes: 23 additions & 0 deletions docs/AdvancedUsage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Advanced Usage

The [QuickStart](https://github.com/Azure/AKS-Construction#quickstart) provides a nice easy way of using the Azure CLI to create your AKS Environment. However once you've done this, and are more familiar with the tool, then you'll want to initiate AKS Construction is a sligtly more mature way.

## Level One - Your own Bicep file

1. Use the [Helper](https://azure.github.io/AKS-Construction/) to guide your AKS configuration.
1. Capture the parameters on the *Parameters File* tab to a file - this is your configuration
1. Grab the [latest release](https://github.com/Azure/AKS-Construction/releases) of the bicep code
1. Author an Application Main bicep to represent *your application* (see [here](../samples/SampleAppMain.bicep) for an example)
1. In your CI/CD system, either using one of the GitHub Action Workflow files as a base, or by coding it yourself - initiate a deployment of the bicep code, using your parameter file
1. In your CI/CD system, deploy your application(s) to the AKS cluster

## Level Two - GitHub Action Workflow

1. Use the [Helper](https://azure.github.io/AKS-Construction/) to guide your AKS configuration.
1. On the Deploy tab, navigate to the GitHub Actions tab
1. Paste your Workload/Infra GitHub Repo URL into the textbox
1. Inspect and run the script in the first script box to create an Identity in Azure and the secrets in your GitHub repo
1. In your repo, create a new file in your `.github/workflows` folder, pasting in the yaml from the GitHub Actions script box
1. Commit the file to your main branch
1. In your repo, navigate to the actions tab and initiate the new workflow
1. Inspect the created resources in your Azure Subscription

0 comments on commit cb82e75

Please sign in to comment.