Skip to content

Commit 37b4865

Browse files
johnarnoldjohnarnold
committed
Merge pull request sonic-net#3 from tombo315/gh-pages
Adding Documentation Signed-off-by: John Arnold [email protected]
2 parents 8bb9651 + 029ac28 commit 37b4865

File tree

4 files changed

+253
-6
lines changed

4 files changed

+253
-6
lines changed

‎command_reference.md

+73
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
## Command Reference
2+
3+
### SSH Login
4+
5+
SONiC has SSH enabled by default.
6+
7+
Example:
8+
```
9+
user@debug:~$ ssh sonicadmin@sonicswitch
10+
```
11+
12+
### LLDP
13+
14+
Usage:
15+
```
16+
sudo llpdctl [Interface]
17+
```
18+
19+
Example:
20+
```
21+
sonicadmin@sonicswitch:~$ sudo lldpctl
22+
-------------------------------------------------------------------------------
23+
LLDP neighbors:
24+
-------------------------------------------------------------------------------
25+
Interface: eth0, via: LLDP, RID: 1, Time: 11 days, 15:16:47
26+
Chassis:
27+
ChassisID: mac 54:e0:32:f2:6e:00
28+
SysName: ###
29+
SysDescr: ###
30+
Capability: Bridge, on
31+
Capability: Router, on
32+
Port:
33+
PortID: local 539
34+
PortDescr: ge-0/0/12.0
35+
MFS: 1514
36+
PMD autoneg: supported: no, enabled: yes
37+
Adv: 10Base-T, HD: no, FD: yes
38+
Adv: 100Base-TX, HD: yes, FD: no
39+
Adv: 1000Base-X, HD: no, FD: yes
40+
Adv: 1000Base-T, HD: yes, FD: no
41+
MAU oper type: unknown
42+
VLAN: 146, pvid: yes ntp
43+
LLDP-MED:
44+
Device Type: Network Connectivity Device
45+
Capability: Capabilities
46+
Capability: Policy
47+
Capability: Location
48+
Capability: MDI/PSE
49+
```
50+
51+
### BGP
52+
53+
BGP is implemented via [Quagga](http://www.nongnu.org/quagga/docs/docs-info.html#Show-IP-BGP).
54+
55+
Usage:
56+
```
57+
sudo vtysh
58+
```
59+
60+
Example:
61+
```
62+
sonicadmin@sonicswitch:~$ sudo vtysh -c "show ip bgp summary"
63+
BGP router identifier 100.1.0.32, local AS number 65100
64+
RIB entries 1, using 112 bytes of memory
65+
Peers 3, using 13 KiB of memory
66+
67+
Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd
68+
100.0.0.1 4 65200 0 0 0 0 0 never Active
69+
100.0.0.3 4 65200 0 0 0 0 0 never Active
70+
100.0.0.7 4 65200 0 0 0 0 0 never Active
71+
72+
Total number of neighbors 3
73+
```

‎index.html

+8-6
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,15 @@
2121
<h1>Software for Open Networking in the Cloud</h1>
2222
<h1>SONiC</h1>
2323
</header>
24-
<h3></h3>SONiC is an open source project for network routers and switches</h3>
24+
<h3>SONiC is an open source project for network routers and switches</h3>
2525
<section id="main_menu" class="clearfix">
26-
<li>Getting Started Guide</li>
27-
<li>SONiC Architecture</li>
28-
<li>Contributing</li>
29-
<li>Source code</li>
30-
<li>Build System</li>
26+
<ul>
27+
<li><a href="https://github.com/Azure/SONiC/blob/gh-pages/quickstart.md">Started Guide</a></li>
28+
<li>SONiC Architecture</li>
29+
<li>Contributing</li>
30+
<li>Source code</li>
31+
<li>Build System</li>
32+
</ul>
3133
<a href="https://github.com/Azure/swss" id="view-on-github" class="button"><span>View on GitHub</span></a>
3234
</section>
3335

‎quickstart.md

+95
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
# SONiC - Getting Started
2+
3+
## Description
4+
This guide details the steps to install SONiC and apply a basic configuration.
5+
6+
# Prerequisites
7+
- [ONIE](http://www.opencompute.org/wiki/Networking/ONIE)-compliant switch (for this guide, we'll be using a Dell S6000-ON)
8+
- DHCP server (reachable by the target device)
9+
- HTTP server (to host the install image)
10+
11+
### Example Environment Topology
12+
```
13+
+----------+ +-----------+
14+
| | | |
15+
| Web | | |
16+
| Server +-------+ |
17+
| .10 | | |
18+
+----------+ | |
19+
| |
20+
+----------+ | |
21+
| | | |
22+
| DHCP | | L2 |
23+
| Server +-------+ Network |
24+
| .254 | | |
25+
+----------+ | |
26+
| |
27+
+----------+ | |
28+
| | | |
29+
| SONiC | | |
30+
| Switch +-------+ |
31+
| .128 | | |
32+
+----------+ +-----------+
33+
34+
35+
Subnet: 192.168.0.1/24
36+
DHCP Range: 192.168.0.128 - 253
37+
Web: 192.168.0.10
38+
DHCP: 192.168.0.254
39+
Switch: 192.168.0.128
40+
41+
```
42+
43+
44+
## Installation
45+
46+
### Preparing the Image
47+
Build instructions for SONiC can be found at [NEED LINK FOR BUILD INSTRUCTIONS.]
48+
49+
Once the image has been created, host the image via HTTP.
50+
51+
52+
### ONIE Boot
53+
_The remainder of this guide will assume that your switch is able to boot into [ONIE](http://www.opencompute.org/wiki/Networking/ONIE)._
54+
55+
Configure the DHCP server option url to point to the SONiC image. As an example with `dnsmasq` and in the respective `.conf`:
56+
```
57+
# Note MAC specific to the mgmt port and apply a static lease.
58+
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.0.128,set:onie
59+
60+
# Specify Option 114 and point to the image URL.
61+
dhcp-option=tag:onie,114,"http://HTTPSERVER/path/to/binary/sonic.bin"
62+
```
63+
64+
With DHCP configured, power cycling the switch should initiate the process of:
65+
66+
- DHCP lease acquisition
67+
- Image download
68+
- Image installation
69+
70+
For more information regarding booting with ONIE visit the [project wiki](https://github.com/opencomputeproject/onie/wiki/Quick-Start-Guide).
71+
72+
### Machine Configuration
73+
74+
There's a fair amount of post-install configuration ahead and we've gone ahead and published a project to help you along:
75+
76+
[Azure / sonic-mgmt](https://github.com/Azure/sonic-mgmt)
77+
> Tools for managing, configuring and monitoring SONiC
78+
79+
In short, this does the work of:
80+
81+
- Host configuration
82+
- Daemon installs & configuration
83+
- Template composition for common services
84+
- System startup
85+
86+
## System Reference
87+
- [Command Reference](command_reference.md)
88+
- [Troubleshooting Connectivity](troubleshooting_conn.md)
89+
90+
91+
## External Links
92+
- [ONIE](http://www.opencompute.org/wiki/Networking/ONIE)
93+
- [dnsmasq](http://www.thekelleys.org.uk/dnsmasq/docs/dnsmasq-man.html)
94+
- [Ansible](http://docs.ansible.com/)
95+

‎troubleshooting_conn.md

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
## Troubleshooting Connectivity
2+
3+
### Packet Drops
4+
5+
Usage:
6+
```
7+
sudo portstat
8+
```
9+
10+
Example:
11+
```
12+
sonicadmin@sonicswitch:~$ sudo portstat
13+
Iface RX_OK RX_RATE RX_UTIL RX_ERR RX_DRP RX_OVR TX_OK TX_RATE TX_UTIL TX_ERR TX_DRP TX_OVR
14+
---------- ------- --------- --------- -------- -------- -------- ------- --------- --------- -------- -------- --------
15+
Ethernet0 582523 N/A N/A 0 533446 0 82636 N/A N/A 0 0 0
16+
Ethernet4 582523 N/A N/A 0 533446 0 82635 N/A N/A 0 0 0
17+
Ethernet12 533446 N/A N/A 0 540582 0 82635 N/A N/A 0 0 0
18+
```
19+
20+
### Light Level
21+
22+
Usage:
23+
```
24+
sudo sfputil
25+
```
26+
27+
Example:
28+
```
29+
sonicadmin@sonicswitch:~$ sudo sfputil --dom -p Ethernet0
30+
Ethernet12: SFP detected
31+
32+
Connector : Unknown
33+
EncodingCodes : Unspecified
34+
ExtIdentOfTypeOfTransceiver : GBIC def not specified
35+
LengthOM3(UnitsOf10m) : 144
36+
RateIdentifier : Unspecified
37+
ReceivedPowerMeasurementType : Avg power
38+
TransceiverCodes :
39+
10GEthernetComplianceCode : 10G Base-SR
40+
InfinibandComplianceCode : 1X Copper Passive
41+
TypeOfTransceiver : QSFP
42+
VendorDataCode(YYYY-MM-DD Lot) : 2013-11-29
43+
VendorName : MOLEX
44+
VendorOUI : MOL
45+
VendorPN : 1064141400
46+
VendorRev : E th
47+
VendorSN : G13474P0120
48+
ChannelMonitorValues :
49+
RX1Power : -5.7398dBm
50+
RX2Power : -4.6055dBm
51+
RX3Power : -5.0252dBm
52+
RX4Power : -12.5414dBm
53+
TX1Bias : 19.1600mA
54+
TX2Bias : 19.1600mA
55+
TX3Bias : 19.1600mA
56+
TX4Bias : 19.1600mA
57+
ChannelStatus :
58+
Rx1LOS : Off
59+
Rx2LOS : Off
60+
Rx3LOS : Off
61+
Rx4LOS : Off
62+
Tx1Fault : Off
63+
Tx1LOS : Off
64+
Tx2Fault : Off
65+
Tx2LOS : Off
66+
Tx3Fault : Off
67+
Tx3LOS : Off
68+
Tx4Fault : Off
69+
Tx4LOS : Off
70+
ModuleMonitorValues :
71+
Temperature : 23.7500C
72+
Vcc : 3.2805Volts
73+
StatusIndicators :
74+
DataNotReady : Off
75+
```
76+
77+

0 commit comments

Comments
 (0)