Skip to content

Commit

Permalink
add instructions to readme (#35)
Browse files Browse the repository at this point in the history
  • Loading branch information
mosabami authored Apr 16, 2024
1 parent cb85228 commit 8d73f77
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
<!-- BEGIN_TF_DOCS -->
# terraform-azurerm-avm-template
# terraform-azurerm-avm-ptn-aks-production

This is a template repo for Terraform Azure Verified Modules.
### NOTE: This module follows the semantic versioning and versions prior to 1.0.0 should be consider pre-release versions.

Things to do:
This is the Production Standard for AKS pattern module for [Azure Verified Modules (AVM)](https://azure.github.io/Azure-Verified-Modules/) library. This module deploys a production standard AKS cluster along with supporting a Virtual Network and Azure container registry. It provisions an environment sufficient for most production deployments for AKS. It leverages the AzureRM provider and sets a number of initial defaults to minimize the overall inputs for simple configurations.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. A module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to <https://semver.org/>

## Deployment Steps

1. Set up a GitHub repo environment called `test`.
1. Configure environment protection rule to ensure that approval is required before deploying to this environment.
Expand All @@ -16,8 +20,6 @@ Things to do:
1. AZURE\_SUBSCRIPTION\_ID
1. Search and update TODOs within the code and remove the TODO comments once complete.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. A module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to <https://semver.org/>

<!-- markdownlint-disable MD033 -->
## Requirements

Expand Down
13 changes: 8 additions & 5 deletions _header.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
# terraform-azurerm-avm-template
# terraform-azurerm-avm-ptn-aks-production

This is a template repo for Terraform Azure Verified Modules.
### NOTE: This module follows the semantic versioning and versions prior to 1.0.0 should be consider pre-release versions.

Things to do:
This is the Production Standard for AKS pattern module for [Azure Verified Modules (AVM)](https://azure.github.io/Azure-Verified-Modules/) library. This module deploys a production standard AKS cluster along with supporting a Virtual Network and Azure container registry. It provisions an environment sufficient for most production deployments for AKS. It leverages the AzureRM provider and sets a number of initial defaults to minimize the overall inputs for simple configurations.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. A module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to <https://semver.org/>


## Deployment Steps

1. Set up a GitHub repo environment called `test`.
1. Configure environment protection rule to ensure that approval is required before deploying to this environment.
Expand All @@ -14,5 +19,3 @@ Things to do:
1. AZURE_TENANT_ID
1. AZURE_SUBSCRIPTION_ID
1. Search and update TODOs within the code and remove the TODO comments once complete.

Major version Zero (0.y.z) is for initial development. Anything MAY change at any time. A module SHOULD NOT be considered stable till at least it is major version one (1.0.0) or greater. Changes will always be via new versions being published and no changes will be made to existing published versions. For more details please go to <https://semver.org/>

0 comments on commit 8d73f77

Please sign in to comment.