diff options
| -rw-r--r-- | docs/cli.rst | 34 | ||||
| -rw-r--r-- | docs/index.rst | 21 | ||||
| -rw-r--r-- | docs/installation/bare-metal.rst (renamed from docs/installation/vyos-on-baremetal.rst) | 2 | ||||
| -rw-r--r-- | docs/installation/cloud/index.rst | 10 | ||||
| -rw-r--r-- | docs/installation/index.rst | 4 | ||||
| -rw-r--r-- | docs/installation/virtual/index.rst | 6 |
6 files changed, 33 insertions, 44 deletions
diff --git a/docs/cli.rst b/docs/cli.rst index 8169cbd5..65de0537 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -329,7 +329,7 @@ configured, changes are added through a collection of :cfgcmd:`set` and Both these ``show`` commands should be executed when in operational mode, they do not work directly in configuration mode. There is a -special way on how to :ref:`run_opmode_from_config_mode`. +special way on how to :ref:run_opmode_from_config_mode. .. hint:: Use the ``show configuration commands | strip-private`` command when you want to hide private data. You may want to do so if @@ -528,7 +528,7 @@ mode using :cfgcmd:`show | commands` set address dhcp set hw-id 00:53:ad:44:3b:03 -These commands are also relative to the level you are inside and only +These commands are also relative to the level you are inside and only relevant configuration blocks will be displayed when entering a sub-level. @@ -620,7 +620,7 @@ different levels in the hierarchy. Use this command to preserve configuration changes upon reboot. By default it is stored at */config/config.boot*. In the case you want to store the configuration file somewhere else, you can add a local - path, a SCP address, a FTP address or a TFTP address. + path, a SCP address, a FTP address or a TFTP address. .. code-block:: none @@ -675,13 +675,13 @@ different levels in the hierarchy. system will reboot into previous config revision. .. code-block:: none - + vyos@router# set firewall interface eth0 local name FromWorld - vyos@router# commit-confirm + vyos@router# commit-confirm commit confirm will be automatically reboot in 10 minutes unless confirmed Proceed? [confirm]y [edit] - vyos@router# confirm + vyos@router# confirm [edit] @@ -703,8 +703,8 @@ different levels in the hierarchy. .. code-block:: none - - vyos@router# show firewall name FromWorld + + vyos@router# show firewall name FromWorld default-action drop rule 10 { action accept @@ -713,7 +713,7 @@ different levels in the hierarchy. } } [edit] - vyos@router# edit firewall name FromWorld + vyos@router# edit firewall name FromWorld [edit firewall name FromWorld] vyos@router# copy rule 10 to rule 20 [edit firewall name FromWorld] @@ -730,7 +730,7 @@ different levels in the hierarchy. You can also rename config subtrees: .. code-block:: none - + vyos@router# rename rule 10 to rule 5 [edit firewall name FromWorld] vyos@router# commit @@ -741,8 +741,8 @@ different levels in the hierarchy. with no parameters. .. code-block:: none - - vyos@router# show + + vyos@router# show default-action drop rule 5 { action accept @@ -791,11 +791,6 @@ different levels in the hierarchy. firewall` command would return starting after the ``firewall {`` line, hiding the comment. - - - - - .. _run_opmode_from_config_mode: Access opmode from config mode @@ -1018,7 +1013,7 @@ to load it with the ``load`` command: .. code-block:: none - vyos@vyos# load + vyos@vyos# load Possible completions: <Enter> Load from system config file <file> Load from file on local machine @@ -1028,7 +1023,7 @@ to load it with the ``load`` command: http://<host>/<file> Load from file on remote machine https://<host>/<file> Load from file on remote machine tftp://<host>/<file> Load from file on remote machine - + Restore Default @@ -1051,4 +1046,3 @@ configuration too. .. note:: If you are remotely connected, you will lose your connection. You may want to copy first the config, edit it to ensure connectivity, and load the edited config. - diff --git a/docs/index.rst b/docs/index.rst index 4db014a9..69768eb8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,22 +5,21 @@ VyOS User Guide ############### - .. grid:: 3 :gutter: 2 - + .. grid-item-card:: Get / Build VyOS - + Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version. - + .. grid-item-card:: Install VyOS Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a - :ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and - how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers - + :ref:`Virtual Environment<installation/virtual/index:Virtual Environments>` and + how to use an image with the usual :ref:`cloud<installation/cloud/index:Cloud Environments>` providers + .. grid-item-card:: Configuration and Operation @@ -28,20 +27,20 @@ VyOS User Guide set up :ref:`advanced routing<configuration/protocols/index:protocols>`, :ref:`VRFs<configuration/vrf/index:vrf>`, or :ref:`VPNs<configuration/vpn/index:vpn>` for example. - + .. grid-item-card:: Automate - Integrate VyOS in your automation Workflow with + Integrate VyOS in your automation Workflow with :ref:`Ansible<vyos-ansible>`, have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`. - + .. grid-item-card:: Examples Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>` to build your infrastructure. - + .. grid-item-card:: Contribute and Community diff --git a/docs/installation/vyos-on-baremetal.rst b/docs/installation/bare-metal.rst index 7d843521..6578f84e 100644 --- a/docs/installation/vyos-on-baremetal.rst +++ b/docs/installation/bare-metal.rst @@ -1,7 +1,7 @@ .. _vyosonbaremetal: ##################### -Running on Bare Metal +Bare Metal Deployment ##################### Supermicro A2SDi (Atom C3000) diff --git a/docs/installation/cloud/index.rst b/docs/installation/cloud/index.rst index 5236f092..a76dba4c 100644 --- a/docs/installation/cloud/index.rst +++ b/docs/installation/cloud/index.rst @@ -1,8 +1,6 @@ -################################## -Running VyOS in Cloud Environments -################################## - - +################## +Cloud Environments +################## .. toctree:: :caption: Content @@ -10,4 +8,4 @@ Running VyOS in Cloud Environments aws azure gcp - oracel
\ No newline at end of file + oracel diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 435a16cd..394a226b 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -2,8 +2,6 @@ Installation and Image Management ################################# - - .. toctree:: :maxdepth: 2 :caption: Content @@ -11,7 +9,7 @@ Installation and Image Management install virtual/index cloud/index - vyos-on-baremetal + bare-metal update image migrate-from-vyatta diff --git a/docs/installation/virtual/index.rst b/docs/installation/virtual/index.rst index 8b088598..1654ff9e 100644 --- a/docs/installation/virtual/index.rst +++ b/docs/installation/virtual/index.rst @@ -1,6 +1,6 @@ -#################################### -Running VyOS in Virtual Environments -#################################### +#################### +Virtual Environments +#################### .. toctree:: :caption: Content |