vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

arange installation and image management

Browse Source
This commit is contained in:
rebortg 2020-11-29 19:24:16 +01:00
parent 371bf8185f
commit a6c226d4b4
19 changed files with 294 additions and 264 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/appendix/virtual/index.rst
View File

@ -1,12 +0,0 @@
.. _virtual:
Running on Virtual Environments
===============================
.. toctree::
:maxdepth: 2
libvirt
vyos-on-vmware
vyos-on-gns3

173
docs/appendix/vyos-on-clouds.rst
View File

@ -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/

54
docs/installation/cloud/aws.rst Normal file
View File

@ -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/

53
docs/installation/cloud/azure.rst Normal file
View File

@ -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

55
docs/installation/cloud/gcp.rst Normal file
View File

@ -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/

13
docs/installation/cloud/index.rst Normal file
View File

@ -0,0 +1,13 @@
##################################
Running VyOS in Cloud Environments
##################################
.. toctree::
:caption: Content
aws
azure
gcp
oracel

8
docs/installation/cloud/oracel.rst Normal file
View File

@ -0,0 +1,8 @@
######
Oracle
######
References
----------
https://www.oracle.com/cloud/

78
docs/image-mgmt.rst → docs/installation/image.rst
View File

@ -90,85 +90,7 @@ configured to be the default.
Copyright: VyOS maintainers and contributors 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 System rollback

3
docs/installation/index.rst
View File

@ -12,7 +12,8 @@ Installation and Image Management
iso iso
virtual/index virtual/index
cloud/index cloud/index
vyos-on-baremetal
update update
image image
migrate-from-vyatta migrate-from-vyatta
../vyos-on-baremetal

2
docs/installation/iso.rst Normal file
View File

@ -0,0 +1,2 @@
iso
###

0
docs/appendix/migrate-from-vyatta.rst → docs/installation/migrate-from-vyatta.rst
View File

79
docs/installation/upate.rst Normal file
View File

@ -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.

8
docs/installation/virtual/eve-ng.rst Normal file
View File

@ -0,0 +1,8 @@
######
EVE-NG
######
References
==========
https://www.eve-ng.net/

0
docs/appendix/virtual/vyos-on-gns3.rst → docs/installation/virtual/gns3.rst
View File

12
docs/installation/virtual/index.rst Normal file
View File

@ -0,0 +1,12 @@
####################################
Running VyOS in Virtual Environments
####################################
.. toctree::
:caption: Content
libvirt
proxmox
vmware
gns3
eve-ng

0
docs/appendix/virtual/libvirt.rst → docs/installation/virtual/libvirt.rst
View File

8
docs/installation/virtual/proxmox.rst Normal file
View File

@ -0,0 +1,8 @@
#######
Proxmox
#######
References
==========
https://www.proxmox.com/en/proxmox-ve

0
docs/appendix/virtual/vyos-on-vmware.rst → docs/installation/virtual/vmware.rst
View File

0
docs/appendix/vyos-on-baremetal.rst → docs/installation/vyos-on-baremetal.rst
View File