diff options
| -rw-r--r-- | docs/automation/terraform/terraformAWS.rst | 8 | ||||
| -rw-r--r-- | docs/automation/terraform/terraformGoogle.rst | 26 | ||||
| -rw-r--r-- | docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst | 2 | ||||
| -rw-r--r-- | docs/configuration/vpn/ipsec.rst | 3 | ||||
| -rw-r--r-- | docs/documentation.rst | 2 |
5 files changed, 21 insertions, 20 deletions
diff --git a/docs/automation/terraform/terraformAWS.rst b/docs/automation/terraform/terraformAWS.rst index c705d55e..e068377d 100644 --- a/docs/automation/terraform/terraformAWS.rst +++ b/docs/automation/terraform/terraformAWS.rst @@ -26,16 +26,16 @@ Step by step: AWS - 1 Create an account with AWS and get your "access_key", "secret key" +1 Create an account with AWS and get your "access_key", "secret key" - 2 Create a key pair_ and download your .pem key +2 Create a key pair_ and download your .pem key .. image:: /_static/images/keypairs.png :width: 50% :align: center :alt: Network Topology Diagram - 3 Create a security group_ for the new VyOS instance and open all traffic +3 Create a security group_ for the new VyOS instance and open all traffic .. image:: /_static/images/sg.png :width: 50% @@ -263,7 +263,7 @@ If you need to delete the instance please type the command: Troubleshooting --------------- - 1 Ansible doesn't connect via SSH to your AWS instance: you have to check that your SSH key has copied into the path /root/aws/. +1 Ansible doesn't connect via SSH to your AWS instance: you have to check that your SSH key has copied into the path /root/aws/. Also, increase the time in the file instance.yml from 300 sec to 500 sec or more. (It depends on your location). Make sure that you have opened access to the instance in the security group. diff --git a/docs/automation/terraform/terraformGoogle.rst b/docs/automation/terraform/terraformGoogle.rst index 7cdd1211..01009be3 100644 --- a/docs/automation/terraform/terraformGoogle.rst +++ b/docs/automation/terraform/terraformGoogle.rst @@ -19,14 +19,14 @@ Step by step: google cloud - 1 Create an account with google cloud and a new project +1 Create an account with google cloud and a new project .. image:: /_static/images/project.png :width: 50% :align: center :alt: Network Topology Diagram - 2 Create a service aacount and download your key (.JSON) +2 Create a service aacount and download your key (.JSON) .. image:: /_static/images/service.png :width: 50% @@ -49,19 +49,19 @@ The .JSON file download automaticly after creating and will look like: Terraform - 1 Create an UNIX or Windows instance +1 Create an UNIX or Windows instance - 2 Download and install Terraform +2 Download and install Terraform - 3 Create the folder for example /root/google +3 Create the folder for example /root/google .. code-block:: none mkdir /root/google - 4 Copy all files into your Terraform project "/root/google" (vyos.tf, var.tf, terraform.tfvars, .JSON), more detailed see `Structure of files Terrafom for google cloud`_ +4 Copy all files into your Terraform project "/root/google" (vyos.tf, var.tf, terraform.tfvars, .JSON), more detailed see `Structure of files Terrafom for google cloud`_ - 5 Type the commands : +5 Type the commands : .. code-block:: none @@ -73,13 +73,13 @@ Terraform Ansible - 1 Create an UNIX instance whenever you want (local, cloud, and so on) +1 Create an UNIX instance whenever you want (local, cloud, and so on) - 2 Download and install Ansible +2 Download and install Ansible - 3 Create the folder for example /root/google/ +3 Create the folder for example /root/google/ - 4 Copy all files into your Ansible project "/root/google/" (ansible.cfg, instance.yml, mykey.json and "all"), more detailed see `Structure of files Ansible for google cloud`_ +4 Copy all files into your Ansible project "/root/google/" (ansible.cfg, instance.yml, mykey.json and "all"), more detailed see `Structure of files Ansible for google cloud`_ mykey.json you have to get using step 2 of the google cloud @@ -341,10 +341,10 @@ If you need to delete the instance please type the command: Troubleshooting --------------- - 1 Increase the time in the file instance.yml from 300 sec to 500 sec or more. (It depends on your location). +1 Increase the time in the file instance.yml from 300 sec to 500 sec or more. (It depends on your location). Make sure that you have opened access to the instance in the security group. - 2 Terraform doesn't connect via SSH to your Ansible instance: you have to check the correct login and password in the part of the file VyOS.tf +2 Terraform doesn't connect via SSH to your Ansible instance: you have to check the correct login and password in the part of the file VyOS.tf .. code-block:: none diff --git a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst index 96c2e1af..94acbe9a 100644 --- a/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst +++ b/docs/configexamples/autotest/tunnelbroker/tunnelbroker.rst @@ -199,7 +199,7 @@ Please note, 'autonomous-flag' and 'on-link-flag' are enabled by default, Firewall ======== -Finally, don't forget the :ref:`firewall`. The usage is identical, except for +Finally, don't forget the :ref:`Firewall<configuration/firewall/index:Firewall>`. The usage is identical, except for instead of `set firewall name NAME`, you would use `set firewall ipv6-name NAME`. diff --git a/docs/configuration/vpn/ipsec.rst b/docs/configuration/vpn/ipsec.rst index 172b3c64..d33ae37e 100644 --- a/docs/configuration/vpn/ipsec.rst +++ b/docs/configuration/vpn/ipsec.rst @@ -32,6 +32,7 @@ for the cipher and hash. Adjust this as necessary. ************************************** IKE (Internet Key Exchange) Attributes ************************************** + IKE performs mutual authentication between two parties and establishes an IKE security association (SA) that includes shared secret information that can be used to efficiently establish SAs for Encapsulating Security @@ -226,7 +227,7 @@ On the RIGHT, setup by analogy and swap local and remote addresses. Source tunnel from dummy interface -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +================================== The scheme above doesn't work when one of the routers has a dynamic external address though. The classic workaround for this is to setup an address on a diff --git a/docs/documentation.rst b/docs/documentation.rst index 79365c0d..62624c5a 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -124,7 +124,7 @@ Style Guide =========== Formatting and Sphinxmarkup --------------------------- +--------------------------- TOC Level ^^^^^^^^^^ |