Skip to content

Commit

Permalink
added clarifications to conf artifacts
Browse files Browse the repository at this point in the history
  • Loading branch information
hellt committed Apr 22, 2021
1 parent 86a3d7e commit 7701e07
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/manual/conf-artifacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@ When containerlab deploys a lab it creates a Lab Directory in the **current work
Things like:

* Root CA certificate and node' TLS certificate and private keys
* node config file (if applicable)
* node config file (if applicable and supported by the kind)
* node-specific files and directories that are required to launch the container
* license files if needed

all these artifacts will be available under a Lab Directory.

!!!note
If you configure a node with [`binds`](nodes.md#binds) mounts and the source of the bind is not within the lab directory already, containerlab will copy over the source files/dirs into the lab directory on users behalf.

### Identifying a lab directory
The lab directory name follows the `clab-<lab_name>` template. Thus, if the name of your lab is `srl02` you will find the `clab-srl02` directory created in the current working directory.

Expand All @@ -25,7 +28,7 @@ drwxr-xr-x 3 root root 79 Dec 1 22:11 srl2
The contents of this directory will contain kind-specific files and directories. Containerlab will name directories after the node names and will only created those if they are needed. For instance, by default any node of kind `linux` will not have it's own directory under the Lab Directory.

### Persistance of a lab directory
When a user first deploy a lab, the Lab Directory gets created. Depending on a node's kind, this directory might act as a persistent storage area for a node. A common case is having the configuration file saved when the changes are made to the node via management interfaces.
When a user first deploy a lab, the Lab Directory gets created if it was not present. Depending on a node's kind, this directory might act as a persistent storage area for a node. A common case is having the configuration file saved when the changes are made to the node via management interfaces.

Below is an example of the `srl1` node directory contents. It keeps a directory that is mounted to containers configuration path, as well as stores additional files needed to launch and configure the node.

Expand Down

0 comments on commit 7701e07

Please sign in to comment.