diff options
| author | aslanvyos <a.hajiyev@vyos.io> | 2024-10-31 10:04:05 +0400 |
|---|---|---|
| committer | zdc <zdc@users.noreply.github.com> | 2024-10-31 15:24:01 +0200 |
| commit | 65f456222375c017e45f27dfb283d1d4176e260f (patch) | |
| tree | 6691af75a3fda3b68515fb08a011057e2d5f5c7f /CloudFormation/vyos-template-with-basic-configuration/readme.md | |
| parent | f731eacb91e2b5d9c51b76bae4364ceae5091280 (diff) | |
| download | vyos-automation-65f456222375c017e45f27dfb283d1d4176e260f.tar.gz vyos-automation-65f456222375c017e45f27dfb283d1d4176e260f.zip | |
Added CloudFormation templates for VyOS deployment on AWS
Diffstat (limited to 'CloudFormation/vyos-template-with-basic-configuration/readme.md')
| -rw-r--r-- | CloudFormation/vyos-template-with-basic-configuration/readme.md | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/CloudFormation/vyos-template-with-basic-configuration/readme.md b/CloudFormation/vyos-template-with-basic-configuration/readme.md new file mode 100644 index 0000000..5a953c1 --- /dev/null +++ b/CloudFormation/vyos-template-with-basic-configuration/readme.md @@ -0,0 +1,65 @@ +# VyOS Deployment with Basic Configuration
+
+## Template Overview
+
+This CloudFormation template automates the deployment of a VyOS instance, setting up:
+- A VPC with public and private subnets.
+- Internet Gateway, Route Tables, ENIs, Security Groups, and Elastic IP.
+- Configuration via cloud-init for a consistent, scalable setup.
+
+## Prerequisites
+
+Ensure the following prerequisites are met before deploying:
+- **AWS Account**: Active with necessary IAM permissions for VPCs, EC2 instances, etc.
+- **EC2 Key Pair**: Valid SSH key pair for instance access.
+- **AWS CLI/Console Access**: Familiarity with AWS Console or CLI for managing the CloudFormation stack.
+
+## Deployment Scenarios
+
+### Deploying to an Existing VPC
+
+1. Go to **AWS Console** > **CloudFormation**.
+2. Select **Create stack** - with new resources.
+3. Upload the `.yaml` template file.
+4. Specify stack details:
+ - **Stack name**.
+ - **Existing VPC and Subnet IDs** (must belong to the same AWS region and Availability Zone).
+5. Leave new VPC and Subnet CIDR fields empty.
+6. Configure VyOS Instance parameters:
+ - **Instance Type**.
+ - **EC2 Key Pair Name**.
+ - **ENI IPs** (according to the existing subnet CIDRs).
+ - **Primary and Secondary DNS** (optional).
+ - **SSH Allowed IP Subnet** (for remote access).
+
+ > **Note**: Setting `VyOS AMI Alias` to `latest` will deploy the latest version. Specify a specific version if needed, e.g., `/aws/service/marketplace/prod-ev235jujteaom/1.4.0`.
+
+7. Monitor stack creation until the **CREATE_COMPLETE** message appears.
+8. Retrieve the Public IP in the “Outputs” tab.
+
+### Deploying to a New VPC
+
+1. Go to **AWS Console** > **CloudFormation**.
+2. Select **Create stack** - with new resources.
+3. Upload the `.yaml` template file.
+4. Specify stack details:
+ - **New VPC name and CIDR**.
+ - **Public and Private Subnet CIDRs**.
+5. Leave existing VPC/Subnet IDs empty.
+6. Configure VyOS Instance parameters as listed above.
+7. Wait for **CREATE_COMPLETE** and find the Public IP under “Outputs”.
+
+## Access and Management
+
+To connect to the VyOS instance, use:
+- **VyOS Public IP** (from Outputs) and **EC2 Key Pair** with an SSH client.
+
+Sample command: `ssh vyos@<VyOS_Public_IP_Address> -i <test-key.pam>`
+
+### Common CLI Commands
+
+For VyOS configuration and interface checking:
+```bash
+show configuration commands
+show interfaces
+show ip route
|