summaryrefslogtreecommitdiff
path: root/docs/automation
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-03-30 14:11:57 +0300
committerGitHub <noreply@github.com>2026-03-30 12:11:57 +0100
commita01c2c4ed50470141e7d7bbd31a3ab17418e9936 (patch)
treef13f96feb9529593a5080e1a31eb39c6e97332ed /docs/automation
parentdad139434e34d3bbf24fd46c8fa8ea7a54177d0a (diff)
downloadvyos-documentation-a01c2c4ed50470141e7d7bbd31a3ab17418e9936.tar.gz
vyos-documentation-a01c2c4ed50470141e7d7bbd31a3ab17418e9936.zip
Add TODO markers, fill placeholders, mark stub pages (#1802)
* chore: add TODO markers for 12 files needing cfgcmd/opcmd conversion Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: fill TBD placeholder in flow-accounting, remove TBD in static routes Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * docs: add stub admonitions to 3 minimal pages Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: replace non-RFC IP addresses and suppress false positives in linter Replace public IPs with RFC 5737 documentation addresses and add stop/start_vyoslinter markers for false positives (MAC addresses, OIDs, NAT64 well-known prefix). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: replace remaining non-RFC IPs and suppress MAC address false positive - Replace 8.8.8.8 (Google DNS) with 192.0.2.1 (RFC 5737) in: - docs/configexamples/ansible.rst (3 occurrences) - docs/configexamples/nmp.rst (1 occurrence) - docs/automation/terraform/terraformvSphere.rst (1 occurrence) - Wrap SHA-256 certificate fingerprint in openvpn-examples.rst with stop_vyoslinter/start_vyoslinter to suppress false-positive IPv6 flag Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: wrap long lines to comply with 80-char line length limit Wrapped prose content exceeding 80 characters in 9 documentation files. Only RST prose and directive content was modified; code block contents were left untouched as they are exempt from the linter. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: wrap 2 remaining long lines for linter compliance Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: suppress linter for long URL reference in terraformvSphere.rst * fix: address Copilot review suggestions — broken links, typos, YAML indentation - Fix broken inline RST links split across lines in sysctl.rst, eve-ng.rst, oracle.rst (stub notes with VyOS documentation repository link) - Fix YAML indentation in both playbook code blocks in ansible.rst - Fix typo "VyoS" -> "VyOS" in ansible.rst - Fix typo "desition" -> "decision" in terraformvSphere.rst - Fix 4 occurrences of "Terrafom" -> "Terraform" in terraformvSphere.rst - Fix :doc: role split across two lines in openvpn-examples.rst - Wrap long paragraph in openconnect.rst to <=80 chars and remove unnecessary stop/start_vyoslinter markers Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: resolve remaining linter failures — long lines and OID false positive Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> * fix: revert 8.8.8.8 replacements, use stop_vyoslinter instead --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Diffstat (limited to 'docs/automation')
-rw-r--r--docs/automation/terraform/terraformvSphere.rst45
1 files changed, 30 insertions, 15 deletions
diff --git a/docs/automation/terraform/terraformvSphere.rst b/docs/automation/terraform/terraformvSphere.rst
index 5d39261b..5a9aa8f5 100644
--- a/docs/automation/terraform/terraformvSphere.rst
+++ b/docs/automation/terraform/terraformvSphere.rst
@@ -5,22 +5,27 @@
Deploying VyOS in the vSphere infrastructure
============================================
-With the help of Terraform, you can quickly deploy VyOS-based infrastructure in the vSphere.
+With the help of Terraform, you can quickly deploy VyOS-based
+infrastructure in the vSphere.
Also we will make provisioning using Ansible.
-In this case, we'll create the necessary files for Terraform and Ansible next using Terraform we'll create a single instance on the vSphere cloud and make provisioning using Ansible.
+In this case, we'll create the necessary files for Terraform and
+Ansible next using Terraform we'll create a single instance on the
+vSphere cloud and make provisioning using Ansible.
Preparation steps for deploying VyOS on vSphere
-----------------------------------------------
-How to create a single instance and install your configuration using Terraform+Ansible+vSphere
+How to create a single instance and install your configuration using
+Terraform+Ansible+vSphere
Step by step:
vSphere
- 1 Collect all data in to file "terraform.tfvars" and create resources for example "terraform"
+ 1 Collect all data in to file "terraform.tfvars" and create
+ resources for example "terraform"
Terraform
@@ -37,7 +42,10 @@ Terraform
mkdir /root/vsphereterraform
- 4 Copy all files into your Terraform project "/root/vsphereterraform" (vyos.tf, var.tf, terraform.tfvars,version.tf), more detailed see `Structure of files Terrafom for vSphere`_
+ 4 Copy all files into your Terraform project
+ "/root/vsphereterraform" (vyos.tf, var.tf, terraform.tfvars,
+ version.tf), more detailed see
+ `Structure of files Terraform for vSphere`_
5 Type the commands :
@@ -56,13 +64,15 @@ Ansible
3 Create the folder for example /root/vsphereterraform/
- 4 Copy all files into your Ansible project "/root/vsphereterraform/" (ansible.cfg, instance.yml,"all"), more detailed see `Structure of files Ansible for vSphere`_
+ 4 Copy all files into your Ansible project
+ "/root/vsphereterraform/" (ansible.cfg, instance.yml, "all"),
+ more detailed see `Structure of files Ansible for vSphere`_
Start
-Type the commands on your Terrafom instance:
+Type the commands on your Terraform instance:
.. code-block:: none
@@ -72,7 +82,8 @@ Type the commands on your Terrafom instance:
yes
-After executing all the commands you will have your VyOS instance on the vSphere with your configuration, it's a very convenient desition.
+After executing all the commands you will have your VyOS instance on
+the vSphere with your configuration, it's a very convenient decision.
If you need to delete the instance please type the command:
.. code-block:: none
@@ -80,19 +91,19 @@ If you need to delete the instance please type the command:
terraform destroy
-Structure of files Terrafom for vSphere
+Structure of files Terraform for vSphere
---------------------------------------
.. code-block:: none
.
- ├── vyos.tf # The main script
- ├── versions.tf # File for the changing version of Terraform.
- ├── var.tf # File for the changing version of Terraform.
- └── terraform.tfvars # The value of all variables (passwords, login, ip adresses and so on)
+ ├── vyos.tf # The main script
+ ├── versions.tf # File for the changing version of Terraform.
+ ├── var.tf # File for the changing version of Terraform.
+ └── terraform.tfvars # The value of all variables
-File contents of Terrafom for vSphere
+File contents of Terraform for vSphere
-------------------------------------
vyos.tf
@@ -373,7 +384,7 @@ instance.yml
- name: "Configure general settings for the VyOS hosts group"
vyos_config:
lines:
- - set system name-server 8.8.8.8
+ - set system name-server 192.0.2.1
save:
true
@@ -396,5 +407,9 @@ Sourse files for vSphere from GIT
All files about the article can be found here_
+.. stop_vyoslinter
+
.. _here: https://github.com/vyos/vyos-automation/tree/main/TerraformCloud/Vsphere_terraform_ansible_single_vyos_instance-main
+.. start_vyoslinter
+