Skip to content

Commit 351ecb7

Browse files
f5shemyakinf5shemyakin
authored
Add linter, update dependencies, fix compatibility issues (#1)
- Added linter and a GitHub Workflow - Updated dependencies to the latest versions - Fixed compatibility issues caused by outdated packages
1 parent 8c693e4 commit 351ecb7

File tree

17 files changed

+505
-62
lines changed

17 files changed

+505
-62
lines changed

‎.github/workflows/terraform-lint.yml‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Terraform Lint
2+
3+
on:
4+
push:
5+
branches: [ main, develop ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
tflint:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v4
15+
16+
- name: Cache plugin dir
17+
uses: actions/cache@v3
18+
with:
19+
path: ~/.tflint.d/plugins
20+
key: ${{ hashFiles('.tflint.hcl') }}
21+
22+
- uses: terraform-linters/setup-tflint@v4
23+
with:
24+
tflint_version: v0.50.3
25+
26+
- name: Show version
27+
run: tflint --version
28+
29+
- name: Init TFLint
30+
run: tflint --init
31+
32+
- name: Run TFLint
33+
run: tflint --format compact
34+
35+
- name: Run TFLint on modules
36+
run: |
37+
find . -name "*.tf" -exec dirname {} \; | sort -u | while read dir; do
38+
echo "Linting $dir"
39+
(cd "$dir" && tflint --format compact)
40+
done
41+
42+
terraform-fmt:
43+
runs-on: ubuntu-latest
44+
45+
steps:
46+
- uses: actions/checkout@v4
47+
48+
- uses: hashicorp/setup-terraform@v3
49+
with:
50+
terraform_version: "1.8.0"
51+
52+
- name: Terraform Format Check
53+
run: terraform fmt -check -recursive -diff
54+
55+
terraform-validate:
56+
runs-on: ubuntu-latest
57+
58+
steps:
59+
- uses: actions/checkout@v4
60+
61+
- uses: hashicorp/setup-terraform@v3
62+
with:
63+
terraform_version: "1.8.0"
64+
65+
- name: Terraform Init
66+
run: terraform init -backend=false
67+
68+
- name: Terraform Validate
69+
run: terraform validate

‎.tflint.hcl‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
plugin "terraform" {
2+
enabled = true
3+
preset = "recommended"
4+
}
5+
6+
plugin "azurerm" {
7+
enabled = true
8+
version = "0.29.0"
9+
source = "github.com/terraform-linters/tflint-ruleset-azurerm"
10+
}
11+
12+
rule "terraform_deprecated_interpolation" {
13+
enabled = true
14+
}
15+
16+
rule "terraform_unused_declarations" {
17+
enabled = true
18+
}
19+
20+
rule "terraform_comment_syntax" {
21+
enabled = true
22+
}
23+
24+
rule "terraform_documented_outputs" {
25+
enabled = true
26+
}
27+
28+
rule "terraform_documented_variables" {
29+
enabled = true
30+
}
31+
32+
rule "terraform_typed_variables" {
33+
enabled = true
34+
}
35+
36+
rule "terraform_module_pinned_source" {
37+
enabled = true
38+
}
39+
40+
rule "terraform_naming_convention" {
41+
enabled = true
42+
format = "snake_case"
43+
}
44+
45+
rule "terraform_standard_module_structure" {
46+
enabled = true
47+
}
48+
49+
# Azure-specific rules
50+
rule "azurerm_resource_missing_tags" {
51+
enabled = true
52+
tags = ["Name", "Environment"]
53+
}

‎.vscode/extensions.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"recommendations": [
3+
"hashicorp.terraform"
4+
]
5+
}

‎.vscode/settings.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"terraform.validation.enableEnhancedValidation": true,
3+
"terraform.languageServer.enable": true,
4+
"terraform.codelens.referenceCount": true,
5+
"files.associations": {
6+
"*.tf": "terraform",
7+
"*.tfvars": "terraform",
8+
"*.tfvars.example": "terraform",
9+
".tflint.hcl": "hcl"
10+
},
11+
"editor.formatOnSave": true,
12+
"editor.codeActionsOnSave": {
13+
"source.formatDocument": "explicit"
14+
},
15+
"[terraform]": {
16+
"editor.defaultFormatter": "hashicorp.terraform",
17+
"editor.formatOnSave": true,
18+
"editor.insertSpaces": true,
19+
"editor.tabSize": 2
20+
},
21+
"[hcl]": {
22+
"editor.defaultFormatter": "hashicorp.terraform",
23+
"editor.formatOnSave": true,
24+
"editor.insertSpaces": true,
25+
"editor.tabSize": 2
26+
}
27+
}

‎.vscode/tasks.json‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
{
2+
"version": "2.0.0",
3+
"tasks": [
4+
{
5+
"label": "Terraform: Format",
6+
"type": "shell",
7+
"command": "terraform",
8+
"args": [
9+
"fmt",
10+
"-recursive"
11+
],
12+
"group": "build",
13+
"presentation": {
14+
"echo": true,
15+
"reveal": "always",
16+
"focus": false,
17+
"panel": "shared"
18+
},
19+
"problemMatcher": []
20+
},
21+
{
22+
"label": "Terraform: Validate",
23+
"type": "shell",
24+
"command": "terraform",
25+
"args": [
26+
"validate"
27+
],
28+
"group": "test",
29+
"presentation": {
30+
"echo": true,
31+
"reveal": "always",
32+
"focus": false,
33+
"panel": "shared"
34+
},
35+
"dependsOn": "Terraform: Init (no backend)"
36+
},
37+
{
38+
"label": "Terraform: Init (no backend)",
39+
"type": "shell",
40+
"command": "terraform",
41+
"args": [
42+
"init",
43+
"-backend=false"
44+
],
45+
"group": "build",
46+
"presentation": {
47+
"echo": true,
48+
"reveal": "silent",
49+
"focus": false,
50+
"panel": "shared"
51+
},
52+
"problemMatcher": []
53+
},
54+
{
55+
"label": "TFLint: Initialize",
56+
"type": "shell",
57+
"command": "tflint",
58+
"args": [
59+
"--init"
60+
],
61+
"group": "build",
62+
"presentation": {
63+
"echo": true,
64+
"reveal": "silent",
65+
"focus": false,
66+
"panel": "shared"
67+
},
68+
"problemMatcher": []
69+
},
70+
{
71+
"label": "TFLint: Run",
72+
"type": "shell",
73+
"command": "tflint",
74+
"args": [
75+
"--format",
76+
"compact"
77+
],
78+
"group": "test",
79+
"presentation": {
80+
"echo": true,
81+
"reveal": "always",
82+
"focus": false,
83+
"panel": "shared"
84+
},
85+
"dependsOn": "TFLint: Initialize",
86+
"problemMatcher": [
87+
{
88+
"owner": "tflint",
89+
"fileLocation": "relative",
90+
"pattern": {
91+
"regexp": "^([^:]+):(\\d+):(\\d+):\\s+(Error|Warning|Notice):\\s+(.*)$",
92+
"file": 1,
93+
"line": 2,
94+
"column": 3,
95+
"severity": 4,
96+
"message": 5
97+
}
98+
}
99+
]
100+
},
101+
{
102+
"label": "Terraform: Full Lint Check",
103+
"dependsOrder": "sequence",
104+
"dependsOn": [
105+
"Terraform: Format",
106+
"Terraform: Validate",
107+
"TFLint: Run"
108+
],
109+
"group": {
110+
"kind": "test",
111+
"isDefault": true
112+
},
113+
"presentation": {
114+
"echo": true,
115+
"reveal": "always",
116+
"focus": false,
117+
"panel": "shared"
118+
}
119+
}
120+
]
121+
}

‎README.md‎

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
This Terraform module provisions Azure Cloud Credentials in F5 Distributed Cloud (XC). It creates an Azure Service Principal, Application, Role Definition with required permissions, along with a Cloud Credentials object in XC Cloud.
44

5+
> **Note**: This module is developed and maintained by the [F5 DevCentral](https://github.com/f5devcentral) community. You can use this module as an example for your own development projects.
6+
57
## Requirements
68

7-
| Name | Version |
8-
|------|---------|
9-
| <a name="requirement_terraform"></a> [terraform](https://github.com/hashicorp/terraform) | >= 1.0 |
10-
| <a name="requirement_azurerm"></a> [azurerm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs) | >= 3.0 |
11-
| <a name="requirement_azuread"></a> [azuread](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs) | >= 2.0 |
12-
| <a name="requirement_volterra"></a> [volterra](https://registry.terraform.io/providers/volterraedge/volterra/latest) | >= 0.11.26 |
9+
| Name | Version |
10+
| -------------------------------------------------------------------------------------------------------------------- | --------- |
11+
| <a name="requirement_terraform"></a> [terraform](https://github.com/hashicorp/terraform) | >= 1.0 |
12+
| <a name="requirement_azurerm"></a> [azurerm](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs) | >= 4.39.0 |
13+
| <a name="requirement_azuread"></a> [azuread](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs) | >= 3.5.0 |
14+
| <a name="requirement_volterra"></a> [volterra](https://registry.terraform.io/providers/volterraedge/volterra/latest) | = 0.11.44 |
1315

1416
## Usage
1517

@@ -35,12 +37,40 @@ module "azure_cloud_credentials" {
3537
source = "f5devcentral/azure-cloud-credentials/xc"
3638
version = "0.0.6"
3739
38-
name = "azure-tf-demo-creds"
39-
create_sa = true
40-
end_date_relative = "10d"
40+
name = "azure-tf-demo-creds"
41+
create_sa = true
42+
# Set an absolute end date for the password. Example below sets it to 10 days from now.
43+
end_date = timeadd(timestamp(), "240h")
4144
}
4245
```
4346

47+
## Inputs
48+
49+
| Name | Description | Type | Default |
50+
| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | ------- |
51+
| name | Cloud Credentials name | `string` | `""` |
52+
| create_sa | Create a new Service Principal | `bool` | `false` |
53+
| azure_subscription_id | Existing Azure Subscription ID | `string` | `null` |
54+
| azure_tenant_id | Existing Azure Tenant ID | `string` | `null` |
55+
| azure_client_id | Existing Azure Service Principal Application ID | `string` | `null` |
56+
| azure_client_secret | Existing Azure Service Principal Password | `string` | `null` |
57+
| end_date | The absolute end date until which the password is valid, formatted as an RFC3339 date string (e.g. 2218-01-01T01:02:03Z). Changing this field forces a new resource to be created. | `string` | `null` |
58+
| tags | A map of tags to add to all resources | `map(string)` | `{}` |
59+
60+
## Outputs
61+
62+
| Name | Description |
63+
| --------------------------------- | ---------------------------------------------------------- |
64+
| azure_subscription_id | Azure Subscription ID |
65+
| azure_tenant_id | Azure Tenant ID |
66+
| azure_client_id | Created Azure Service Principal Application ID |
67+
| azure_client_secret | Created Azure Service Principal Password |
68+
| azure_role_definition_resource_id | Created Azure Role Definition Resource ID |
69+
| azure_service_principal_id | Created Azure Service Principal ID |
70+
| name | Created XC Cloud Credentials name |
71+
| namespace | The namespace in which the XC Cloud Credentials is created |
72+
| id | ID of the created XC Cloud Credentials |
73+
4474
## Contributing
4575

4676
Contributions to this module are welcome! Please see the contribution guidelines for more information.

0 commit comments

Comments
 (0)