Skip to content

Commit

Permalink
Update links to inputs
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredfholgate committed Jul 10, 2024
1 parent e774646 commit 9594486
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 67 deletions.
7 changes: 3 additions & 4 deletions docs/wiki/Frequently-Asked-Questions.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@ You can then deploy as many times as you like without interferring with a previo

### I want to automate the PowerShell module, but it keeps prompting me for input, can I supply the answers?

>NOTE: We now recommend this as the preferred approach and our documentation has been updated to reflect this.
Yes, you can supply the variables to the PowerShell module by using the `-inputs` parameter. You just need to supply a single file that includes the variables for the bootstrap and the starter module. The ordering of the variables in the file is not important.

The module will accept inputs as in json or yaml format. `.json,`, `.yaml` or `.yml` file extensions are supported. Examples of both are shown below.
Expand Down Expand Up @@ -98,10 +100,7 @@ json example:

> NOTE: These examples show a partial set of variables. In this scenario, the module will prompt for the remaining variables. You can find the full list of variables in the quick start phase 2 and starter module documentation.
Full yaml examples:

- GitHub Example input file: [inputs-github.yaml][example_powershell_inputs_github]
- Azure DevOps Example input file: [inputs-azure-devops.yaml][example_powershell_inputs_azure_devops]
Full yaml examples can be found under the `Input Files` section of the right-hand menu.

### I get prompted to approve the Terraform plan, can I skip that?

Expand Down
69 changes: 6 additions & 63 deletions docs/wiki/[User-Guide]-Starter-Module-Terraform-Complete.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
The `complete` starter module provides full customization of the Azure Landing Zone using the `config.yaml` file. The `config.yaml` file provides the ability to enable and disable modules, configure module inputs and outputs, and configure module resources.
A custom `config.yaml` file can be passed to the `additional_files` argument of the ALZ PowerShell Module. This allows you to firstly design your Azure Landing Zone, and then deploy it.
If not specified, the default `config.yaml` file will be used, which is as follows:

```yaml
# This file contains templated variables to avoid repeating the same hard-coded values.
# Templated variables are denoted by the dollar curly braces token. The following details each templated variable that you can use:
Expand Down Expand Up @@ -152,7 +152,7 @@ connectivity:
mesh_peering_enabled: true
address_space:
- 10.2.0.0/16

```

### Use the ALZ PowerShell Module to prepare your Azure Landing Zone for deployment
Expand All @@ -163,68 +163,11 @@ Set your inputs.yaml file (See [Frequently Asked Questions][wiki_frequently_aske
GitHub Example:

- Example input file: [inputs-github.yaml][example_powershell_inputs_github]

```yaml
# Path of file: C:\users\johndoe\inputs.yaml

iac: "terraform"
bootstrap: "alz_github"
starter: "complete"
azure_location: "uksouth"
github_personal_system_access_token: "xxxxxxxxxx"
github_organization_name: "contoso"
azure_location": "uksouth"
azure_subscription_id: "00000000-0000-0000-0000-000000000000"
service_name: "alz"
environment_name: "mgmt"
postfix_number: "1"
version_control_system_use_separate_repository_for_templates: "true"
use_self_hosted_agents: "true"
use_private_networking: "true"
allow_storage_access_from_my_ip: "false"

# Starter Module Specific Variables
root_parent_management_group_id: ""
subscription_id_connectivity: "00000000-0000-0000-0000-000000000000"
subscription_id_identity: "00000000-0000-0000-0000-000000000000"
subscription_id_management: "00000000-0000-0000-0000-000000000000"
configuration_file_path: "C:\users\johndoe\config.yaml"
```
- Example input file: [inputs-github-terraform.yaml][example_powershell_inputs_github_terraform]

Azure DevOps Example:

- Example input file: [inputs-azure-devops.yaml][example_powershell_inputs_azure_devops]
```yaml
# Path of file: C:\users\johndoe\inputs.yaml

iac: "terraform"
bootstrap: "alz_azuredevops"
starter: "complete"
azure_location: "uksouth"
azure_devops_personal_system_access_token: "xxxxxxxxxx"
azure_devops_organization_name: "contoso"
azure_location": "uksouth"
azure_subscription_id: "00000000-0000-0000-0000-000000000000"
service_name: "alz"
environment_name: "mgmt"
postfix_number: "1"
azure_devops_use_organisation_legacy_url: "false"
azure_devops_create_project: "true"
azure_devops_project_name: "alz-demo"
version_control_system_use_separate_repository_for_templates: "true"
use_self_hosted_agents: "true"
use_private_networking: "true"
allow_storage_access_from_my_ip: "false"

# Bootstrap and Starter Module Specific Variables
root_parent_management_group_id: ""
subscription_id_connectivity: "00000000-0000-0000-0000-000000000000"
subscription_id_identity: "00000000-0000-0000-0000-000000000000"
subscription_id_management: "00000000-0000-0000-0000-000000000000"
configuration_file_path: "C:\users\johndoe\config.yaml"
```
- Example input file: [inputs-azure-devops-terraform.yaml][example_powershell_inputs_azure_devops_terraform]

Run the accelerator:

Expand All @@ -239,7 +182,7 @@ Deploy-Accelerator -Inputs "inputs.yaml" -autoApprove

[wiki_yaml_schema_reference]: %5BUser-Guide%5D-YAML-Schema-Reference "Wiki - YAML Schema Reference"
[wiki_frequently_asked_questions]: Frequently-Asked-Questions "Wiki - Frequently Asked Questions"
[example_powershell_inputs_azure_devops]: examples/powershell-inputs/inputs-azure-devops.yaml "Example - PowerShell Inputs - Azure DevOps"
[example_powershell_inputs_github]: examples/powershell-inputs/inputs-github.yaml "Example - PowerShell Inputs - GitHub"
[example_powershell_inputs_azure_devops_terraform]: examples/powershell-inputs/inputs-azure-devops-terraform.yaml "Example - PowerShell Inputs - Azure DevOps - Terraform"
[example_powershell_inputs_github_terraform]: examples/powershell-inputs/inputs-github-terraform.yaml "Example - PowerShell Inputs - GitHub - Terraform"
[example_starter_module_complete_config_hub_spoke]: examples/starter-module-config/complete/config-hub-spoke.yaml "Example - Starter Module Config - Complete - Hub and Spoke"
[example_starter_module_complete_config_vwan]: examples/starter-module-config/complete/config-vwan.yaml "Example - Starter Module Config - Complete - Virtual WAN"

0 comments on commit 9594486

Please sign in to comment.