arange installation and image management

19 files changed, 294 insertions, 264 deletions

diff --git a/docs/appendix/virtual/index.rst b/docs/appendix/virtual/index.rst
deleted file mode 100644
index 7ede37b5..00000000
--- a/docs/appendix/virtual/index.rst
+++ /dev/null
@@ -1,12 +0,0 @@
-.. _virtual:
-
-Running on Virtual Environments
-===============================
-
-
-.. toctree::
-   :maxdepth: 2
-
-   libvirt
-   vyos-on-vmware
-   vyos-on-gns3
diff --git a/docs/appendix/vyos-on-clouds.rst b/docs/appendix/vyos-on-clouds.rst
deleted file mode 100644
index 33b7011e..00000000
--- a/docs/appendix/vyos-on-clouds.rst
+++ /dev/null
@@ -1,173 +0,0 @@
-.. _vyos-on-clouds:
-
-Running on Clouds
-#################
-
-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/
-
-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``
-
-.. 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 fiew second 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.
-
-References
-----------
-https://azure.microsoft.com
-
-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/
-
-Oracle
-*****************
-
-References
-----------
-https://www.oracle.com/cloud/
diff --git a/docs/installation/cloud/aws.rst b/docs/installation/cloud/aws.rst
new file mode 100644
index 00000000..33684bb0
--- /dev/null
+++ b/docs/installation/cloud/aws.rst
@@ -0,0 +1,54 @@
+##########
+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..39206f3b
--- /dev/null
+++ b/docs/installation/cloud/azure.rst
@@ -0,0 +1,53 @@
+#####
+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``
+
+.. 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 fiew second 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.
+
+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..66e75704
--- /dev/null
+++ b/docs/installation/cloud/gcp.rst
@@ -0,0 +1,55 @@
+#####################
+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
new file mode 100644
index 00000000..5236f092
--- /dev/null
+++ b/docs/installation/cloud/index.rst
@@ -0,0 +1,13 @@
+##################################
+Running VyOS in Cloud Environments
+##################################
+
+
+
+.. toctree::
+   :caption: Content
+
+   aws
+   azure
+   gcp
+   oracel
\ No newline at end of file
diff --git a/docs/installation/cloud/oracel.rst b/docs/installation/cloud/oracel.rst
new file mode 100644
index 00000000..72c40127
--- /dev/null
+++ b/docs/installation/cloud/oracel.rst
@@ -0,0 +1,8 @@
+######
+Oracle
+######
+
+
+References
+----------
+https://www.oracle.com/cloud/
\ No newline at end of file
diff --git a/docs/image-mgmt.rst b/docs/installation/image.rst
index 143d02b2..074a0245 100644
--- a/docs/image-mgmt.rst
+++ b/docs/installation/image.rst
@@ -90,85 +90,7 @@ configured to be the default.
       Copyright:        VyOS maintainers and contributors
 
 
-.. _update_vyos:
 
-Update VyOS
-===========
-
-New system images can be added using the :opcmd:`add system image`
-command. The command will extract the chosen image and will prompt you
-to use the current system configuration and SSH security keys, allowing
-for the new image to boot using the current configuration.
-
-.. note:: Only LTS releases are PGP-signed.
-
-.. opcmd:: add system image <url | path> [vrf name] [username user [password pass]]
-
-   Use this command to install a new system image. You can reach the
-   image from the web (http://, https://) or from your local system,
-   e.g.  /tmp/vyos-1.2.3-amd64.iso.
-
-   The `add system image` command also supports installing new versions
-   of VyOS through an optional given VRF. Also if URL in question requires
-   authentication, you can specify an optional username and password via
-   the commandline which will be passed as "Basic-Auth" to the server.
-
-If there is not enough **free disk space available**, the installation
-will be canceled. To delete images use the :opcmd:`delete system image`
-command.
-
-VyOS configuration is associated to each image, and **each image has a
-unique copy of its configuration**. This is different than a traditional
-network router where the configuration is shared across all images.
-
-.. note:: If you have any personal files, like some scripts you created,
-   and you don't want them to be lost during the upgrade, make sure
-   those files are stored in ``/config`` as this directory is always copied
-   to newer installed images.
-
-You can access files from a previous installation and copy them to your
-current image if they were located in the ``/config`` directory. This
-can be done using the :opcmd:`copy` command. So, for instance, in order
-to copy ``/config/config.boot`` from VyOS 1.2.1 image, you would use the
-following command:
-
-.. code::
-
-   copy file 1.2.1://config/config.boot to /tmp/config.boot.1.2.1
-
-
-Example
-"""""""
-
-.. code-block:: none
-
-     vyos@vyos:~$ add system image https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso
-     Trying to fetch ISO file from https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso
-       % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
-                                      Dload  Upload   Total   Spent    Left  Speed
-     100  338M  100  338M    0     0  3837k      0  0:01:30  0:01:30 --:--:-- 3929k
-     ISO download succeeded.
-     Checking for digital signature file...
-       % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
-                                      Dload  Upload   Total   Spent    Left  Speed
-       0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
-     curl: (22) The requested URL returned error: 404 Not Found
-
-     Unable to fetch digital signature file.
-     Do you want to continue without signature check? (yes/no) [yes]
-     Checking MD5 checksums of files on the ISO image...OK.
-     Done!
-
-     What would you like to name this image? [vyos-1.3-rolling-201912201452]:
-
-     OK.  This image will be named: vyos-1.3-rolling-201912201452
-
-
-.. hint:: | The most up-do-date Rolling Release for AMD64 can be accessed using the following URL:
-   | https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso
-
-After reboot you might want to verify the version you are running with
-the :opcmd:`show version` command.
 
 
 System rollback
diff --git a/docs/installation/index.rst b/docs/installation/index.rst
index af265121..e5a2a6fd 100644
--- a/docs/installation/index.rst
+++ b/docs/installation/index.rst
@@ -12,7 +12,8 @@ Installation and Image Management
    iso
    virtual/index
    cloud/index
+   vyos-on-baremetal
    update
    image
    migrate-from-vyatta
-   ../vyos-on-baremetal
\ No newline at end of file
+   
\ No newline at end of file
diff --git a/docs/installation/iso.rst b/docs/installation/iso.rst
new file mode 100644
index 00000000..f48ad91c
--- /dev/null
+++ b/docs/installation/iso.rst
@@ -0,0 +1,2 @@
+iso
+###
\ No newline at end of file
diff --git a/docs/appendix/migrate-from-vyatta.rst b/docs/installation/migrate-from-vyatta.rst
index f15c3d5a..f15c3d5a 100644
--- a/docs/appendix/migrate-from-vyatta.rst
+++ b/docs/installation/migrate-from-vyatta.rst
diff --git a/docs/installation/upate.rst b/docs/installation/upate.rst
new file mode 100644
index 00000000..a3a887f0
--- /dev/null
+++ b/docs/installation/upate.rst
@@ -0,0 +1,79 @@
+.. _update_vyos:
+
+Update VyOS
+===========
+
+New system images can be added using the :opcmd:`add system image`
+command. The command will extract the chosen image and will prompt you
+to use the current system configuration and SSH security keys, allowing
+for the new image to boot using the current configuration.
+
+.. note:: Only LTS releases are PGP-signed.
+
+.. opcmd:: add system image <url | path> [vrf name] [username user [password pass]]
+
+   Use this command to install a new system image. You can reach the
+   image from the web (http://, https://) or from your local system,
+   e.g.  /tmp/vyos-1.2.3-amd64.iso.
+
+   The `add system image` command also supports installing new versions
+   of VyOS through an optional given VRF. Also if URL in question requires
+   authentication, you can specify an optional username and password via
+   the commandline which will be passed as "Basic-Auth" to the server.
+
+If there is not enough **free disk space available**, the installation
+will be canceled. To delete images use the :opcmd:`delete system image`
+command.
+
+VyOS configuration is associated to each image, and **each image has a
+unique copy of its configuration**. This is different than a traditional
+network router where the configuration is shared across all images.
+
+.. note:: If you have any personal files, like some scripts you created,
+   and you don't want them to be lost during the upgrade, make sure
+   those files are stored in ``/config`` as this directory is always copied
+   to newer installed images.
+
+You can access files from a previous installation and copy them to your
+current image if they were located in the ``/config`` directory. This
+can be done using the :opcmd:`copy` command. So, for instance, in order
+to copy ``/config/config.boot`` from VyOS 1.2.1 image, you would use the
+following command:
+
+.. code::
+
+   copy file 1.2.1://config/config.boot to /tmp/config.boot.1.2.1
+
+
+Example
+"""""""
+
+.. code-block:: none
+
+     vyos@vyos:~$ add system image https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso
+     Trying to fetch ISO file from https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso
+       % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                      Dload  Upload   Total   Spent    Left  Speed
+     100  338M  100  338M    0     0  3837k      0  0:01:30  0:01:30 --:--:-- 3929k
+     ISO download succeeded.
+     Checking for digital signature file...
+       % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
+                                      Dload  Upload   Total   Spent    Left  Speed
+       0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
+     curl: (22) The requested URL returned error: 404 Not Found
+
+     Unable to fetch digital signature file.
+     Do you want to continue without signature check? (yes/no) [yes]
+     Checking MD5 checksums of files on the ISO image...OK.
+     Done!
+
+     What would you like to name this image? [vyos-1.3-rolling-201912201452]:
+
+     OK.  This image will be named: vyos-1.3-rolling-201912201452
+
+
+.. hint:: | The most up-do-date Rolling Release for AMD64 can be accessed using the following URL:
+   | https://downloads.vyos.io/rolling/current/amd64/vyos-rolling-latest.iso
+
+After reboot you might want to verify the version you are running with
+the :opcmd:`show version` command.
\ No newline at end of file
diff --git a/docs/installation/virtual/eve-ng.rst b/docs/installation/virtual/eve-ng.rst
new file mode 100644
index 00000000..d5134838
--- /dev/null
+++ b/docs/installation/virtual/eve-ng.rst
@@ -0,0 +1,8 @@
+######
+EVE-NG
+######
+
+References
+==========
+
+https://www.eve-ng.net/
\ No newline at end of file
diff --git a/docs/appendix/virtual/vyos-on-gns3.rst b/docs/installation/virtual/gns3.rst
index 93ea9ae2..93ea9ae2 100644
--- a/docs/appendix/virtual/vyos-on-gns3.rst
+++ b/docs/installation/virtual/gns3.rst
diff --git a/docs/installation/virtual/index.rst b/docs/installation/virtual/index.rst
new file mode 100644
index 00000000..808439c7
--- /dev/null
+++ b/docs/installation/virtual/index.rst
@@ -0,0 +1,12 @@
+####################################
+Running VyOS in Virtual Environments
+####################################
+
+.. toctree::
+   :caption: Content
+
+   libvirt
+   proxmox
+   vmware
+   gns3
+   eve-ng
\ No newline at end of file
diff --git a/docs/appendix/virtual/libvirt.rst b/docs/installation/virtual/libvirt.rst
index 0d624b94..0d624b94 100644
--- a/docs/appendix/virtual/libvirt.rst
+++ b/docs/installation/virtual/libvirt.rst
diff --git a/docs/installation/virtual/proxmox.rst b/docs/installation/virtual/proxmox.rst
new file mode 100644
index 00000000..3ee9d70a
--- /dev/null
+++ b/docs/installation/virtual/proxmox.rst
@@ -0,0 +1,8 @@
+#######
+Proxmox
+#######
+
+References
+==========
+
+https://www.proxmox.com/en/proxmox-ve
\ No newline at end of file
diff --git a/docs/appendix/virtual/vyos-on-vmware.rst b/docs/installation/virtual/vmware.rst
index c4299cbf..c4299cbf 100644
--- a/docs/appendix/virtual/vyos-on-vmware.rst
+++ b/docs/installation/virtual/vmware.rst
diff --git a/docs/appendix/vyos-on-baremetal.rst b/docs/installation/vyos-on-baremetal.rst
index db618431..db618431 100644
--- a/docs/appendix/vyos-on-baremetal.rst
+++ b/docs/installation/vyos-on-baremetal.rst