Skip to content

Adding Documentation #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
johnarnold merged 4 commits into from
Mar 8, 2016
Merged

Adding Documentation #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0976fa2
adding getting started
Mar 7, 2016
eb7d24f
updating link
Mar 7, 2016
8e53ab4
adding documentation, updating index
Mar 7, 2016
029ac28
formatting
Mar 7, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions command_reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
## Command Reference

### SSH Login

SONiC has SSH enabled by default.

Example:
```
user@debug:~$ ssh sonicadmin@sonicswitch
```

### LLDP

Usage:
```
sudo llpdctl [Interface]
```

Example:
```
sonicadmin@sonicswitch:~$ sudo lldpctl
-------------------------------------------------------------------------------
LLDP neighbors:
-------------------------------------------------------------------------------
Interface: eth0, via: LLDP, RID: 1, Time: 11 days, 15:16:47
Chassis:
ChassisID: mac 54:e0:32:f2:6e:00
SysName: ###
SysDescr: ###
Capability: Bridge, on
Capability: Router, on
Port:
PortID: local 539
PortDescr: ge-0/0/12.0
MFS: 1514
PMD autoneg: supported: no, enabled: yes
Adv: 10Base-T, HD: no, FD: yes
Adv: 100Base-TX, HD: yes, FD: no
Adv: 1000Base-X, HD: no, FD: yes
Adv: 1000Base-T, HD: yes, FD: no
MAU oper type: unknown
VLAN: 146, pvid: yes ntp
LLDP-MED:
Device Type: Network Connectivity Device
Capability: Capabilities
Capability: Policy
Capability: Location
Capability: MDI/PSE
```

### BGP

BGP is implemented via [Quagga](http://www.nongnu.org/quagga/docs/docs-info.html#Show-IP-BGP).

Usage:
```
sudo vtysh
```

Example:
```
sonicadmin@sonicswitch:~$ sudo vtysh -c "show ip bgp summary"
BGP router identifier 100.1.0.32, local AS number 65100
RIB entries 1, using 112 bytes of memory
Peers 3, using 13 KiB of memory

Neighbor V AS MsgRcvd MsgSent TblVer InQ OutQ Up/Down State/PfxRcd
100.0.0.1 4 65200 0 0 0 0 0 never Active
100.0.0.3 4 65200 0 0 0 0 0 never Active
100.0.0.7 4 65200 0 0 0 0 0 never Active

Total number of neighbors 3
```
14 changes: 8 additions & 6 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@
<h1>Software for Open Networking in the Cloud</h1>
<h1>SONiC</h1>
</header>
<h3></h3>SONiC is an open source project for network routers and switches</h3>
<h3>SONiC is an open source project for network routers and switches</h3>
<section id="main_menu" class="clearfix">
<li>Getting Started Guide</li>
<li>SONiC Architecture</li>
<li>Contributing</li>
<li>Source code</li>
<li>Build System</li>
<ul>
<li><a href="https://github.com/Azure/SONiC/blob/gh-pages/quickstart.md">Started Guide</a></li>
<li>SONiC Architecture</li>
<li>Contributing</li>
<li>Source code</li>
<li>Build System</li>
</ul>
<a href="https://github.com/Azure/swss" id="view-on-github" class="button"><span>View on GitHub</span></a>
</section>

Expand Down
95 changes: 95 additions & 0 deletions quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
# SONiC - Getting Started

## Description
This guide details the steps to install SONiC and apply a basic configuration.

# Prerequisites
- [ONIE](http://www.opencompute.org/wiki/Networking/ONIE)-compliant switch (for this guide, we'll be using a Dell S6000-ON)
- DHCP server (reachable by the target device)
- HTTP server (to host the install image)

### Example Environment Topology
```
+----------+ +-----------+
| | | |
| Web | | |
| Server +-------+ |
| .10 | | |
+----------+ | |
| |
+----------+ | |
| | | |
| DHCP | | L2 |
| Server +-------+ Network |
| .254 | | |
+----------+ | |
| |
+----------+ | |
| | | |
| SONiC | | |
| Switch +-------+ |
| .128 | | |
+----------+ +-----------+


Subnet: 192.168.0.1/24
DHCP Range: 192.168.0.128 - 253
Web: 192.168.0.10
DHCP: 192.168.0.254
Switch: 192.168.0.128

```


## Installation

### Preparing the Image
Build instructions for SONiC can be found at [NEED LINK FOR BUILD INSTRUCTIONS.]

Once the image has been created, host the image via HTTP.


### ONIE Boot
_The remainder of this guide will assume that your switch is able to boot into [ONIE](http://www.opencompute.org/wiki/Networking/ONIE)._

Configure the DHCP server option url to point to the SONiC image. As an example with `dnsmasq` and in the respective `.conf`:
```
# Note MAC specific to the mgmt port and apply a static lease.
dhcp-host=aa:bb:cc:dd:ee:ff,192.168.0.128,set:onie

# Specify Option 114 and point to the image URL.
dhcp-option=tag:onie,114,"http://HTTPSERVER/path/to/binary/sonic.bin"
```

With DHCP configured, power cycling the switch should initiate the process of:

- DHCP lease acquisition
- Image download
- Image installation

For more information regarding booting with ONIE visit the [project wiki](https://github.com/opencomputeproject/onie/wiki/Quick-Start-Guide).

### Machine Configuration

There's a fair amount of post-install configuration ahead and we've gone ahead and published a project to help you along:

[Azure / sonic-mgmt](https://github.com/Azure/sonic-mgmt)
> Tools for managing, configuring and monitoring SONiC

In short, this does the work of:

- Host configuration
- Daemon installs & configuration
- Template composition for common services
- System startup

## System Reference
- [Command Reference](command_reference.md)
- [Troubleshooting Connectivity](troubleshooting_conn.md)


## External Links
- [ONIE](http://www.opencompute.org/wiki/Networking/ONIE)
- [dnsmasq](http://www.thekelleys.org.uk/dnsmasq/docs/dnsmasq-man.html)
- [Ansible](http://docs.ansible.com/)

77 changes: 77 additions & 0 deletions troubleshooting_conn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
## Troubleshooting Connectivity

### Packet Drops

Usage:
```
sudo portstat
```

Example:
```
sonicadmin@sonicswitch:~$ sudo portstat
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
---------- ------- --------- --------- -------- -------- -------- ------- --------- --------- -------- -------- --------
Ethernet0 582523 N/A N/A 0 533446 0 82636 N/A N/A 0 0 0
Ethernet4 582523 N/A N/A 0 533446 0 82635 N/A N/A 0 0 0
Ethernet12 533446 N/A N/A 0 540582 0 82635 N/A N/A 0 0 0
```

### Light Level

Usage:
```
sudo sfputil
```

Example:
```
sonicadmin@sonicswitch:~$ sudo sfputil --dom -p Ethernet0
Ethernet12: SFP detected

Connector : Unknown
EncodingCodes : Unspecified
ExtIdentOfTypeOfTransceiver : GBIC def not specified
LengthOM3(UnitsOf10m) : 144
RateIdentifier : Unspecified
ReceivedPowerMeasurementType : Avg power
TransceiverCodes :
10GEthernetComplianceCode : 10G Base-SR
InfinibandComplianceCode : 1X Copper Passive
TypeOfTransceiver : QSFP
VendorDataCode(YYYY-MM-DD Lot) : 2013-11-29
VendorName : MOLEX
VendorOUI : MOL
VendorPN : 1064141400
VendorRev : E th
VendorSN : G13474P0120
ChannelMonitorValues :
RX1Power : -5.7398dBm
RX2Power : -4.6055dBm
RX3Power : -5.0252dBm
RX4Power : -12.5414dBm
TX1Bias : 19.1600mA
TX2Bias : 19.1600mA
TX3Bias : 19.1600mA
TX4Bias : 19.1600mA
ChannelStatus :
Rx1LOS : Off
Rx2LOS : Off
Rx3LOS : Off
Rx4LOS : Off
Tx1Fault : Off
Tx1LOS : Off
Tx2Fault : Off
Tx2LOS : Off
Tx3Fault : Off
Tx3LOS : Off
Tx4Fault : Off
Tx4LOS : Off
ModuleMonitorValues :
Temperature : 23.7500C
Vcc : 3.2805Volts
StatusIndicators :
DataNotReady : Off
```