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.

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

docs: add notice and remove msft refs #271

Merged
merged 3 commits into from
Mar 13, 2024
Merged

docs: add notice and remove msft refs #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
451cb8b
docs: add notice
matt-FFFFFF Jan 26, 2024
d28a3c2
docs: remove CAF refs
matt-FFFFFF Jan 26, 2024
3198177
Merge branch 'main' into docs/addnotice
arnaudlh Mar 13, 2024
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
23 changes: 13 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Azure Cloud Adoption Framework - Terraform provider
# Azure Terraform SRE - Terraform provider

This provider implements a set of methodologies for naming convention implementation including the default Microsoft Cloud Adoption Framework for Azure recommendations as per https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging.
> :warning: This solution, offered by the Open-Source community, will no longer receive contributions from Microsoft.

This provider implements a set of methodologies for naming convention implementation including the default Microsoft Cloud Adoption Framework for Azure recommendations as per <https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging>.

## Using the Provider

Expand Down Expand Up @@ -45,6 +47,7 @@ output "rg_example" {
value = data.azurecaf_name.rg_example.result
}
```

```bash
data.azurecaf_name.rg_example: Reading...
data.azurecaf_name.rg_example: Read complete after 0s [id=a-b-rg-demogroup-sjdeh-y-z]
Expand Down Expand Up @@ -86,21 +89,21 @@ The following attributes are exported:
We define resource types as per [naming-and-tagging](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging)
The comprehensive list of resource type can be found [here](./docs/resources/azurecaf_name.md)


## Building the provider

Clone repository to: $GOPATH/src/github.com/aztfmod/terraform-provider-azurecaf

```
$ mkdir -p $GOPATH/src/github.com/aztfmod; cd $GOPATH/src/github.com/aztfmod
$ git clone https://github.com/aztfmod/terraform-provider-azurecaf.git
mkdir -p $GOPATH/src/github.com/aztfmod; cd $GOPATH/src/github.com/aztfmod
git clone https://github.com/aztfmod/terraform-provider-azurecaf.git

```

Enter the provider directory and build the provider

```
$ cd $GOPATH/src/github.com/aztfmod/terraform-provider-azurecaf
$ make build
cd $GOPATH/src/github.com/aztfmod/terraform-provider-azurecaf
make build

```

Expand All @@ -119,11 +122,13 @@ $ $GOPATH/bin/terraform-provider-azurecaf
...

```

## Testing

Running the acceptance test suite requires does not require an Azure subscription.
Running the acceptance test suite requires does not require an Azure subscription.

to run the unit test:

```
make unittest
```
Expand All @@ -143,7 +148,6 @@ make test
| [azure_caf_provider](https://github.com/aztfmod/terraform-provider-azurecaf) | custom provider for naming conventions |
| [module](https://registry.terraform.io/modules/aztfmod) | official CAF module available in the Terraform registry |


## Community

Feel free to open an issue for feature or bug, or to submit a PR.
Expand Down Expand Up @@ -761,7 +765,6 @@ This is the current compreheensive status of the implemented resources in the pr
|azurerm_windows_web_app | ✔ |
|azurerm_windows_web_app_slot | ⚠ |


❌ = Not yet implemented
✔ = Already implemented
⚠ = Will not be implemented
4 changes: 3 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Azurecaf provider

> :warning: This solution, offered by the Open-Source community, will no longer receive contributions from Microsoft.

The Azurecaf provider is a *logical provider* which means that it works entirely within Terraform's logic, and doesn't interact with any other services. The goal of this provider is to provider helper methods in implementing Azure landing zones using Terraform.

The Azurecaf provider currently contains a two resources based on the Terraform Random_string provider. The naming_convention resources enforce is the first iteration of our naming convention implementation enforcing Azure Cloud Adoption Framework naming convention.
Expand All @@ -8,7 +10,7 @@ As per the growing number of azure resources a new implementation is now availab

## Resource types

We define resource types as per: https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging
We define resource types as per: <https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging>

Current supported resource types:

Expand Down
Loading