summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2021-03-29 15:54:07 +0200
committerrebortg <github@ghlr.de>2021-03-29 15:54:07 +0200
commit7b65c14fe261e38e63062ae5f8b1018d375bc06f (patch)
treea79896c6afaf97397fe783f2a8aa1f94c86f16a9 /docs
parent2fc8e13e94cfe3c31d87f286b210e1c08d098040 (diff)
downloadvyos-documentation-7b65c14fe261e38e63062ae5f8b1018d375bc06f.tar.gz
vyos-documentation-7b65c14fe261e38e63062ae5f8b1018d375bc06f.zip
cloud: backport aws, azure and gcp
Diffstat (limited to 'docs')
-rw-r--r--docs/_static/images/cloud-aws-01.pngbin0 -> 54783 bytes
-rw-r--r--docs/_static/images/cloud-aws-02.pngbin0 -> 88657 bytes
-rw-r--r--docs/_static/images/cloud-aws-03.pngbin0 -> 48191 bytes
-rw-r--r--docs/_static/images/cloud-aws-04.pngbin0 -> 131948 bytes
-rw-r--r--docs/_static/images/cloud-aws-05.pngbin0 -> 103661 bytes
-rw-r--r--docs/_static/images/cloud-aws-06.pngbin0 -> 111207 bytes
-rw-r--r--docs/_static/images/cloud-aws-07.pngbin0 -> 72764 bytes
-rw-r--r--docs/_static/images/cloud-aws-08.pngbin0 -> 20893 bytes
-rw-r--r--docs/_static/images/cloud-azure-01.pngbin0 -> 90521 bytes
-rw-r--r--docs/_static/images/cloud-azure-02.pngbin0 -> 56507 bytes
-rw-r--r--docs/_static/images/cloud-azure-03.pngbin0 -> 47364 bytes
-rw-r--r--docs/_static/images/cloud-azure-04.pngbin0 -> 87475 bytes
-rw-r--r--docs/_static/images/cloud-azure-05.pngbin0 -> 77301 bytes
-rw-r--r--docs/_static/images/cloud-azure-06.pngbin0 -> 57830 bytes
-rw-r--r--docs/_static/images/cloud-gcp-01.pngbin0 -> 5526 bytes
-rw-r--r--docs/_static/images/cloud-gcp-02.pngbin0 -> 46685 bytes
-rw-r--r--docs/_static/images/cloud-gcp-03.pngbin0 -> 106217 bytes
-rw-r--r--docs/_static/images/cloud-gcp-04.pngbin0 -> 19727 bytes
-rw-r--r--docs/_static/images/cloud-gcp-05.pngbin0 -> 26049 bytes
-rw-r--r--docs/installation/cloud/aws.rst57
-rw-r--r--docs/installation/cloud/azure.rst72
-rw-r--r--docs/installation/cloud/gcp.rst58
-rw-r--r--docs/installation/cloud/index.rst3
23 files changed, 190 insertions, 0 deletions
diff --git a/docs/_static/images/cloud-aws-01.png b/docs/_static/images/cloud-aws-01.png
new file mode 100644
index 00000000..cda6542f
--- /dev/null
+++ b/docs/_static/images/cloud-aws-01.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-02.png b/docs/_static/images/cloud-aws-02.png
new file mode 100644
index 00000000..639d42fa
--- /dev/null
+++ b/docs/_static/images/cloud-aws-02.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-03.png b/docs/_static/images/cloud-aws-03.png
new file mode 100644
index 00000000..92d3e63b
--- /dev/null
+++ b/docs/_static/images/cloud-aws-03.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-04.png b/docs/_static/images/cloud-aws-04.png
new file mode 100644
index 00000000..3ae4fb2a
--- /dev/null
+++ b/docs/_static/images/cloud-aws-04.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-05.png b/docs/_static/images/cloud-aws-05.png
new file mode 100644
index 00000000..fa3521a6
--- /dev/null
+++ b/docs/_static/images/cloud-aws-05.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-06.png b/docs/_static/images/cloud-aws-06.png
new file mode 100644
index 00000000..c8f88ded
--- /dev/null
+++ b/docs/_static/images/cloud-aws-06.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-07.png b/docs/_static/images/cloud-aws-07.png
new file mode 100644
index 00000000..d9f934ac
--- /dev/null
+++ b/docs/_static/images/cloud-aws-07.png
Binary files differ
diff --git a/docs/_static/images/cloud-aws-08.png b/docs/_static/images/cloud-aws-08.png
new file mode 100644
index 00000000..db3030a0
--- /dev/null
+++ b/docs/_static/images/cloud-aws-08.png
Binary files differ
diff --git a/docs/_static/images/cloud-azure-01.png b/docs/_static/images/cloud-azure-01.png
new file mode 100644
index 00000000..2c7b1adb
--- /dev/null
+++ b/docs/_static/images/cloud-azure-01.png
Binary files differ
diff --git a/docs/_static/images/cloud-azure-02.png b/docs/_static/images/cloud-azure-02.png
new file mode 100644
index 00000000..286b8689
--- /dev/null
+++ b/docs/_static/images/cloud-azure-02.png
Binary files differ
diff --git a/docs/_static/images/cloud-azure-03.png b/docs/_static/images/cloud-azure-03.png
new file mode 100644
index 00000000..4661a1fb
--- /dev/null
+++ b/docs/_static/images/cloud-azure-03.png
Binary files differ
diff --git a/docs/_static/images/cloud-azure-04.png b/docs/_static/images/cloud-azure-04.png
new file mode 100644
index 00000000..af12d337
--- /dev/null
+++ b/docs/_static/images/cloud-azure-04.png
Binary files differ
diff --git a/docs/_static/images/cloud-azure-05.png b/docs/_static/images/cloud-azure-05.png
new file mode 100644
index 00000000..c5a32d2e
--- /dev/null
+++ b/docs/_static/images/cloud-azure-05.png
Binary files differ
diff --git a/docs/_static/images/cloud-azure-06.png b/docs/_static/images/cloud-azure-06.png
new file mode 100644
index 00000000..1cc7cbf1
--- /dev/null
+++ b/docs/_static/images/cloud-azure-06.png
Binary files differ
diff --git a/docs/_static/images/cloud-gcp-01.png b/docs/_static/images/cloud-gcp-01.png
new file mode 100644
index 00000000..f7681d6e
--- /dev/null
+++ b/docs/_static/images/cloud-gcp-01.png
Binary files differ
diff --git a/docs/_static/images/cloud-gcp-02.png b/docs/_static/images/cloud-gcp-02.png
new file mode 100644
index 00000000..5a17efb4
--- /dev/null
+++ b/docs/_static/images/cloud-gcp-02.png
Binary files differ
diff --git a/docs/_static/images/cloud-gcp-03.png b/docs/_static/images/cloud-gcp-03.png
new file mode 100644
index 00000000..9881a5a3
--- /dev/null
+++ b/docs/_static/images/cloud-gcp-03.png
Binary files differ
diff --git a/docs/_static/images/cloud-gcp-04.png b/docs/_static/images/cloud-gcp-04.png
new file mode 100644
index 00000000..61ee2d5e
--- /dev/null
+++ b/docs/_static/images/cloud-gcp-04.png
Binary files differ
diff --git a/docs/_static/images/cloud-gcp-05.png b/docs/_static/images/cloud-gcp-05.png
new file mode 100644
index 00000000..acaafc59
--- /dev/null
+++ b/docs/_static/images/cloud-gcp-05.png
Binary files differ
diff --git a/docs/installation/cloud/aws.rst b/docs/installation/cloud/aws.rst
new file mode 100644
index 00000000..d64aca82
--- /dev/null
+++ b/docs/installation/cloud/aws.rst
@@ -0,0 +1,57 @@
+##########
+Amazon AWS
+##########
+
+Deploy VM
+---------
+
+Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)`
+
+1. Click to ``Instances`` and ``Launch Instance``
+
+.. figure:: /_static/images/cloud-aws-01.png
+
+2. On the marketplace search "VyOS"
+
+.. figure:: /_static/images/cloud-aws-02.png
+
+3. Choose the instance type. Minimum recommendation start from ``m3.medium``
+
+.. figure:: /_static/images/cloud-aws-03.png
+
+4. Configure instance for your requirements. Select number of
+ instances / network / subnet
+
+.. figure:: /_static/images/cloud-aws-04.png
+
+5. Additional storage. You can remove additional storage ``/dev/sdb``. First
+ root device will be ``/dev/xvda``. You can skeep this step.
+
+.. figure:: /_static/images/cloud-aws-05.png
+
+6. Configure Security Group. It's recommended that you configure ssh access
+ only from certain address sources. Or permit any (by default).
+
+.. figure:: /_static/images/cloud-aws-06.png
+
+7. Select SSH key pair and click ``Launch Instances``
+
+.. figure:: /_static/images/cloud-aws-07.png
+
+8. Find out your public IP address.
+
+.. figure:: /_static/images/cloud-aws-08.png
+
+9. Connect to the instance by SSH key.
+
+ .. code-block:: none
+
+ ssh -i ~/.ssh/amazon.pem vyos@203.0.113.3
+ vyos@ip-192-0-2-10:~$
+
+
+
+
+References
+----------
+https://console.aws.amazon.com/ \ No newline at end of file
diff --git a/docs/installation/cloud/azure.rst b/docs/installation/cloud/azure.rst
new file mode 100644
index 00000000..e19df986
--- /dev/null
+++ b/docs/installation/cloud/azure.rst
@@ -0,0 +1,72 @@
+#####
+Azure
+#####
+
+Deploy VM
+---------
+
+Deploy VyOS on Azure.
+
+1. Go to the Azure services and Click to **Add new Virtual machine**
+
+2. Choose vm name, resource group, region and click **Browse all public and
+ private images**
+
+.. figure:: /_static/images/cloud-azure-01.png
+
+3. On the marketplace search ``VyOS`` and choose the appropriate subscription
+
+.. figure:: /_static/images/cloud-azure-02.png
+
+4. Generate new SSH key pair or use existing.
+
+.. figure:: /_static/images/cloud-azure-03.png
+
+5. Define network, subnet, Public IP. Or it will be created by default.
+
+.. figure:: /_static/images/cloud-azure-04.png
+
+6. Click ``Review + create``. After a few seconds your deployment will be complete
+
+.. figure:: /_static/images/cloud-azure-05.png
+
+7. Click to your new vm and find out your Public IP address.
+
+.. figure:: /_static/images/cloud-azure-06.png
+
+8. Connect to the instance by SSH key.
+
+ .. code-block:: none
+
+ ssh -i ~/.ssh/vyos_azure vyos@203.0.113.3
+ vyos@vyos-doc-r1:~$
+
+Add interface
+-------------
+
+If instance was deployed with one **eth0** ``WAN`` interface and want to add
+new one. To add new interface an example **eth1** ``LAN`` you need shutdown the
+instance. Attach the interface in the Azure portal and then start the instance.
+
+.. note:: Azure does not allow you attach interface when the instance in the
+ **Running** state.
+
+Absorbing Routes
+----------------
+
+If using as a router, you will want your LAN interface to absorb some or all of the traffic from your VNET by using a route table applied to the subnet.
+
+1. Create a route table and browse to **Configuration**
+
+2. Add one or more routes for networks you want to pass through the VyOS VM. Next hop type **Virtual Appliance** with the **Next Hop Address** of the VyOS ``LAN`` interface.
+
+.. note:: If you want to create a new default route for VMs on the subnet, use **Address Prefix** ``0.0.0.0/0`` Also note that if you want to use this as a typical edge device, you'll want masquerade NAT for the ``WAN`` interface.
+
+Serial Console
+--------------
+
+Azure has a way to access the serial console of a VM, but this needs to be configured on the VyOS. It's there by default, but keep it in mind if you are replacing config.boot and rebooting: ``set system console device ttyS0 speed '9600'``
+
+References
+----------
+https://azure.microsoft.com
diff --git a/docs/installation/cloud/gcp.rst b/docs/installation/cloud/gcp.rst
new file mode 100644
index 00000000..07aecdbe
--- /dev/null
+++ b/docs/installation/cloud/gcp.rst
@@ -0,0 +1,58 @@
+#####################
+Google Cloud Platform
+#####################
+
+Deploy VM
+---------
+
+To deploy VyOS on GCP (Google Cloud Platform)
+
+1. Generate SSH key pair type **ssh-rsa** from the host that will connect to
+ VyOS.
+
+ Example:
+
+ .. code-block:: none
+
+ ssh-keygen -t rsa -f ~/.ssh/vyos_gcp -C "vyos@mypc"
+
+
+.. note:: In name "vyos@mypc" The first value must be "**vyos**". Because
+ default user is vyos and google api uses this option.
+
+
+2. Open GCP console and navigate to the menu **Metadata**. Choose
+ **SSH Keys** and click ``edit``.
+
+.. figure:: /_static/images/cloud-gcp-01.png
+
+
+Click **Add item** and paste your public ssh key. Click ``Save``.
+
+.. figure:: /_static/images/cloud-gcp-02.png
+
+
+2. On marketplace search "VyOS"
+
+3. Change Deployment name/Zone/Machine type and click ``Deploy``
+
+.. figure:: /_static/images/cloud-gcp-03.png
+
+4. After fiew seconds click to ``instance``
+
+.. figure:: /_static/images/cloud-gcp-04.png
+
+5. Find out your external IP address
+
+.. figure:: /_static/images/cloud-gcp-05.png
+
+6. Connect to the instance. SSH key was generated in the first step.
+
+ .. code-block:: none
+
+ ssh -i ~/.ssh/vyos_gcp vyos@203.0.113.3
+ vyos@vyos-r1-vm:~$
+
+References
+----------
+https://console.cloud.google.com/ \ No newline at end of file
diff --git a/docs/installation/cloud/index.rst b/docs/installation/cloud/index.rst
index 860122f5..3adff2de 100644
--- a/docs/installation/cloud/index.rst
+++ b/docs/installation/cloud/index.rst
@@ -8,4 +8,7 @@ Running VyOS in Cloud Environments
:maxdepth: 1
:caption: Content
+ aws
+ azure
+ gcp
cloud-init