Skip to content

Commit

Permalink
fix: various minor fixes (#26)
Browse files Browse the repository at this point in the history
* fix: various minor fixes

* Fix checklist typo

* Improve note

* Add warning about subscription placement

* fix typo
  • Loading branch information
jaredfholgate authored Jan 10, 2025
1 parent 8be76cc commit d89ee97
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 8 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ weight: 2

You may want to customize the management groups names and IDs. In order to do this they need to supply a `lib` folder to the accelerator.

{{< hint type=warning >}}
If you update the management group IDs, you also need to update the `management_group_settings` > `subscription_placement` block setting in the `platform-landing-zone.tfvars` file to match the management group IDs you changed. See the end of this page for more details. If you don't do this, you will get an error when you deploy the platform landing zone.
{{< /hint >}}

The `lib` folder should contain the following structure (we are showing it nested under the standard accelerator file structure here):

```plaintext
Expand All @@ -19,7 +23,7 @@ The `lib` folder should contain the following structure (we are showing it neste
┗ 📂output
```

Follow these steps to customise the management group names and IDs:
Follow these steps to customize the management group names and IDs:

1. Run the following script to create the `lib` folder and the `alz.alz_architecture_definition.json` under the standard accelerator file structure:

Expand Down Expand Up @@ -50,8 +54,8 @@ The `lib` folder must be named `lib`, any other name will not work

For example to prefix all the management group display names with `Contoso` and update the management group IDs to have the `contoso-` prefix they can update the file to look like this:

{{< hint type=tip >}}
When updating the management group `id`, you also need to consider any child management groups that refer to it by the `parent_id`
{{< hint type=warning >}}
When updating the management group `id`, you also need to update any child management groups that refer to it by the `parent_id`
{{< /hint >}}

{{< highlight terraform "linenos=table" >}}
Expand Down Expand Up @@ -106,11 +110,11 @@ When updating the management group `id`, you also need to consider any child man
},
{
"archetypes": [
"sandboxes"
"sandbox"
],
"display_name": "Contoso Sandboxes",
"display_name": "Contoso Sandbox",
"exists": false,
"id": "contoso-sandboxes",
"id": "contoso-sandbox",
"parent_id": "contoso-root"
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,10 @@ This first PAT is referred to as `token-1`.

If you are using self-hosted runners, you will need to create a second PAT that we'll refer to as `token-2` for them. You can do this by following the steps above with the following differences:

1. Select the maximum value for the `Expiration` field (this allows up to 1 year). NOTE: You may want to set a shorter expiration date for security reasons. In either case, you will need to have a process in place to extend expiration the token before it expires.
1. Select the maximum value for the `Expiration` field (this allows up to 1 year).

{{< hint type=note >}}
You may want to set a shorter expiration date for security reasons. In either case, you will need to have a process in place to extend expiration the token before it expires.
{{< /hint >}}

1. Select only the `Agent Pools`: `Read & manage` scope.
7 changes: 6 additions & 1 deletion docs/content/accelerator/userguide/1_prerequisites/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,12 @@ This first PAT is referred to as `token-1`.

If you are using self-hosted runners, you will need to create a second PAT that we'll refer to as `token-2` for them. You can do this by following the steps above with the following differences:

1. Select `No expiration` for the `Expiration` field. NOTE: You may want to set an expiration date for security reasons, but you will need to have a process in place to regenerate the token in that scenario.
1. Select `No expiration` for the `Expiration` field.

{{< hint type=note >}}
You may want to set a shorter expiration date for security reasons. In either case, you will need to have a process in place to extend expiration the token before it expires.
{{< /hint >}}

1. The scope required depends on the type of organization you are using:
1. If you are using a Free organization or an Enterprise organization without a runner group, select only the `repo` scope.
1. If you are using an Enterprise organization and a runner group, select the `admin:org` scope for classic tokens (or `organization_self_hosted_runners:write` for fine-grained tokens).
Binary file modified docs/static/examples/tf/accelerator/config/checklist.xlsx
Binary file not shown.

0 comments on commit d89ee97

Please sign in to comment.