Skip to content

Commit e0d1545

Browse files
committed
Fix docs is outdated
1 parent c3b6ffc commit e0d1545

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

docs/components/access-helper.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# access-helper
22

3-
access-helper works with nclet and bridges users and ProblemEnvironment.
3+
access-helper works with nclet and bridges users and ProblemEnvironment.
44

55
```mermaid
66
sequenceDiagram
@@ -19,7 +19,7 @@ sequenceDiagram
1919
U ->> AH: Answer question
2020
end
2121
22-
AH -->> LS: Access login shell
22+
AH -->> LS: Access login shell
2323
Note over U, LS: Start user session
2424
```
2525

@@ -67,16 +67,16 @@ topology:
6767
6868
```
6969
$ sudo clab -t manifest.yaml deploy
70-
INFO[0000] Containerlab v0.32.1 started
71-
INFO[0000] Parsing & checking topology file: manifest.yaml
72-
WARN[0000] it appears that container host has low memory available: ~0Gi. This might lead to runtime errors. Consider freeing up more memory.
73-
INFO[0000] Creating lab directory: /home/jp26081/test/clab-testlab
74-
INFO[0000] Creating container: "n2"
75-
INFO[0000] Creating container: "n1"
76-
INFO[0000] Creating virtual wire: n1:eth1 <--> n2:eth1
77-
INFO[0001] Adding containerlab host entries to /etc/hosts file
70+
INFO[0000] Containerlab v0.32.1 started
71+
INFO[0000] Parsing & checking topology file: manifest.yaml
72+
WARN[0000] it appears that container host has low memory available: ~0Gi. This might lead to runtime errors. Consider freeing up more memory.
73+
INFO[0000] Creating lab directory: /home/jp26081/test/clab-testlab
74+
INFO[0000] Creating container: "n2"
75+
INFO[0000] Creating container: "n1"
76+
INFO[0000] Creating virtual wire: n1:eth1 <--> n2:eth1
77+
INFO[0001] Adding containerlab host entries to /etc/hosts file
7878
INFO[0001] 🎉 New containerlab version 0.32.3 is available! Release notes: https://containerlab.dev/rn/0.32/#0323
79-
Run 'containerlab version upgrade' to upgrade or go check other installation options at https://containerlab.dev/install/
79+
Run 'containerlab version upgrade' to upgrade or go check other installation options at https://containerlab.dev/install/
8080
+---+-----------------+--------------+-----------------------------------+-------+---------+-----------------+----------------------+
8181
| # | Name | Container ID | Image | Kind | State | IPv4 Address | IPv6 Address |
8282
+---+-----------------+--------------+-----------------------------------+-------+---------+-----------------+----------------------+
@@ -91,14 +91,14 @@ After deploying Lab, you can access nodes with access-helper. Note that you need
9191
$ sudo ../access-helper -t manifest.yaml n1
9292
/ # echo "Hello world!"
9393
Hello world!
94-
/ #
94+
/ #
9595
9696
$ sudo ../access-helper -t manifest.yaml n2
9797
Welcome to OpenSSH Server
9898
9999
n2:~$ echo "Hello world!"
100100
Hello world!
101-
n2:~$
101+
n2:~$
102102
logout
103103
```
104104

@@ -121,14 +121,18 @@ You can reject access from normal user to specific nodes with this label. "true"
121121

122122
If you don't set this label, both normal user and admin user can access nodes.
123123

124-
### `netcon.janog.gr.jp/username`
124+
### `netcon.janog.gr.jp/sshUsername`, `netcon.janog.gr.jp/sshUsernameForAdmin`
125125

126126
You can set user name for SSH with this label. This label will be ignored when you use "exec" access method.
127127

128-
### `netcon.janog.gr.jp/password`
128+
`ForAdmin` variant is used only for admin user (isAdmin == true).
129+
130+
### `netcon.janog.gr.jp/sshPassword`, `netcon.janog.gr.jp/sshPasswordForAdmin`
129131

130132
You can set password for SSH with this label. This label will be ignored when you use "exec" access method.
131133

134+
`ForAdmin` variant is used only for admin user (isAdmin == true).
135+
132136
### `netcon.janog.gr.jp/port`
133137

134138
You can set password for SSH with this label. This label will be ignored when you use "exec" access method. If you don't set this label, 22/tcp is used to access nodes.

0 commit comments

Comments
 (0)