Skip to content
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.

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

[508] Manage Azure credentials per environment #179

Merged
merged 3 commits into from
Jul 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 2 additions & 10 deletions .github/workflows/delete_review_app.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@ on:
jobs:
build-and-push:
runs-on: ubuntu-latest
concurrency: ci-${{ github.ref }}

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Set environment variables
run: |
Expand All @@ -29,15 +30,6 @@ jobs:
CF_PASSWORD: ${{ secrets.CF_PASSWORD }}
CF_SPACE_NAME: ${{ env.SPACE }}

- name: Wait for deploy to finish
uses: fountainhead/[email protected]
with:
token: ${{ secrets.GITHUB_TOKEN }}
checkName: build-and-push
ref: ${{ github.event.pull_request.head.sha }}
timeoutSeconds: 300
intervalSeconds: 15

- name: Delete ${{ env.APP_NAME }}
run: cf delete -rf ${{ env.APP_NAME }}

Expand Down
13 changes: 2 additions & 11 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,11 @@ on:
jobs:
build-and-push:
runs-on: ubuntu-latest
concurrency: ci-${{ github.ref }}

steps:
- uses: DFE-Digital/github-actions/turnstyle@master
name: Check workflow concurrency
with:
initial-wait-seconds: 15
poll-interval-seconds: 15
abort-after-seconds: 300
same-branch-only: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v3

- name: Setup ruby
uses: ruby/setup-ruby@v1
Expand Down
14 changes: 9 additions & 5 deletions source/infrastructure/hosting/azure-cip/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Azure CIP
last_reviewed_on: 2022-10-03
last_reviewed_on: 2023-07-14
review_in: 6 months
---

Expand Down Expand Up @@ -93,11 +93,13 @@ Should you require a static IP, it is possible to request an [Internet Access Se
Contact #cloud-platform to set it up.

## Azure service principal
To be able to access Azure from an external system like GOV.UK PaaS, a service account is required. It is called a
To be able to access Azure from an external system like Github actions, a service account is required. It is called a
service principal in Azure. See the [Azure documentation](https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals).

### Create service principal
- Submit a CIP Request on Service Now using your education.gov.uk identity. The request type is `Any Other Request` and in `Any other request description` enter the following:
In this example we create a service principal which has Contributor (full access) including Keyvault. It depends on the custom role created in [Managing secrets](/infrastructure/security/managing-secrets/#request-roles).

Submit a CIP Request on Service Now using your education.gov.uk identity. The request type is `Any Other Request` and in `Any other request description` enter the following:

```
We have a new service called [service-name] that we are currently setting up for Teacher Services Digital team. This service will need service principals with Contributor access to [subscription-number] subscriptions so that it is in line with our deployment approach for new services.
Expand Down Expand Up @@ -157,15 +159,17 @@ The information it contains can also be manually obtained:

#### GitHub Actions

The GitHub secret (eg: `AZURE_CREDENTIALS`) can be used with the Azure login action or by providing it to Terraform.
The GitHub secret (eg: `AZURE_CREDENTIALS`) can be used with the Azure login action or by providing it to Terraform ([Additional information](https://github.com/marketplace/actions/azure-login#configure-a-service-principal-with-a-secret)).

```yaml
- uses: Azure/login@v1
with:
creds: ${{ secrets.AZURE_CREDENTIALS }}
```

[Additional information](https://github.com/marketplace/actions/azure-login#configure-a-service-principal-with-a-secret)
When using multiple deployment environments, each one may require its own set of credentials from different service principals. Configure `AZURE_CREDENTIALS`
as [environment secret](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-an-environment) for each
Github environment and make sure the [job is configured with the corresponding environment](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idenvironment).

#### Terraform
Use the [service principal](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/guides/service_principal_client_secret) credentials above
Expand Down