From 2855f2793b4832bbbe21166861bd32813dca8cb5 Mon Sep 17 00:00:00 2001
From: Erik Reid <erik.reid@geant.org>
Date: Wed, 30 Nov 2022 11:32:53 +0100
Subject: [PATCH] initial draft README

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ab2e411
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+Ansible playbook for deploying a containerlab node
+
+This playbook is used to install containerlab on a VM, and test network configurations.
+
+To run this playbook:
+
+ 1. Clone the base template (in Proxmox) "cl-base-os-template"
+ 2. Get the ip address of the new VM, and configure your ssh environment
+ 3. Create & activate a python virtual environment and install ansible
+ 4. Update inventory.yml so that your VM is defined in the "dev_environments" goup
+ 5. Run ansible like this: ansible-playbook -i inventory.yml playbook.yml
+
+ note: to run ansible, you'll also need to update group_vars/dev_environments.yml with the S3 access key & secret
+
+Containerlab project template(s) are installed from here, in the ~nat users's home directory:
+https://gitlab.geant.org/nat/ansible-containerlab/-/tree/main/roles/dev_networks/files
+
+To ssh into the nat user's shell, you'll need the containerlab-rsa private key ("b3BlbnNzaC1rZXktdjEAAAAABG5...")
+
+To start containerlab (e.g. project lab01):
+ 1. shell into the nat user
+ 2. cd lab01
+ 3. sudo containerlab deploy
-- 
GitLab