Skip to content

Commit

Permalink
Merge branch 'docs-publish'
Browse files Browse the repository at this point in the history
  • Loading branch information
hellt committed Jun 29, 2021
2 parents 54216f9 + 84db39d commit 8d12776
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 228 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/cicd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
env:
GOVER: 1.16.5
CGO_ENABLED: 0
MKDOCS_MATERIAL_VER: 7.1.0
MKDOCS_MATERIAL_VER: 7.1.8

jobs:
file-changes:
Expand Down
2 changes: 2 additions & 0 deletions docs/htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ IgnoreURLs:
- img.shields.io
- www.reddit.com/r/bashonubuntuonwindows/comments/ldbyxa/what_is_the_current_state_of_kvm_acceleration_on/ # sometimes timeouts for unknown reason
- goreleaser.com # doesn't support `range 0` GETs which htmltest uses
- https://documentation.nokia.com/cgi-bin/dbaccessfilename.cgi/3HE15836AAADTQZZA01_V1_vSIM%20Installation%20and%20Setup%20Guide%2020.10.R1.pdf # fuck this false positives...
- https://documentation.nokia.com/cgi-bin/dbaccessfilename.cgi/3HE16113AAAATQZZA01_V1_SR%20Linux%20R20.6%20Software%20Installation.pdf
IgnoreDirectoryMissingTrailingSlash: true
IgnoreAltMissing: true
IgnoreSSLVerify: true
Expand Down
218 changes: 0 additions & 218 deletions docs/lab-examples/tls-cert.md

This file was deleted.

7 changes: 4 additions & 3 deletions docs/manual/cert.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
As more and more services move to "secure by default" behavior, it becomes important to simplify the PKI/TLS infrastructure provisioning in the lab environments. Containerlab embeds parts of [cfssl](https://github.com/cloudflare/cfssl) project to automate certificate generation and provisioning.

For [SR Linux](kinds/srl.md) nodes containerlab creates Certificate Authority and generates signed cert and key for each node of a lab. This makes SR Linux node to boot up with TLS profiles correctly configured and enable operation of a secured management protocol - gNMI.
For [SR Linux](kinds/srl.md) nodes containerlab creates Certificate Authority (CA) and generates signed cert and key for each node of a lab. This makes SR Linux node to boot up with TLS profiles correctly configured and enable operation of a secured management protocol - gNMI.

> For other nodes the automated TLS pipeline is not provided yet and can be addressed by contributors.
!!!note
For other nodes the automated TLS pipeline is not provided yet and can be addressed by contributors.

Apart from automated pipeline for certificate provisioning, containerlab exposes the following commands that can create a CA and node's cert/key:

* [`tools cert ca create`](../cmd/tools/cert/ca/create.md) - creates a Certificate Authority
* [`tools cert sign`](../cmd/tools/cert/sign.md) - creates certificate/key for a host and signs the certificate with CA

With these two commands users can easily create CA node certificates and secure the transport channel of various protocols. This lab from our demonstrates how with containerlab help one can easily create certificates and configure Nokia SR OS to use it for secured gNMI communication.
With these two commands users can easily create CA node certificates and secure the transport channel of various protocols. [This lab](https://clabs.netdevops.me/security/gnmitls/) demonstrates how with containerlab's help one can easily create certificates and configure Nokia SR OS to use it for secured gNMI communication.
4 changes: 2 additions & 2 deletions docs/manual/nodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,12 +216,12 @@ topology:
label2: value2
kinds:
srl:
env:
labels:
label1: kind_value1
label3: value3
nodes:
node1:
env:
labels:
label1: node_value1
```

Expand Down
9 changes: 5 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ nav:
- vr-vmx - Juniper vMX: manual/kinds/vr-vmx.md
- vr-xrv9k - Cisco XRv9k: manual/kinds/vr-xrv9k.md
- vr-xrv - Cisco XRv: manual/kinds/vr-xrv.md
- vr-csr - Cisco CSR1000v: manual/kinds/vr-csr.md
- vr-veos - Arista vEOS: manual/kinds/vr-veos.md
- vr-ros - MikroTik RouterOS: manual/kinds/vr-ros.md
- linux - Linux container: manual/kinds/linux.md
Expand Down Expand Up @@ -87,6 +88,7 @@ site_description: >-
# Repository
repo_name: srl-labs/containerlab
repo_url: https://github.com/srl-labs/containerlab
site_url: "https://containerlab.srlinux.dev/"
edit_uri: ""
theme:
name: material
Expand Down Expand Up @@ -145,6 +147,9 @@ extra:
link: https://github.com/hellt
- icon: fontawesome/brands/twitter
link: https://twitter.com/ntdvps
analytics:
provider: google
property: G-368XR9X5MG

extra_css:
- stylesheets/extra.css
Expand Down Expand Up @@ -186,7 +191,3 @@ markdown_extensions:
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde

google_analytics:
- UA-101537614-3
- auto

0 comments on commit 8d12776

Please sign in to comment.