summaryrefslogtreecommitdiff
path: root/docs/installation/cloud
diff options
context:
space:
mode:
authorQuill <69414602+teslazonda@users.noreply.github.com>2026-02-12 07:28:13 +0900
committerGitHub <noreply@github.com>2026-02-11 22:28:13 +0000
commit2ac2c45b1715388dfbf602fb41613637a9efb17b (patch)
treee9db343775093acfa20ab118625b3b7c2e73eb3e /docs/installation/cloud
parentb2209e913459738cba31bfe62e8022641a2f3fba (diff)
downloadvyos-documentation-2ac2c45b1715388dfbf602fb41613637a9efb17b.tar.gz
vyos-documentation-2ac2c45b1715388dfbf602fb41613637a9efb17b.zip
Proofread files in /installation/cloud (#1761)
* Proofread files in /installation/cloud * Renames 'oracel.rst' to 'oracle.rst' throughout the docs. * Fix line length lint errors
Diffstat (limited to 'docs/installation/cloud')
-rw-r--r--docs/installation/cloud/aws.rst51
-rw-r--r--docs/installation/cloud/azure.rst48
-rw-r--r--docs/installation/cloud/gcp.rst35
-rw-r--r--docs/installation/cloud/index.rst2
-rw-r--r--docs/installation/cloud/oracel.rst8
-rw-r--r--docs/installation/cloud/oracle.rst12
6 files changed, 88 insertions, 68 deletions
diff --git a/docs/installation/cloud/aws.rst b/docs/installation/cloud/aws.rst
index 8a5c1e59..5d1e9050 100644
--- a/docs/installation/cloud/aws.rst
+++ b/docs/installation/cloud/aws.rst
@@ -1,3 +1,5 @@
+:lastproofread: 2026-02-06
+
##########
Amazon AWS
##########
@@ -5,44 +7,44 @@ Amazon AWS
Deploy VM
---------
-Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)`
+Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)`.
-1. Click to ``Instances`` and ``Launch Instance``
+1. Click **Instances** and then click **Launch Instance**.
.. figure:: /_static/images/cloud-aws-01.png
-2. On the marketplace search "VyOS"
+2. Search for "VyOS" in the Marketplace.
.. figure:: /_static/images/cloud-aws-02.png
-3. Choose the instance type. Minimum recommendation start from ``m3.medium``
+3. Choose the instance type. The recommended minimum is ``m3.medium``.
.. figure:: /_static/images/cloud-aws-03.png
-4. Configure instance for your requirements. Select number of
- instances / network / subnet
+4. Configure the instance for your requirements. Select the number of
+ instances, network, and 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 skip this step.
+5. Configure additional storage. You can remove the additional storage
+ ``/dev/sdb``. The root device will be ``/dev/xvda``. You can skip 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).
+6. Configure the security group. We recommend configuring SSH access
+ only from specific sources, or you can permit any IP address (the default).
.. figure:: /_static/images/cloud-aws-06.png
-7. Select SSH key pair and click ``Launch Instances``
+7. Select the SSH key pair and click **Launch Instances**.
.. figure:: /_static/images/cloud-aws-07.png
-8. Find out your public IP address.
+8. Note your public IP address.
.. figure:: /_static/images/cloud-aws-08.png
-9. Connect to the instance by SSH key.
+9. Connect to the instance using your SSH key.
.. code-block:: none
@@ -52,8 +54,8 @@ Deploy VyOS on Amazon :abbr:`AWS (Amazon Web Services)`
Amazon CloudWatch Agent Usage
-----------------------------
-To use Amazon CloudWatch Agent, configure it within the Amazon SSM Parameter
-Store. If you don't have a configuration yet, do
+To use the Amazon CloudWatch agent, configure it in the Amazon Systems Manager
+Parameter Store. For instructions on creating a configuration, see
:ref:`configuration_creation`.
1. Create an :abbr:`IAM (Identity and Access Management)` role for the
@@ -65,7 +67,7 @@ Store. If you don't have a configuration yet, do
2. Attach the created role to your VyOS :abbr:`EC2 (Elastic Compute Cloud)`
instance.
-3. Ensure that amazon-cloudwatch-agent package is installed.
+3. Ensure the amazon-cloudwatch-agent package is installed.
.. code-block:: none
@@ -97,22 +99,23 @@ Creating the Amazon Cloudwatch Agent Configuration in Amazon
1. Create an :abbr:`IAM (Identity and Access Management)` role for your
:abbr:`EC2 (Elastic Compute Cloud)` instance to access the CloudWatch
- service. Name it CloudWatchAgentAdminRole. The role should contain at two
- default policies: ``CloudWatchAgentAdminPolicy`` and
+ service. Name it ``CloudWatchAgentAdminRole``. The role must contain at
+ least two policies: ``CloudWatchAgentAdminPolicy`` and
``AmazonSSMManagedInstanceCore``.
- .. note:: CloudWatchAgentServerRole is too permissive and should be used for
- single configuration creation and deployment. That's why after completion
- of step #3 highly recommended to replace instance
- CloudWatchAgentAdminRole role with CloudWatchAgentServerRole.
+ .. note:: CloudWatchAgentServerRole is too permissive and should be used only
+ for
+ creating and deploying a single configuration. After step 3, we recommend
+ replacing the ``CloudWatchAgentAdminRole`` with the
+ ``CloudWatchAgentServerRole``.
-2. Run Cloudwatch configuration wizard.
+2. Run the CloudWatch configuration wizard.
.. code-block:: none
$ sudo /opt/aws/amazon-cloudwatch-agent/bin/amazon-cloudwatch-agent-config-wizard
-3. When prompted, answer "yes" to the question "Do you want to store the
+3. When prompted, enter "yes" to the question "Do you want to store the
config in the SSM parameter store?".
AWS Gateway Load Balancer
diff --git a/docs/installation/cloud/azure.rst b/docs/installation/cloud/azure.rst
index e19df986..77d00814 100644
--- a/docs/installation/cloud/azure.rst
+++ b/docs/installation/cloud/azure.rst
@@ -1,3 +1,5 @@
+:lastproofread: 2026-02-09
+
#####
Azure
#####
@@ -7,14 +9,15 @@ Deploy VM
Deploy VyOS on Azure.
-1. Go to the Azure services and Click to **Add new Virtual machine**
+1. Go to Azure services and click **Add new Virtual machine**.
-2. Choose vm name, resource group, region and click **Browse all public and
- private images**
+2. Choose a VM name, resource group, and region, then 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
+3. Search for "VyOS" in the marketplace and choose the appropriate
+ subscription.
.. figure:: /_static/images/cloud-azure-02.png
@@ -22,19 +25,19 @@ Deploy VyOS on Azure.
.. figure:: /_static/images/cloud-azure-03.png
-5. Define network, subnet, Public IP. Or it will be created by default.
+5. Configure the network, subnet, and public IP. Or use the defaults.
.. figure:: /_static/images/cloud-azure-04.png
-6. Click ``Review + create``. After a few seconds your deployment will be complete
+6. Click **Review + create**. Your deployment completes in a few seconds.
.. figure:: /_static/images/cloud-azure-05.png
-7. Click to your new vm and find out your Public IP address.
+7. Select your new VM and note your public IP address.
.. figure:: /_static/images/cloud-azure-06.png
-8. Connect to the instance by SSH key.
+8. Connect to the instance with your SSH key.
.. code-block:: none
@@ -44,28 +47,37 @@ Deploy VyOS on Azure.
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.
+If your instance was deployed with one **eth0** (``WAN``) interface and you
+want to add another, you must shut down the instance. To add a new interface,
+such as **eth1** (``LAN``), attach it in the Azure portal and then restart the
+instance.
-.. note:: Azure does not allow you attach interface when the instance in the
- **Running** state.
+.. note:: Azure doesn't allow you to attach an interface while the instance is
+ running.
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.
+If you're using the VM as a router, you can use a route table to absorb some or
+all traffic from your virtual network (VNET) with your LAN interface.
-1. Create a route table and browse to **Configuration**
+1. Create a route table and navigate 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.
+2. Add one or more routes for the networks you want to route through the VyOS
+ VM. For **Next hop type**, select **Virtual Appliance** and set the **Next
+ Hop Address** to 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.
+.. note:: To create a default route for VMs on the subnet, use
+ **Address Prefix** ``0.0.0.0/0``. For a typical edge device configuration,
+ configure masquerade NAT on 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'``
+VyOS includes serial console support by default. However, if you replace the
+``config.boot`` file and reboot, ensure this configuration is present:
+
+``set system console device ttyS0 speed '9600'``
References
----------
diff --git a/docs/installation/cloud/gcp.rst b/docs/installation/cloud/gcp.rst
index 7ae1a66e..f6b6732b 100644
--- a/docs/installation/cloud/gcp.rst
+++ b/docs/installation/cloud/gcp.rst
@@ -1,3 +1,5 @@
+:lastproofread: 2026-02-09
+
#####################
Google Cloud Platform
#####################
@@ -5,48 +7,47 @@ 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.
+To deploy VyOS on Google Cloud Platform (GCP):
- Example:
+1. Generate an SSH key pair of type **ssh-rsa** on the host that will connect
+ to VyOS.
- .. code-block:: none
+ Example:
- ssh-keygen -t rsa -f ~/.ssh/vyos_gcp -C "vyos@mypc"
+ .. 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.
+.. note:: The SSH key comment must begin with ``vyos@`` because that's the
+ default VyOS user. GCP uses this value to set the username on the instance.
-2. Open GCP console and navigate to the menu **Metadata**. Choose
- **SSH Keys** and click ``edit``.
+2. Open the GCP Console and navigate to **Metadata**. Select **SSH Keys** and
+ click **Edit**.
.. figure:: /_static/images/cloud-gcp-01.png
-Click **Add item** and paste your public ssh key. Click ``Save``.
+ Click **Add item**, paste your public SSH key, and click **Save**.
.. figure:: /_static/images/cloud-gcp-02.png
-2. On marketplace search "VyOS"
+3. Search for "VyOS" in the Marketplace.
-3. Change Deployment name/Zone/Machine type and click ``Deploy``
+4. Configure the deployment name, zone, and machine type, then click **Deploy**.
.. figure:: /_static/images/cloud-gcp-03.png
-4. After few seconds click to ``instance``
+5. After a few seconds, select your **instance**.
.. figure:: /_static/images/cloud-gcp-04.png
-5. Find out your external IP address
+6. Note your external IP address.
.. figure:: /_static/images/cloud-gcp-05.png
-6. Connect to the instance. SSH key was generated in the first step.
+7. Connect to the instance using the SSH key you generated in step 1.
.. code-block:: none
diff --git a/docs/installation/cloud/index.rst b/docs/installation/cloud/index.rst
index a76dba4c..18d525ac 100644
--- a/docs/installation/cloud/index.rst
+++ b/docs/installation/cloud/index.rst
@@ -8,4 +8,4 @@ Cloud Environments
aws
azure
gcp
- oracel
+ oracle
diff --git a/docs/installation/cloud/oracel.rst b/docs/installation/cloud/oracel.rst
deleted file mode 100644
index 72c40127..00000000
--- a/docs/installation/cloud/oracel.rst
+++ /dev/null
@@ -1,8 +0,0 @@
-######
-Oracle
-######
-
-
-References
-----------
-https://www.oracle.com/cloud/ \ No newline at end of file
diff --git a/docs/installation/cloud/oracle.rst b/docs/installation/cloud/oracle.rst
new file mode 100644
index 00000000..1d02335b
--- /dev/null
+++ b/docs/installation/cloud/oracle.rst
@@ -0,0 +1,12 @@
+:lastproofread: 2026-02-09
+
+######
+Oracle
+######
+
+.. stop_vyoslinter
+References
+----------
+https://www.oracle.com/cloud/
+https://docs.oracle.com/en/cloud/paas/developer-cloud-classic/csdcc/deploy-application.html
+.. start_vyoslinter