https://github.com/launchbynttdata/tf-azurerm-module_primitive-virtual_machine_extension
https://github.com/launchbynttdata/tf-azurerm-module_primitive-virtual_machine_extension
azure infrastructure-as-code platform-automation primitive terraform
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/launchbynttdata/tf-azurerm-module_primitive-virtual_machine_extension
- Owner: launchbynttdata
- License: apache-2.0
- Created: 2024-03-25T16:08:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2026-04-14T19:51:52.000Z (about 2 months ago)
- Last Synced: 2026-04-14T21:28:52.250Z (about 2 months ago)
- Topics: azure, infrastructure-as-code, platform-automation, primitive, terraform
- Language: HCL
- Size: 240 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Notice: NOTICE
Awesome Lists containing this project
README
# tf-azurerm-module_primitive-virtual_machine_extension
[](https://opensource.org/licenses/Apache-2.0)
[](https://creativecommons.org/licenses/by-nc-nd/4.0/)
## Overview
What does this module do?
## Pre-Commit hooks
[.pre-commit-config.yaml](.pre-commit-config.yaml) file defines certain `pre-commit` hooks that are relevant to terraform, golang and common linting tasks. There are no custom hooks added.
`commitlint` hook enforces commit message in certain format. The commit contains the following structural elements, to communicate intent to the consumers of your commit messages:
- **fix**: a commit of the type `fix` patches a bug in your codebase (this correlates with PATCH in Semantic Versioning).
- **feat**: a commit of the type `feat` introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning).
- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type.
footers other than BREAKING CHANGE: may be provided and follow a convention similar to git trailer format.
- **build**: a commit of the type `build` adds changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
- **chore**: a commit of the type `chore` adds changes that don't modify src or test files
- **ci**: a commit of the type `ci` adds changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- **docs**: a commit of the type `docs` adds documentation only changes
- **perf**: a commit of the type `perf` adds code change that improves performance
- **refactor**: a commit of the type `refactor` adds code change that neither fixes a bug nor adds a feature
- **revert**: a commit of the type `revert` reverts a previous commit
- **style**: a commit of the type `style` adds code changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- **test**: a commit of the type `test` adds missing tests or correcting existing tests
Base configuration used for this project is [commitlint-config-conventional (based on the Angular convention)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#type-enum)
If you are a developer using vscode, [this](https://marketplace.visualstudio.com/items?itemName=joshbolduc.commitlint) plugin may be helpful.
`detect-secrets-hook` prevents new secrets from being introduced into the baseline. TODO: INSERT DOC LINK ABOUT HOOKS
In order for `pre-commit` hooks to work properly
- You need to have the pre-commit package manager installed. [Here](https://pre-commit.com/#install) are the installation instructions.
- `pre-commit` would install all the hooks when commit message is added by default except for `commitlint` hook. `commitlint` hook would need to be installed manually using the command below
```
pre-commit install --hook-type commit-msg
```
## To test the resource group module locally
1. For development/enhancements to this module locally, you'll need to install all of its components. This is controlled by the `configure` target in the project's [`Makefile`](./Makefile). Before you can run `configure`, familiarize yourself with the variables in the `Makefile` and ensure they're pointing to the right places.
```
make configure
```
This adds in several files and directories that are ignored by `git`. They expose many new Make targets.
2. _THIS STEP APPLIES ONLY TO MICROSOFT AZURE. IF YOU ARE USING A DIFFERENT PLATFORM PLEASE SKIP THIS STEP._ The first target you care about is `env`. This is the common interface for setting up environment variables. The values of the environment variables will be used to authenticate with cloud provider from local development workstation.
`make configure` command will bring down `azure_env.sh` file on local workstation. Devloper would need to modify this file, replace the environment variable values with relevant values.
These environment variables are used by `terratest` integration suit.
Service principle used for authentication(value of ARM_CLIENT_ID) should have below privileges on resource group within the subscription.
```
"Microsoft.Resources/subscriptions/resourceGroups/write"
"Microsoft.Resources/subscriptions/resourceGroups/read"
"Microsoft.Resources/subscriptions/resourceGroups/delete"
```
Then run this make target to set the environment variables on developer workstation.
```
make env
```
3. The first target you care about is `check`.
**Pre-requisites**
Before running this target it is important to ensure that, developer has created files mentioned below on local workstation under root directory of git repository that contains code for primitives/segments. Note that these files are `azure` specific. If primitive/segment under development uses any other cloud provider than azure, this section may not be relevant.
- A file named `provider.tf` with contents below
```
provider "azurerm" {
features {}
}
```
- A file named `terraform.tfvars` which contains key value pair of variables used.
Note that since these files are added in `gitignore` they would not be checked in into primitive/segment's git repo.
After creating these files, for running tests associated with the primitive/segment, run
```
make check
```
If `make check` target is successful, developer is good to commit the code to primitive/segment's git repo.
`make check` target
- runs `terraform commands` to `lint`,`validate` and `plan` terraform code.
- runs `conftests`. `conftests` make sure `policy` checks are successful.
- runs `terratest`. This is integration test suit.
- runs `opa` tests
# tf-azurerm-module_primitive-virtual_machine_extension
## Requirements
| Name | Version |
|------|---------|
| [terraform](#requirement\_terraform) | <= 1.5.5 |
| [azurerm](#requirement\_azurerm) | =3.77.0 |
## Providers
| Name | Version |
|------|---------|
| [azurerm](#provider\_azurerm) | 3.77.0 |
## Modules
No modules.
## Resources
| Name | Type |
|------|------|
| [azurerm_virtual_machine_extension.virtual_machine_extension](https://registry.terraform.io/providers/hashicorp/azurerm/3.77.0/docs/resources/virtual_machine_extension) | resource |
## Inputs
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| [name](#input\_name) | (Required) The name of the virtual machine extension peering. Changing this forces a new resource to be created. | `string` | n/a | yes |
| [virtual\_machine\_id](#input\_virtual\_machine\_id) | (Required) The ID of the Virtual Machine. Changing this forces a new resource to be created | `string` | n/a | yes |
| [publisher](#input\_publisher) | (Required) The publisher of the extension, available publishers can be found by using the Azure CLI. Changing this forces a new resource to be created. | `string` | n/a | yes |
| [type](#input\_type) | (Required) The type of extension, available types for a publisher can be found using the Azure CLI. | `string` | n/a | yes |
| [type\_handler\_version](#input\_type\_handler\_version) | (Required) Specifies the version of the extension to use, available versions can be found using the Azure CLI. | `string` | n/a | yes |
| [auto\_upgrade\_minor\_version](#input\_auto\_upgrade\_minor\_version) | (Optional) Specifies if the platform deploys the latest minor version update to the type\_handler\_version specified. | `bool` | `false` | no |
| [automatic\_upgrade\_enabled](#input\_automatic\_upgrade\_enabled) | (Optional) Should the Extension be automatically updated whenever the Publisher releases a new version of this VM Extension? | `bool` | `false` | no |
| [settings](#input\_settings) | (Optional) The settings passed to the extension, these are specified as a JSON object in a string. Changing this forces a new resource to be created. | `string` | n/a | yes |
| [failure\_suppression\_enabled](#input\_failure\_suppression\_enabled) | (Optional) Should failures from the extension be suppressed? Possible values are true or false. | `bool` | `false` | no |
| [protected\_settings](#input\_protected\_settings) | (Optional) The protected\_settings passed to the extension, like settings, these are specified as a JSON object in a string. | `string` | `null` | no |
| [protected\_settings\_from\_key\_vault](#input\_protected\_settings\_from\_key\_vault) | (Optional) Map of protected settings from Key Vault. Can not be used with protected\_settings |
object({
secret_url = string
source_vault_id = string
}) | `null` | no |
| [tags](#input\_tags) | (Optional) A mapping of tags to assign to the resource. | `map(string)` | `{}` | no |
## Outputs
| Name | Description |
|------|-------------|
| [id](#output\_id) | The ID of the Virtual Machine Extension. |