summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-14 01:16:24 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-14 02:15:48 +0300
commit6eba23f2e015e1e13e995bb34147c8e8501109ed (patch)
tree147b828d5cc9fc09ce3b3e928c653af83b837249 /docs
parent8c19456b7775f0e1a1f0e9e3d5941639702e2876 (diff)
downloadvyos-documentation-6eba23f2e015e1e13e995bb34147c8e8501109ed.tar.gz
vyos-documentation-6eba23f2e015e1e13e995bb34147c8e8501109ed.zip
docs(terraform): replace non-descriptive [link]/[install] reference labels
Surfaced by CodeRabbit on the circinus RSTβ†’MD conversion PR [vyos-documentation#2021](https://github.com/vyos/vyos-documentation/pull/2021) (`terraformvyos.md:14`). Both labels violate MD059 (descriptive link text) β€” generic words like "link" don't convey the destination to screen-reader users or search indexers. Pre-existing on rolling; out of scope for the conversion port, fixed here at the source. Mergify will backport to circinus and sagitta. Sibling `automation/terraform/index.md` already uses the descriptive form ([Terraform], [Ansible]). πŸ€– Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs')
-rw-r--r--docs/automation/terraform/terraformvyos.md28
1 files changed, 18 insertions, 10 deletions
diff --git a/docs/automation/terraform/terraformvyos.md b/docs/automation/terraform/terraformvyos.md
index cb1ca1ee..a80c4437 100644
--- a/docs/automation/terraform/terraformvyos.md
+++ b/docs/automation/terraform/terraformvyos.md
@@ -6,12 +6,14 @@ lastproofread: '2024-03-03'
# Terraform for VyOS
-VyOS supports development infrastructure via Terraform and provisioning via Ansible.
-Terraform allows you to automate the process of deploying instances on many cloud and virtual platforms.
-In this article, we will look at using terraforms to deploy VyOS on platforms - AWS, Azure, and vSphere.
-For more details about Terraform please have a look here [link].
+VyOS supports development infrastructure via Terraform and
+provisioning via Ansible. Terraform allows you to automate the
+process of deploying instances on many cloud and virtual
+platforms. In this article, we will look at using Terraform to
+deploy VyOS on platforms - AWS, Azure, and vSphere. For more
+details about Terraform, see the [Terraform introduction].
-Need to [install] Terraform
+You will need to [install Terraform] before proceeding.
Structure of files in the standard Terraform project:
@@ -20,18 +22,24 @@ Structure of files in the standard Terraform project:
β”œβ”€β”€ main.tf # The main script
β”œβ”€β”€ version.tf # File for the changing version of Terraform.
β”œβ”€β”€ variables.tf # The file of all variables in "main.tf"
-└── terraform.tfvars # The value of all variables (passwords, login, ip adresses and so on)
+└── terraform.tfvars # The value of all variables (passwords, login, IP addresses and so on)
```
General commands that we will use for running Terraform scripts
```none
-cd /<your folder> # go to the Terrafom project
-terraform init # install all addons and provider (aws az and so on)
+cd /<your folder> # go to the Terraform project
+terraform init # install all add-ons and providers (AWS, Azure, and so on)
terraform plan # show what is changing
terraform apply # run script
yes # apply running
```
-[install]: https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli
-[link]: https://developer.hashicorp.com/terraform/intro
+% stop_vyoslinter
+
+[install Terraform]: https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli
+
+% start_vyoslinter
+
+[Terraform introduction]: https://developer.hashicorp.com/terraform/intro
+