Skip to content

Update install docs with SP comments and backend state comments #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 18 commits into
base: master
Choose a base branch
from
Open

Update install docs with SP comments and backend state comments #284

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
3c31881
update docs with test detection comment
TechnicallyWilliams Sep 6, 2019
fc4a2b1
updating docs with backendstate and SP comments
TechnicallyWilliams Sep 6, 2019
7b10b33
Merge branch 'master' into dexterw/features/update-install-docs
TechnicallyWilliams Sep 12, 2019
f41f1ae
split add_pat_owner into separate ui and cli docs
TechnicallyWilliams Sep 12, 2019
996f30d
added more detail to add pat owner cli doc
TechnicallyWilliams Sep 12, 2019
6ce7078
divided add pat owner cli doc into more sections
TechnicallyWilliams Sep 14, 2019
e69871f
add more details to add pat owner cli doc
TechnicallyWilliams Sep 14, 2019
7d36f6a
update style and punctuation
TechnicallyWilliams Sep 14, 2019
441ce05
clarify final steps of add pat owner cli
TechnicallyWilliams Sep 14, 2019
da78311
link to azure portal steps from add pat owner cli docs
TechnicallyWilliams Sep 14, 2019
8ac899c
update instructions for both add pat owner docs
TechnicallyWilliams Sep 24, 2019
024845e
merging conflicts
TechnicallyWilliams Sep 24, 2019
e928c4e
Updates the formating of the AdPat owner doc (#293)
negupt Sep 24, 2019
45044f5
address merge conflicts
TechnicallyWilliams Sep 24, 2019
813eec4
update getting started add pat owner docs
TechnicallyWilliams Sep 25, 2019
42bb4de
update readability of add pat owner docs
TechnicallyWilliams Oct 1, 2019
fcfc36c
update readability of add pat owner docs
TechnicallyWilliams Oct 1, 2019
82d87f2
add clarity to several add pat owner docs
TechnicallyWilliams Oct 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions docs/GETTING_STARTED_ADD_PAT_OWNER.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ This document provides Cobalt users instructions for initializing and integratin
![Request Permissions menu](https://user-images.githubusercontent.com/10041279/63549279-b6896500-c4f5-11e9-9c92-40ac2a4295c9.png)

* Click [Add permissions] to save this configuration
* Click [Grant admin consent for *Your Directory*] to grant consent on behalf of users in this directory for this permission
* Click [Grant admin consent for *Your Directory*] to grant consent on behalf of users in this directory for this permission

* Configure the new AAD app as a Cobalt admin service-principal/service-endpoint
* From the App registrations service blade, click the [Certificates & secrets] tab
Expand Down Expand Up @@ -174,11 +174,11 @@ This document provides Cobalt users instructions for initializing and integratin
| Name | Value | Var Description |
|-------------|-----------|-----------|
| `AGENT_POOL` | Hosted Ubuntu 1604 | The type of build agent used for your deployment. |
| `ARM_PROVIDER_STRICT` | false | Terraform ARM provider modification |
| `ARM_PROVIDER_STRICT` | true | Terraform ARM provider modification |
| `BUILD_ARTIFACT_NAME` | drop | Name to identity the folder containing artifacts output by a build. |
| `GO_VERSION`| 1.12.5 | The version of Go terraform deployments are bound to. |
| `PIPELINE_ROOT_DIR` | devops/providers/azure-devops/templates/ | A path for finding Cobalt templates. |
| `REMOTE_STATE_CONTAINER` | `<CONTAINER_NAME>`| The remote blob storage container name for managing the state of a Cobalt Template's deployed infrastructure. Also is used as a naming convention for partitioning state into multiple workspaces. This name was created in an earlier step from within the azure portal. |
| `REMOTE_STATE_CONTAINER` | `<BACKEND_STATE_CONTAINER_NAME>`| The remote blob storage container name for managing the state of a Cobalt Template's deployed infrastructure. Also is used as a naming convention for partitioning state into multiple workspaces. This name was created in an earlier step from within the azure portal. |
| `SCRIPTS_DIR` | infrastructure/scripts | Path to scripts used at runtime for composing build and release jobs at various pipeline stages. |
| `TEST_HARNESS_DIR` | test-harness/ | A path to the cobalt test harness for running integration and unit tests written in Docker and Golang. |
| `TF_ROOT_DIR`| infra | The primary path for all Cobalt templates and the modules they are composed of. |
Expand Down Expand Up @@ -244,6 +244,7 @@ This document provides Cobalt users instructions for initializing and integratin

* Open the project from your favorite IDE and navigate to infrastructure templates `./infra/templates` directory.
* Manually delete template directories not needed for your enterprise.
* The CI/CD pipeline needs to detect a code change to run tests. Add a comment or extra line to a TF or Go file in order to force tests to run.
> NOTE: Do not delete 'backend-state-setup' template! We also recommended keeping the 'az-hello-world' template as a starter template.
* Commit the newly pruned project to your newly forked repo.
```bash
Expand Down
4 changes: 3 additions & 1 deletion docs/GETTING_STARTED_APP_DEV_CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@ The following *Infrastructure Pipeline Variables* are used by all possible envir

```bash
# IMPORTANT: Replace these values as necessary to fit your environment.
# IMPORTANT: REMOTE_STATE_CONTAINER should hold a value that is different than the source repo.
az pipelines variable-group create --authorize true --name "$COBALT_VAR_GROUP_INFRA" --variables \
AGENT_POOL='Hosted Ubuntu 1604' \
ARM_PROVIDER_STRICT=true \
Expand All @@ -141,14 +142,15 @@ Within the pipeline build definition you may specify the number of environments
For this walkthrough, we will only create a single environment -- *devint*. The following commands will create the required *DevInt Environment Variables* variable group.
```bash
# IMPORTANT: Replace these values as necessary to fit your environment.
# IMPORTANT: If you have control over the service connection, it should rely on the same SP backing the source repo service connection.
DEVINT_VAR_GROUP="DevInt $COBALT_VAR_GROUP_ENV_SUFFIX"
az pipelines variable-group create --authorize true --name $DEVINT_VAR_GROUP --variables \
ARM_SUBSCRIPTION_ID='TARGETSUBSCRIPTIONID' \
REMOTE_STATE_ACCOUNT='BACKENDSTATESTORAGEACCOUNTNAME' \
SERVICE_CONNECTION_NAME='SERVICECONNECTIONNAME'
```

> NOTE: The Service Connection name should be provided by someone in your organziation with the *Global administrator* permission for your Azure Active Directory tenant. If it has not been provisisioned for you, you may create another by following the directions outlined in the [Getting Started - Advocated Pattern Onwer documentation](./GETTING_STARTED_ADD_PAT_OWNER.md)
> NOTE: The Service Connection name should be provided by someone in your organization with the *Global administrator* permission for your Azure Active Directory tenant. If it has not been provisisioned for you, you may create another by following the directions outlined in the [Getting Started - Advocated Pattern Onwer documentation](./GETTING_STARTED_ADD_PAT_OWNER.md)

At this time, the Azure DevOps CLI does not support linking variable groups to pipelines. We have a temporary workaround utilizing the Azure DevOps `invoke` command to directly call the Azure DevOps REST API to update the build definition.

Expand Down