added more docs around sonic

srl-labs · Jul 3, 2024 · cf6c90c · cf6c90c
1 parent f4f23ac
commit cf6c90c
Show file tree

Hide file tree

Showing 3 changed files with 94 additions and 10 deletions.
diff --git a/docs/manual/kinds/sonic-vm.md b/docs/manual/kinds/sonic-vm.md
@@ -6,22 +6,90 @@ search:
 
 [SONiC](https://sonic-net.github.io/SONiC/) Network OS is distributed in two formats suitable for testing with containerlab
 
-1. Containerized SONiC
-2. Virtual Machine SONiC (topic of this document)
+1. Containerized SONiC (`sonic-vs` kind)
+2. Virtual Machine SONiC (`sonic-vm` kind; the topic of this document)
 
-This document covers the containerized SONiC that is identified with `sonic-vs` kind in the [topology file](../topo-def-file.md). A kind defines a supported feature set and a startup procedure of a `sonic-vs` node.
+This document covers the VM flavor of the upstream SONiC that is identified with `sonic-vm` kind in the [topology file](../topo-def-file.md). A kind defines a supported feature set and a startup procedure of a `sonic-vm` node.
+
+The VM-based image of SONiC is built with the [`hellt/vrnetlab`](https://github.com/hellt/vrnetlab/tree/master/sonic) project.
 
 ## Getting Sonic images
 
 Getting SONiC images is possible via two resources:
 
-1. [Sonic.software](https://sonic.software/) -- an unofficial repo with SONiC images
-2. [Azure pipeline](https://dev.azure.com/mssonic/build/_build) -- an official source of SONiC images, but finding the right one there is a pita.
+1. [Sonic.software](https://sonic.software/) -- an unofficial repo with SONiC images (may be down sometimes, uses Azure pipeline as a source)
+2. [Azure pipeline](https://sonic-build.azurewebsites.net/ui/sonic/pipelines) -- an official source of SONiC images, but finding the right one there is a pita.
+
+When https://sonic.software is down, you can follow the following procedure to find the SONiC image in the Azure pipeline artifacts maze:
+
+1. Go to the piplines list: https://sonic-build.azurewebsites.net/ui/sonic/pipelines
+2. Scroll all the way to the bottom where `vs` platform is listed
+3. Pick a branch name that you want to use (e.g. `202405`) and click on the "Build History".
+4. On the build history page choose the latest build that has succeeded (check the Result column) and click on the "Artifacts" link
+5. In the new window, you will see a list with a single artifact, click on it
+6. One more long scroll down until you see `target/sonic-vs.img.gz` name (or Ctrl+F for it), click on it to start the download or copy the download link.
+7. Here you go, you managed to download a SONiC image from a mysteriosly named branch for a build that probably means nothing to you. This Sonic experience for ya...
+
+/// details | How to download SONiC image from Azure pipeline (video)
+<video width="100%" controls>
+  <source src="https://gitlab.com/rdodin/pics/-/wikis/uploads/054c60a0c8d685f826297c115470221b/sonic-dl.mp4" type="video/mp4">
+</video>
+///
+
+## Managing sonic-vm nodes
+
+SONiC node launched with containerlab takes approximately 1 minute to boot up and can be managed via the following interfaces:
 
-## Managing sonic-vs nodes
+/// note
+The default login credentials for the SONiC VM are `admin:admin`
+///
+
+/// tab | SSH
+To open a linux shell simply type in
 
-SONiC node launched with containerlab can be managed via the following interfaces:
+```bash
+ssh <node-name>
+```
+
+You will enter the bash shell of the VM:
+
+```
+❯ ssh clab-sonic-sonic 
+Warning: Permanently added 'clab-sonic-sonic' (RSA) to the list of known hosts.
+Debian GNU/Linux 12 \n \l
 
+admin@clab-sonic-sonic's password: 
+Linux sonic 6.1.0-11-2-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.38-4 (2023-08-08) x86_64
+You are on
+  ____   ___  _   _ _  ____
+ / ___| / _ \| \ | (_)/ ___|
+ \___ \| | | |  \| | | |
+  ___) | |_| | |\  | | |___
+ |____/ \___/|_| \_|_|\____|
+
+-- Software for Open Networking in the Cloud --
+
+Unauthorized access and/or use are prohibited.
+All access and/or use are subject to monitoring.
+
+Help:    https://sonic-net.github.io/SONiC/
+
+Last login: Wed Jul  3 09:45:35 2024
+admin@sonic:~$
+```
+
+From within the Linux shell users can perform system configuration using linux utilities, or connect to the SONiC CLI using `vtysh` command.
+
+```
+admin@sonic:~$ vtysh
+
+Hello, this is FRRouting (version 8.5.4).
+Copyright 1996-2005 Kunihiro Ishiguro, et al.
+
+sonic#
+```
+
+///
 /// tab | bash
 to connect to a `bash` shell of a running sonic-vs container:
 

diff --git a/docs/manual/kinds/sonic-vs.md b/docs/manual/kinds/sonic-vs.md
@@ -15,8 +15,24 @@ This document covers the containerized SONiC that is identified with `sonic-vs`
 
 Getting SONiC images is possible via two resources:
 
-1. [Sonic.software](https://sonic.software/) -- an unofficial repo with SONiC images
-2. [Azure pipeline](https://dev.azure.com/mssonic/build/_build) -- an official source of SONiC images, but finding the right one there is a pita.
+1. [Sonic.software](https://sonic.software/) -- an unofficial repo with SONiC images (may be down sometimes, uses Azure pipeline as a source)
+2. [Azure pipeline](https://sonic-build.azurewebsites.net/ui/sonic/pipelines) -- an official source of SONiC images, but finding the right one there is a pita.
+
+When https://sonic.software is down, you can follow the following procedure to find the SONiC image in the Azure pipeline artifacts maze:
+
+1. Go to the piplines list: https://sonic-build.azurewebsites.net/ui/sonic/pipelines
+2. Scroll all the way to the bottom where `vs` platform is listed
+3. Pick a branch name that you want to use (e.g. `202405`) and click on the "Build History".
+4. On the build history page choose the latest build that has succeeded (check the Result column) and click on the "Artifacts" link
+5. In the new window, you will see a list with a single artifact, click on it
+6. One more long scroll down until you see `target/docker-sonic-vs.gz` name (or Ctrl+F for it), click on it to start the download or copy the download link.
+7. Here you go, you managed to download a SONiC image from a mysteriosly named branch for a build that probably means nothing to you. This Sonic experience for ya...
+
+/// details | How to download SONiC image from Azure pipeline (video)
+<video width="100%" controls>
+  <source src="https://gitlab.com/rdodin/pics/-/wikis/uploads/054c60a0c8d685f826297c115470221b/sonic-dl.mp4" type="video/mp4">
+</video>
+///
 
 ## Managing sonic-vs nodes
 

diff --git a/nodes/sonic_vm/sonic_vm.go b/nodes/sonic_vm/sonic_vm.go
@@ -19,7 +19,7 @@ import (
 )
 
 var (
-	kindnames          = []string{"sonic_vm"}
+	kindnames          = []string{"sonic-vm"}
 	defaultCredentials = nodes.NewCredentials("admin", "admin")
 )