update readme (#122)
This commit is contained in:
Родитель
902b6884f1
Коммит
bd7f9d6a59
21
README.md
21
README.md
|
@ -1,6 +1,6 @@
|
|||
# vscode-terraform-azure README
|
||||
|
||||
The VSCode Terraform Azure extension is designed to increase developer productivity building Terraform modules for Azure. The extension provides, linting, terraform command support, resource graph visualization, testing and cloudshell integration inside of VSCode.
|
||||
The VSCode Terraform Azure extension is designed to increase developer productivity building Terraform modules for Azure. The extension provides, linting, terraform command support, resource graph visualization, testing and CloudShell integration inside of VSCode.
|
||||
|
||||
![overview](images/overview.png)
|
||||
|
||||
|
@ -10,33 +10,33 @@ The features in this extension support execution in integrated terminal mode or
|
|||
|
||||
This extension supports the following features:
|
||||
|
||||
- Terraform commands: init, plan, apply, validate, refresh, destroy
|
||||
- Visualize the terraform module
|
||||
- Terraform commands: init, plan, apply, validate, refresh and destroy.
|
||||
- Visualize the terraform module.
|
||||
- Run linting and end to end tests.
|
||||
|
||||
### Terraform Azure: init
|
||||
|
||||
Executes `terraform init` command against the current project workspace. If run with terminal set to cloudshell, will run `terraform init` in cloudshell.
|
||||
Executes `terraform init` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform init` in CloudShell.
|
||||
|
||||
### Terraform Azure: plan
|
||||
|
||||
Executes `terraform plan` command against the current project workspace. If run with terminal set to cloudshell, will run `terraform plan` in cloudshell.
|
||||
Executes `terraform plan` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform plan` in CloudShell.
|
||||
|
||||
### Terraform Azure: apply
|
||||
|
||||
Executes `terraform apply` command against the current project workspace. If run with terminal set to cloudshell, will run `terraform apply` in cloudshell.
|
||||
Executes `terraform apply` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform apply` in CloudShell.
|
||||
|
||||
### Terraform Azure: validate
|
||||
|
||||
Executes `terraform validate` command against the current project workspace. If run with terminal set to cloudshell, will run `terraform validate` in cloudshell.
|
||||
Executes `terraform validate` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform validate` in CloudShell.
|
||||
|
||||
### Terraform Azure: refresh
|
||||
|
||||
Executes `terraform refresh` command against the current project workspace. If run with terminal set to cloudshell, will run `terraform refresh` in cloudshell.
|
||||
Executes `terraform refresh` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform refresh` in CloudShell.
|
||||
|
||||
### Terraform Azure: destroy
|
||||
|
||||
Executes `terraform destroy` command against the current project workspace. If run with terminal set to cloudshell, will run `terraform destroy` in cloudshell.
|
||||
Executes `terraform destroy` command against the current project workspace. If run with terminal set to CloudShell, will run `terraform destroy` in CloudShell.
|
||||
|
||||
### Terraform Azure: visualize
|
||||
|
||||
|
@ -77,6 +77,7 @@ This extension requires:
|
|||
|
||||
- [Terraform](https://www.terraform.io/downloads.html)
|
||||
- [Docker](http://www.docker.io) if you are running the execute test feature locally.
|
||||
- [Node.js 6.0+](https://nodejs.org) if you are using the CloudShell.
|
||||
- [GraphViz dot](http://www.graphviz.org) if you are using the visualize feature.
|
||||
|
||||
> NOTE: On Windows after installing the graphViz msi/zip, you will most likely need to add your PATH env variable `(Ex. c:\Program Files(x86)\GraphViz2.38\bin)` in order to use dot from the command line.
|
||||
|
@ -89,7 +90,7 @@ This extension requires:
|
|||
|
||||
- `tf-azure` - Parent for Terraform-Azure related extension settings
|
||||
- `tf-azure.terminal` - Specifies terminal used to run Terraform commands. Valid settings are `cloudshell` or `integrated`
|
||||
- `tf-azure.files` - Indicates the files that should be synchronized to Azure cloudshell using the glob pattern string, for example `**/*.{tf,txt,yml,tfvars,rb}`
|
||||
- `tf-azure.files` - Indicates the files that should be synchronized to Azure CloudShell using the glob pattern string, for example `**/*.{tf,txt,yml,tfvars,rb}`
|
||||
- `tf-azure.test-container` - Indicates the container to use to run the tests, for example `microsoft/terraform-test`. Private registry is not supported at this time.
|
||||
- `tf-azure.aci-name` - Indicates the name of the Azure Container Instance to use for testing. For example: `terraformtesting`
|
||||
- `tf-azure.aci-ResGroup` - Indicates the name of the Resource Group to use for the ACI instance. For example: `TerrafornTestRG`
|
||||
|
|
Загрузка…
Ссылка в новой задаче