Skip to content

Commit

Permalink
feat: merge scenarios (#192)
Browse files Browse the repository at this point in the history
* feat: ASE shared modules (CARML)
- deployAseV3 param added

* feat: fixed spoke subnets
- added NSGs

* doc: changes for deployAseV3

* fix: typo

* doc: settings

* fix

* fx

* feat: asp merged - test 1

* fix:  nsg

* fix zone redundant

* fix: private DNS Zone

* feat: merged scenarios BICEP

* feat: portal deployment

* fix

* feat: deployAse Merged

* fix

* Removed (most of) ASEV3 scenario

* test actions

* action test

* get latest from main (#193)

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Thodoris Theodorou <[email protected]>
Co-authored-by: Jin Lee <[email protected]>

* test

* there is Scenario 2
- WF needs to be updated or deleted

* fix: fix depedencies

* depedency and conditional logic fix

* ARM sync

* Updated main readme

* ok

* allow non-AZ ASE

* sync ARM

* fix: zone redundant or not support for ASE

* sync json

* fix: dependency error

* fix typo in condition

* test ASE Private DNS Zone Dependency

* fix dependencies

* fix

* ASE Private DNS Zone must be in same scope as ASE

* test

* fix outputs

---------

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Jin Lee <[email protected]>
Co-authored-by: Jin Lee <[email protected]>
  • Loading branch information
4 people authored Nov 29, 2023
1 parent bff942c commit 9e5a75c
Show file tree
Hide file tree
Showing 77 changed files with 3,141 additions and 6,485 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
2 changes: 1 addition & 1 deletion .github/workflows/.template.terraform.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ jobs:
- name: Setup Terraform
uses: hashicorp/setup-terraform@v3
with:
terraform_version: ${{ inputs.terraform_version }}
terraform_version: ${{ inputs.terraformVersion }}

# Log into Azure via OIDC
- uses: azure/login@v1
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/scenario1.terraform.hub.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ on:
pull_request:
branches:
- main
- feature/*
paths:
- '.github/workflows/scenario1.terraform.hub.yml'
- '.github/workflows/_template.terraform.yml'
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/scenario1.terraform.spoke.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ on:
pull_request:
branches:
- main
- feature/*
paths:
- '.github/workflows/scenario1.terraform.spoke.yml'
- '.github/workflows/_template.terraform.yml'
Expand Down Expand Up @@ -64,4 +63,3 @@ jobs:
# Ensure this value is a boolean
destroy: ${{ github.event.inputs.destroy == 'true' }}
secrets: inherit

33 changes: 15 additions & 18 deletions .github/workflows/scenario2.bicep.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,21 @@ name: 'Scenario 2: Bicep Single-tenant ASEv3 Secure Baseline'
on:
workflow_dispatch:

push:
branches:
- main
paths:
- '.github/workflows/bicep.scenario2.yml'
- 'scenarios/secure-baseline-ase/bicep/**'
- '!scenarios/secure-baseline-ase/**.md'
# push:
# branches:
# - main
# paths:
# - '.github/workflows/bicep.scenario2.yml'
# - 'scenarios/secure-baseline-ase/bicep/**'
# - '!scenarios/secure-baseline-ase/**.md'

pull_request:
branches:
- main
- feature/*
- feat/*
- fix/*
paths:
- '.github/workflows/bicep.scenario2.yml'
- 'scenarios/secure-baseline-ase/bicep/**'
- '!scenarios/secure-baseline-ase/**.md'
# pull_request:
# branches:
# - main
# paths:
# - '.github/workflows/bicep.scenario2.yml'
# - 'scenarios/secure-baseline-ase/bicep/**'
# - '!scenarios/secure-baseline-ase/**.md'

permissions:
id-token: write
Expand Down Expand Up @@ -102,4 +99,4 @@ jobs:
workloadName=${{ fromJson(env.config).RESOURCE_NAME_PREFIX }} environment=${{ fromJson(env.config).ENVIRONMENT_TAG }}
vmUsername=${{ fromJson(env.config).VM_USERNAME }} vmPassword=${{ secrets.VM_PW }} location=${{ fromJson(env.config).AZURE_LOCATION }}
accountName=${{ secrets.ACCOUNT_NAME }} personalAccessToken=${{ secrets.PAT }} CICDAgentType=${{ fromJson(env.config).CICD_AGENT_TYPE}}
createRedisResource=${{ fromJson(env.config).CREATE_REDIS_RESOURCE }} redisTier=${{ fromJson(env.config).REDIS_TIER }}
createRedisResource=${{ fromJson(env.config).CREATE_REDIS_RESOURCE }} redisTier=${{ fromJson(env.config).REDIS_TIER }}
66 changes: 0 additions & 66 deletions .github/workflows/scenario2.terraform.yml

This file was deleted.

2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ override.tf.json
# Ignore CLI configuration files
.terraformrc
terraform.rc
shared/agentsetup.ps1
# shared/agentsetup.ps1
.vscode/tasks.json
.vscode/launch.json
.vscode/launch.json
Expand Down
49 changes: 28 additions & 21 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
---

## Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
Expand All @@ -30,19 +31,22 @@ The rest of this document outlines a few important notes/guidelines to help us t
## GitHub Operations, Conventions and other Standards

### GitHub Basics

The following guides provide basic knowledge for understanding Git command usage and the workflow of GitHub.

- [Introduction to version control with Git](https://docs.microsoft.com/learn/paths/intro-to-vc-git/)
- [Git Cheat Sheet](https://education.github.com/git-cheat-sheet-education.pdf)
- [GitHub Flow](https://guides.github.com/introduction/flow/)

### Folder Structure and Naming Conventions

- Github uses ASCII for ordering files and folders. For consistent ordering create all files and folders in **lowercase**. The only exception to this guideline is the *common supporting files* such as README.md, CONTRIBUTING.md etc files, that should be in the format **UPPERCASE.lowercase**. Remember that there are operating systems that handle files with different casing as distinct files, so we need to avoid these kind of conflicts.
- Avoid **camelCase** for files and folders consisting of two or more words. Use only lowercase and append words with dashes, i.e. **`folder-name-one`** and **not** `folderNameOne`

> NOTE: the aforementioned rules can be overridden, if any Language Coding Styles or Guidelines instruct the usage of different conventions
Below you can see the selected folder structure for the project. The main folders and a brief description of their purpose is as follows:
Below you can see the selected folder structure for the project. The main folders and a brief description of their purpose is as follows:

- **docs**
The *docs* folder contains two subfolders; **design-areas** and **media**.
- The **design-areas** subfolder contains the relevant documentation.
Expand All @@ -51,7 +55,7 @@ Below you can see the selected folder structure for the project. The main folder
- **sample-apps**
This folder may contain one or more subfolders, depending on the selected sample applications that will be created to serve as smoke tests or best-practices examples using the specific Landing Zone Accelerator artifacts. Folder structure inside each sample application sub-folder is free.
- **scenarios**
This folder can contain one or more scenarios (currently contains secure-baseline-ase and secure-baseline-multitenant), but in the future more scenarios might be added. Each scenario has the following (minimum) folder structure
This folder can contain one or more scenarios (currently contains secure-baseline), but in the future more scenarios might be added. Each scenario has the following (minimum) folder structure
- (scenario1)\bicep
Stores Azure Bicep related deployment scripts and artifacts for the given scenario. Contains also a README.md file that gives detailed instructions on how to use the specific IaC artifacts and scripts, to help end users parameterize and deploy successfully the LZA scenario
- (scenario1)\terraform
Expand Down Expand Up @@ -107,6 +111,7 @@ Unless you are working with multiple contributors on the same file, we ask that
- [Contributing to GitHub projects](https://guides.github.com/activities/forking/).

### Branch Naming Standards

For branches, use the following prefixes depending on which is most applicable to the work being done:
| Prefix | Purpose |
|-------------|-----------|
Expand All @@ -118,22 +123,25 @@ For branches, use the following prefixes depending on which is most applicable t
|test/|Any task pertaining to testing updates |

### Commit Standards (optional)

Prefixing the commits as described below, is **optional**, however is **highly encouraged**.
For commits, use the following prefixes depending on which is most applicable to the changes:
| Prefix | Purpose |
|-------------|-----------|
| Prefix | Purpose |
|-------------|-----------|
|fix:|Update to code base or bug|
|feat:|New feature added to code base|
|chore:|Basic task to update formatting or versions, etc.|
|docs:|New documentations or updates to documentation in Markdown file(s) |
|ci:|New workflow or updates to workflow(s) |
|test:|New tests or updates to testing framework(s) |

## Style Guide and coding conventions
A guide outlining the coding conventions and style guidelines that should be followed when contributing code to the repository is outlined below:
## Style Guide and coding conventions

A guide outlining the coding conventions and style guidelines that should be followed when contributing code to the repository is outlined below:

### Bicep Best Practices and Conventions
- The starting point for any deployment should be named **main.bicep**. This (usually) should be the main deployment file, scoped at *subscription* level, and it would call several sub-deployments, usually at the resource group scope.

- The starting point for any deployment should be named **main.bicep**. This (usually) should be the main deployment file, scoped at *subscription* level, and it would call several sub-deployments, usually at the resource group scope.
- The **main.bicep** file should be accompanied with a parameter file named **main.parameters.jsonc**. The benefit of the `*.jsonc` file extension is that you can use inline comments (either `//` or `/* ... */`) in Visual Studio Code (otherwise you will get an error message saying "*Comments not permitted in JSON*"). [Bicep Parameter Files](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/parameter-files)
- Details of using the deployment should be given in the README.md file. However if we need extra scripts to either deploy the bicep files or other functionality use a naming conventions as the following
- deploy.main.sh: for bash-based script deploying the main.bicep
Expand All @@ -144,6 +152,7 @@ A guide outlining the coding conventions and style guidelines that should be fol
- Use strictly `camelCasing` for all elements like parameters, variables, resources, modules and outputs, and avoid prepending those elements in a [Hungarian Notation](https://en.wikipedia.org/wiki/Hungarian_notation) style.

**Bad practice examples that should be avoided:**

``` bicep
\\ BAD PRACTICE param EXAMPLES
param parVmSubnetAddressPrefix string
Expand All @@ -167,8 +176,10 @@ A guide outlining the coding conventions and style guidelines that should be fol
output acrId string = acr.id
```

**Acceptable naming convention examples:**
**Acceptable naming convention examples:**

``` bicep
\\ GOOD PRACTICE param EXAMPLES
param vmSubnetAddressPrefix string
Expand All @@ -179,12 +190,12 @@ A guide outlining the coding conventions and style guidelines that should be fol
output acrId string = acr.id
```


- For **parameters and outputs**, avoid using extreme abbreviations, and stick to well known (de-facto) Azure resource abbreviations. Examples:
- For **parameters and outputs**, avoid using extreme abbreviations, and stick to well known (de-facto) Azure resource abbreviations. Examples:
- **expressRouteGwName** instead of *erGwName*
- **storageAccountName** instead of *stAccName*

- Bicep is a declarative language, which means the elements can appear in any order. In reality you can put parameter declarations anywhere in the template file, and the same you can do for resources, variables and outputs. However it is highly recommended that any bicep template file to adhere to the following order `Parameters > Variables > Resources/Modules > Outputs` as shown in the code snippet.
- Bicep is a declarative language, which means the elements can appear in any order. In reality you can put parameter declarations anywhere in the template file, and the same you can do for resources, variables and outputs. However it is highly recommended that any bicep template file to adhere to the following order `Parameters > Variables > Resources/Modules > Outputs` as shown in the code snippet.

``` bicep
targetScope = 'subscription'
// ================ //
Expand Down Expand Up @@ -254,11 +265,12 @@ A guide outlining the coding conventions and style guidelines that should be fol
- `app-marketCampaign-backEnd`
- `app-marketCampaign-frontEnd`

- Consider sanitizing names of resources to avoid deployment errors. For example consider the name limitations for a storage account (all lowercase, less than 24 characters long, no dashes etc).
- Consider sanitizing names of resources to avoid deployment errors. For example consider the name limitations for a storage account (all lowercase, less than 24 characters long, no dashes etc).

``` bicep
var maxStorageNameLength = 24
var storageName = length(name) > maxStorageNameLength ? toLower(substring(replace(name, '-', ''), 0, maxStorageNameLength)) : toLower(replace(name, '-', ''))
```
```

- Use bicep **parameter** files for giving the end user the ability to paramterize the deployed resources. (i.e. to select CIDR network spaces, to select SKUs for given resources etc). As a rule of thumb, avoid using the parameter file for *naming recources*, unless there is a really good reason for that. Naming resources should be handled centrally (preferably with variables), following specific rules (as already described). Try not to overuse parameters in the template, because this creates a burden on your template users, since they need to understand the values to use for each resource, and the impact of setting each parameter. Consider using the [t-shirt sizing pattern](https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/patterns-configuration-set#solution)

Expand Down Expand Up @@ -307,6 +319,7 @@ resource storage 'Microsoft.Storage/storageAccounts@2019-06-01' = {
- [Azure Resource Abbreviations](https://learn.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/resource-abbreviations)

### Terraform Best Practices and Conventions

- Use modules: Terraform modules allow you to reuse and share code across different projects and teams. This helps to reduce duplication of effort and increases consistency
- Use Terraform variables: Use Terraform variables to provide input values and make your code more flexible and easier to maintain.
- Use Terraform outputs: Use Terraform outputs to extract information about your infrastructure for later use.
Expand All @@ -320,16 +333,10 @@ resource storage 'Microsoft.Storage/storageAccounts@2019-06-01' = {
- Declare all outputs in **outputs.tf**, including a description
- Modules must always include the following files, even if empty: **main.tf**, **variables.tf**, and **outputs.tf**









## Issue Tracker

> TODO: Instructions on how to use the issue tracker, including how to submit bugs and feature requests.
## Pull Request Process

> TODO: A description of the pull request process, including the criteria that pull requests will be reviewed against and the steps that will be taken to merge a pull request.
Loading

0 comments on commit 9e5a75c

Please sign in to comment.