Skip to content

Commit

Permalink
Automated documentation update (#14)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and github-actions[bot] authored Nov 17, 2024
1 parent 3c226b9 commit d8ed39b
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 2 deletions.
34 changes: 34 additions & 0 deletions src/kubernetes-tools/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@

# Kubernetes Tools (kubernetes-tools)

A feature to install K8s tools.

## Example Usage

```json
"features": {
"ghcr.io/lasuillard/devcontainer-features/kubernetes-tools:0": {}
}
```

## Options

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| kubectl-version | The version of kubectl to install, in format of 'v*'. | string | latest |
| install-krew | Whether to install Krew. Use 'latest' to install the latest version. Use 'none' to skip installation. | string | none |
| install-k9s | Whether to install k9s. Use 'latest' to install the latest version. Use 'none' to skip installation. | string | none |
| install-helm | Whether to install Helm. Use 'latest' to install the latest version. Use 'none' to skip installation. | string | none |

## Customizations

### VS Code Extensions

- `ms-kubernetes-tools.vscode-kubernetes-tools`
- `Tim-Koehler.helm-intellisense`



---

_Note: This file was auto-generated from the [devcontainer-feature.json](https://github.com/lasuillard/devcontainer-features/blob/main/src/kubernetes-tools/devcontainer-feature.json). Add additional notes to a `NOTES.md`._
2 changes: 1 addition & 1 deletion src/openapi-generator-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A feature to install OpenAPI Generator CLI.

| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| version | The version of OpenAPI Generator CLI to install. | string | latest |
| openapi-generator-cli-version | The version of OpenAPI Generator CLI to install. | string | latest |
| install-java | Whether to install Java (default-jre) via APT. | boolean | false |


Expand Down
2 changes: 1 addition & 1 deletion src/opentofu/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A feature to install OpenTofu and relevant tools.
| Options Id | Description | Type | Default Value |
|-----|-----|-----|-----|
| opentofu-version | The version of OpenTofu to install. | string | latest |
| terraform-is-tofu | Whether to install Terraform. | boolean | false |
| terraform-is-tofu | Whether to create symlink `terraform` to `tofu`. | boolean | false |
| install-terragrunt | Whether to install Terragrunt. Use 'latest' to install the latest version. Use 'none' to skip installation. | string | none |
| install-terraform-docs | Whether to install terraform-docs. Use 'latest' to install the latest version. Use 'none' to skip installation. | string | none |

Expand Down

0 comments on commit d8ed39b

Please sign in to comment.