Damien/AWS-ContainerLab-Deployment
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Doc and Variables

Browse Source
This commit is contained in:
Damien A
2024-01-02 13:15:29 +01:00
parent 00ee8e73d1
commit fb2e5422c2
10 changed files with 8 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md Normal file → Executable file
View File

@@ -76,33 +76,10 @@ Before you begin, ensure you have the following prerequisites installed and conf
The Terraform configuration will automatically trigger the Ansible playbook install_containerlab.yml after the EC2 instance is up. This playbook configures the instance with the necessary packages and settings, installs ContainerLab, and optionally clones the specified GitHub repository.
## Network Images Folder and Naming Convention
### Network Images Folder
## Network Images Folder
The `network_images` folder is intended for Docker images that will be used by ContainerLab. These images should be pre-downloaded and placed in this folder before running the Ansible playbook. During the setup process, the images will be copied to the remote `/tmp` directory of the ContainerLab host and then imported into Docker.
### Naming Convention for Images
It's important to follow a specific naming convention for the images to ensure they are correctly imported into Docker. The naming convention is as follows:
`system_name_without_digit-*-tag.tar.xz`
- `system_name_without_digit`: This part of the filename should include the system name without any digits and need to be written in lower case. The system name will be converted to lowercase during the import process.
- `*`: This is a wildcard segment that can include any characters but should not contain the version or tag information.
- `tag`: This part should specify the version or tag of the image. The tag can include both lowercase and uppercase characters and digits.
#### Example
Given an image file named `cEOS64-lab-4.30.3M.tar.xz`:
- `cEOS64` will be the system name. Digits will be removed `ceos`.
- `4.30.3M` will be the tag, kept as-is.
The image will be imported into Docker with the tag `ceos:4.30.3M`.
Please ensure that all image files in the `network_images` folder conform to this naming convention for the automated process to function correctly.
## Accessing ContainerLab
- You can access the ContainerLab instance via SSH using the public IP or the DNS name provided by Route53.