Skip to content

Commit e193145

Browse files
committed
docs: update README
Release-As: 1.4.1
1 parent c6c7b5b commit e193145

File tree

7 files changed

+31
-766
lines changed

7 files changed

+31
-766
lines changed

.devcontainer/Dockerfile

Lines changed: 0 additions & 7 deletions
This file was deleted.

.devcontainer/devcontainer.json

Lines changed: 0 additions & 29 deletions
This file was deleted.

README.md

Lines changed: 31 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Terraform module for Azure App Configuration
22

3-
[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/terraform-azurerm-app-config/badge)](https://scm-compliance-api.radix.equinor.com/repos/equinor/terraform-azurerm-app-config/badge)
4-
[![Equinor Terraform Baseline](https://img.shields.io/badge/Equinor%20Terraform%20Baseline-1.0.0-blueviolet)](https://github.com/equinor/terraform-baseline)
5-
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
3+
[![GitHub License](https://img.shields.io/github/license/equinor/terraform-azurerm-app-config)](https://github.com/equinor/terraform-azurerm-app-config/blob/main/LICENSE)
4+
[![GitHub Release](https://img.shields.io/github/v/release/equinor/terraform-azurerm-app-config)](https://github.com/equinor/terraform-azurerm-app-config/releases/latest)
5+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)
6+
[![SCM Compliance](https://scm-compliance-api.radix.equinor.com/repos/equinor/terraform-azurerm-app-config/badge)](https://developer.equinor.com/governance/scm-policy/)
67

78
Terraform module which creates Azure App Configuration resources.
89

@@ -11,46 +12,41 @@ Terraform module which creates Azure App Configuration resources.
1112
- Microsoft Entra authorization enforced by default.
1213
- Audit logs sent to given Log Analytics workspace by default.
1314

14-
## Development
15+
## Prerequisites
1516

16-
1. Read [this document](https://code.visualstudio.com/docs/devcontainers/containers).
17+
- Azure role `Contributor` at the resource group scope.
1718

18-
1. Clone this repository.
19+
## Usage
1920

20-
1. Configure Terraform variables in a file `.devcontainer/devcontainer.env`:
21+
```terraform
22+
provider "azurerm" {
23+
features {}
24+
}
2125
22-
```env
23-
TF_VAR_resource_group_name=
24-
TF_VAR_location=
25-
```
26+
module "app_config" {
27+
source = "equinor/app-config/azurerm"
28+
version = "~> 1.4"
2629
27-
1. Open repository in dev container.
30+
store_name = "example-store"
31+
resource_group_name = azurerm_resource_group.example.name
32+
location = azurerm_resource_group.example.location
33+
log_analytics_workspace_id = module.log_analytics.workspace_id
34+
}
2835
29-
## Testing
36+
resource "azurerm_resource_group" "example" {
37+
name = "example-resources"
38+
location = "westeurope"
39+
}
3040
31-
1. Change to the test directory:
41+
module "log_analytics" {
42+
source = "equinor/log-analytics/azurerm"
43+
version = "~> 2.0"
3244
33-
```console
34-
cd test
35-
```
36-
37-
1. Login to Azure:
38-
39-
```console
40-
az login
41-
```
42-
43-
1. Set active subscription:
44-
45-
```console
46-
az account set -s <SUBSCRIPTION_NAME_OR_ID>
47-
```
48-
49-
1. Run tests:
50-
51-
```console
52-
go test -timeout 60m
53-
```
45+
workspace_name = "example-workspace"
46+
resource_group_name = azurerm_resource_group.example.name
47+
location = azurerm_resource_group.example.location
48+
}
49+
```
5450

5551
## Contributing
5652

test/basic_example_test.go

Lines changed: 0 additions & 17 deletions
This file was deleted.

test/complete_example_test.go

Lines changed: 0 additions & 17 deletions
This file was deleted.

test/go.mod

Lines changed: 0 additions & 56 deletions
This file was deleted.

0 commit comments

Comments
 (0)