Skip to content

Commit 4a29cf3

Browse files
Updated README file
1 parent c119716 commit 4a29cf3

File tree

1 file changed

+22
-1
lines changed

1 file changed

+22
-1
lines changed

README.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# terraform-azure-authentication-action
2-
An action to set the Terraform Envrionment variables to access Azure
2+
3+
An action to set the Terraform environment variables to access Azure.
4+
5+
## Overview
6+
7+
This GitHub Action fetches secrets from Azure Key Vault and sets them as environment variables required for Terraform to authenticate with Azure. It supports both local development and GitHub Actions workflows.
8+
9+
## Features
10+
11+
- Fetch secrets from Azure Key Vault using service principal credentials.
12+
- Set secrets as environment variables for Terraform.
13+
- Integrate with GitHub Actions by writing secrets to the `GITHUB_ENV` file.
14+
15+
## Prerequisites
16+
17+
- Python 3.11
18+
- Azure subscription with a Key Vault and registered secrets.
19+
- Service principal credentials (`AZURE_TENANT_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`) set in a `.env` file.
20+
- `config.toml` file specifying Key Vault name and secret names.
21+
- poetry to manage dependencies. use `poetry install` to install dependencies.
22+
- ### run the code as **poetry run python3 fetch_kv_secret.py** to execute the script.
23+

0 commit comments

Comments
 (0)