Skip to content

Commit 40021c7

Browse files
devcontainers-botgithub-actions
andauthored
Automated documentation update (devcontainers#1387)
Automated documentation update [skip ci] Co-authored-by: github-actions <[email protected]>
1 parent d1540c1 commit 40021c7

File tree

4 files changed

+37
-2
lines changed

4 files changed

+37
-2
lines changed

src/azure-cli/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Installs the Azure CLI along with needed dependencies. Useful for base Dockerfil
1818
| version | Select or enter an Azure CLI version. (Available versions may vary by Linux distribution.) | string | latest |
1919
| extensions | Optional comma separated list of Azure CLI extensions to install in profile. | string | - |
2020
| installBicep | Optionally install Azure Bicep | boolean | false |
21+
| bicepVersion | Select or enter a Bicep version. ('latest' or a specic version such as 'v0.31.92') | string | latest |
2122
| installUsingPython | Install Azure CLI using Python instead of pipx | boolean | false |
2223

2324
## Customizations

src/docker-in-docker/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Create child containers *inside* a container, independent from the host's docker
1818
| version | Select or enter a Docker/Moby Engine version. (Availability can vary by OS version.) | string | latest |
1919
| moby | Install OSS Moby build instead of Docker CE | boolean | true |
2020
| mobyBuildxVersion | Install a specific version of moby-buildx when using Moby | string | latest |
21-
| dockerDashComposeVersion | Default version of Docker Compose (latest, v2 or none) | string | latest |
21+
| dockerDashComposeVersion | Default version of Docker Compose (v1, v2 or none) | string | v2 |
2222
| azureDnsAutoDetection | Allow automatically setting the dockerd DNS server when the installation script detects it is running in Azure | boolean | true |
2323
| dockerDefaultAddressPool | Define default address pools for Docker networks. e.g. base=192.168.0.0/16,size=24 | string | - |
2424
| installDockerBuildx | Install Docker Buildx | boolean | true |

src/nvidia-cuda/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Installs shared libraries for NVIDIA CUDA.
2020
| installNvtx | Additionally install NVIDIA Tools Extension (NVTX) | boolean | false |
2121
| installToolkit | Additionally install NVIDIA CUDA Toolkit | boolean | false |
2222
| cudaVersion | Version of CUDA to install | string | 11.8 |
23-
| cudnnVersion | Version of cuDNN to install | string | 8.6.0.163 |
23+
| cudnnVersion | Version of cuDNN to install | string | automatic |
2424

2525
## Compatibility
2626

src/terraform/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,51 @@ Installs the Terraform CLI and optionally TFLint and Terragrunt. Auto-detects la
2222
| installTFsec | Install tfsec, a tool to spot potential misconfigurations for your terraform code | boolean | false |
2323
| installTerraformDocs | Install terraform-docs, a utility to generate documentation from Terraform modules | boolean | false |
2424
| httpProxy | Connect to a keyserver using a proxy by configuring this option | string | - |
25+
| customDownloadServer | Custom server URL for downloading Terraform and Sentinel packages, including protocol (e.g., https://releases.hashicorp.com). If not provided, the default HashiCorp download server (https://releases.hashicorp.com) will be used. | string | - |
2526

2627
## Customizations
2728

2829
### VS Code Extensions
2930

3031
- `HashiCorp.terraform`
3132

33+
34+
3235
## Licensing
3336

3437
On August 10, 2023, HashiCorp announced a change of license for its products, including Terraform. After ~9 years of Terraform being open source under the MPL v2 license, it was to move under a non-open source BSL v1.1 license, starting from the next (1.6) version. See https://github.com/hashicorp/terraform/blob/main/LICENSE
3538

39+
## Custom Download Server
40+
41+
The `customDownloadServer` option allows you to specify an alternative server for downloading Terraform and Sentinel packages. This is useful for organizations that maintain internal mirrors or have proxies for HashiCorp downloads.
42+
43+
When using this option:
44+
- Provide the complete URL including protocol (e.g., `https://my-mirror.example.com`)
45+
- The server should mirror the HashiCorp releases structure
46+
47+
Example:
48+
```json
49+
"features": {
50+
"ghcr.io/devcontainers/features/terraform:1": {
51+
"customDownloadServer": "https://my-mirror.example.com"
52+
}
53+
}
54+
```
55+
56+
### ⚠️ Security Considerations
57+
58+
When using a custom download server, be aware of the following security implications:
59+
60+
- **Server Verification**: Always verify that the custom server is trustworthy and maintained by your organization or a trusted entity. Using an untrusted or compromised server could lead to downloading malicious software.
61+
62+
- **Supply Chain Risks**: Malicious actors may attempt to distribute compromised versions of Terraform that contain backdoors, cryptominers, or other harmful code.
63+
64+
- **Integrity Checks**: The feature performs SHA256 checks when available, but these are only as trustworthy as the source of the checksums. If both the binaries and checksums come from a compromised server, the integrity check may pass despite the software being malicious.
65+
66+
- **Organizational Policy**: Ensure your custom download server adheres to your organization's security policies and implements proper access controls.
67+
68+
Always use the official HashiCorp download server (https://releases.hashicorp.com) unless you have a specific need for an alternative source.
69+
3670
## OS Support
3771

3872
This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.

0 commit comments

Comments
 (0)