Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
tianshangfei authored Sep 28, 2022
2 parents 2f402fd + 42e3e2f commit 48a2c4f
Show file tree
Hide file tree
Showing 143 changed files with 12,496 additions and 695 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ assignees: ''

---

**We do not triage issue for this repo. All issues are triaged in Azure/sonic-buildimage repo**
**We do not triage issue for this repo. All issues are triaged in sonic-net/sonic-buildimage repo**
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For example:
* Use issues to keep track of what is going on

##Expectations for pull requests
Pull requests should be free of any known bugs and be accompanied by tests and appropriate documentation. Test coverage may include unit tests, integration tests such as [PTF tests](https://github.com/Azure/SONiC/wiki/HOWTO-write-a-PTF-Test) defined in the [sonic-mgmt repo](https://github.com/Azure/sonic-mgmt/tree/master/ansible/roles/test/tasks).
Pull requests should be free of any known bugs and be accompanied by tests and appropriate documentation. Test coverage may include unit tests, integration tests such as [PTF tests](https://github.com/sonic-net/SONiC/wiki/HOWTO-write-a-PTF-Test) defined in the [sonic-mgmt repo](https://github.com/sonic-net/sonic-mgmt/tree/master/ansible/roles/test/tasks).

## Commiting new test
When commiting a new feature with a new test, please complete a [test plan from the template](doc/SONiC%20Test%20Plan%20Template.md)
Expand Down
125 changes: 95 additions & 30 deletions MoM.html

Large diffs are not rendered by default.

6 changes: 4 additions & 2 deletions Supported-Devices-and-Platforms.html
Original file line number Diff line number Diff line change
Expand Up @@ -1169,10 +1169,12 @@ <h2><p style="text-align: left; font-family: Verdana, sans-serif; color: #2E86C1
vdata = table[i].children[2].textContent;
if (vdata == "Nvidia")
vdata = "Mellanox";

if (vdata == "Intel")
vdata = "Barefoot";

if (vdata == "Marvell"){
if(table[i].children[1].textContent.search("ARM") != -1)
vdata = "Marvell-armhf";
vdata = "Marvell-armhf";
}

if(vendor_data[vdata] == "")
Expand Down
4 changes: 2 additions & 2 deletions contact.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ <h2>Contact</h2>
<p>Send questions, bugs, comments and ideas to [email protected]</p>
<p>Join the <a href="https://groups.google.com/forum/#!forum/sonicproject"><font color="#0000FF" size="3">mailing list</font></a> </p>
<p>Join the <a href="https://sonicswitch.slack.com"><font color="#0000FF" size="3">Slack discussion group</font></a></p>
<p>Report issues <a href="https://github.com/Azure/SONiC/issues"><font color="#0000FF" size="3">here</font></a> and provide the following:</p>
<p>Report issues <a href="https://github.com/sonic-net/SONiC/issues"><font color="#0000FF" size="3">here</font></a> and provide the following:</p>
<p> -show version output</p>
<p> -SONiC support file generated by the sudo generate_dump command</p>
</div>
Expand Down Expand Up @@ -143,4 +143,4 @@ <h2>Contact</h2>
<script src="assets/js/custom.js"></script>

</body>
</html>
</html>
12 changes: 6 additions & 6 deletions doc/SONiC 201904 Release Notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# SONiC 201904 Release Notes

# Branch Location
https://github.com/Azure/sonic-buildimage/tree/201904
https://github.com/sonic-net/sonic-buildimage/tree/201904

# Dependency Version

Expand All @@ -27,11 +27,11 @@ https://github.com/Azure/sonic-buildimage/tree/201904
| 1 | [FRR as default routing stack](http://docs.frrouting.org/en/latest/) | |
| 2 | Upgrade each docker to stretch version | SNMPD, LLDPD, Teamd |
| 3 | Upgrade docker engine to 18.09 | |
| 4 | [Everflow enhancement](https://github.com/Azure/SONiC/blob/bb4f4a3a85935a38ec7f9625ef62cbe58c0998b4/doc/SONiC_EVERFLOW_IPv6.pdf) | |
| 5 | [Egress ACL bug fix and ACL CLI enhancement](https://github.com/Azure/SONiC/blob/dfa7e58292deb4d7b10d1e0ca73f296cd206e9d2/doc/acl/egress-acl-bug-fix-description.md) | |
| 6 | [L3 RIF counter support](https://github.com/Azure/SONiC/blob/master/doc/RIF_counters.md) [PR](https://github.com/Azure/SONiC/pull/310) | |
| 7 | [PMon Refactoring](https://github.com/Azure/SONiC/tree/master/doc/pmon) | |
| 8 | BGP-EVPN support (type 5) (related HLD [Fpmsyncd](https://github.com/Azure/SONiC/pull/375), [vxlanmgr](https://github.com/Azure/SONiC/pull/369), [template](https://github.com/Azure/sonic-buildimage/pull/2838/files) ) | |
| 4 | [Everflow enhancement](https://github.com/sonic-net/SONiC/blob/bb4f4a3a85935a38ec7f9625ef62cbe58c0998b4/doc/SONiC_EVERFLOW_IPv6.pdf) | |
| 5 | [Egress ACL bug fix and ACL CLI enhancement](https://github.com/sonic-net/SONiC/blob/dfa7e58292deb4d7b10d1e0ca73f296cd206e9d2/doc/acl/egress-acl-bug-fix-description.md) | |
| 6 | [L3 RIF counter support](https://github.com/sonic-net/SONiC/blob/master/doc/RIF_counters.md) [PR](https://github.com/sonic-net/SONiC/pull/310) | |
| 7 | [PMon Refactoring](https://github.com/sonic-net/SONiC/tree/master/doc/pmon) | |
| 8 | BGP-EVPN support (type 5) (related HLD [Fpmsyncd](https://github.com/sonic-net/SONiC/pull/375), [vxlanmgr](https://github.com/sonic-net/SONiC/pull/369), [template](https://github.com/sonic-net/sonic-buildimage/pull/2838/files) ) | |


# Security Updates
Expand Down
78 changes: 39 additions & 39 deletions doc/SONiC-User-Manual.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ Table of Contents
# Introduction
SONiC is an open source network operating system based on Linux that runs on switches from multiple vendors and ASICs. SONiC offers a full-suite of network functionality, like BGP and RDMA, that has been production-hardened in the data centers of some of the largest cloud-service providers. It offers teams the flexibility to create the network solutions they need while leveraging the collective strength of a large ecosystem and community.

SONiC software shall be loaded in these [supported devices](https://github.com/Azure/SONiC/wiki/Supported-Devices-and-Platforms) and this User guide explains the basic steps for using the SONiC in those platforms.
SONiC software shall be loaded in these [supported devices](https://github.com/sonic-net/SONiC/wiki/Supported-Devices-and-Platforms) and this User guide explains the basic steps for using the SONiC in those platforms.

Connect the console port of the device and use the 9600 baud rate to access the device. Follow the [Quick Start Guide](https://github.com/Azure/SONiC/wiki/Quick-Start) to boot the device in ONIE mode and install the SONiC software using the steps specified in the document and reboot the device. In some devices that are pre-loaded with SONiC software, this step can be skipped.
Connect the console port of the device and use the 9600 baud rate to access the device. Follow the [Quick Start Guide](https://github.com/sonic-net/SONiC/wiki/Quick-Start) to boot the device in ONIE mode and install the SONiC software using the steps specified in the document and reboot the device. In some devices that are pre-loaded with SONiC software, this step can be skipped.
Users shall use the default username/password "admin/YourPaSsWoRd" to login to the device through the console port.

After logging into the device, SONiC software can be configured in following three methods.
1) [Command Line Interface](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md)
2) [config_db.json](https://github.com/Azure/SONiC/wiki/Configuration)
3) [minigraph.xml](https://github.com/Azure/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))
1) [Command Line Interface](https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md)
2) [config_db.json](https://github.com/sonic-net/SONiC/wiki/Configuration)
3) [minigraph.xml](https://github.com/sonic-net/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))

Users can use all of the above methods or choose either one method to configure and to view the status of the device.
This user manual explains the common commands & related configuration/show examples on how to use the SONiC device. Refer the above documents for more detailed information.
Expand All @@ -78,9 +78,9 @@ This guide details the steps to install a SONiC image on your supported switch.

## 1.1 Download Image

We have one SONiC Image per ASIC vendor. You can download SONiC Image [here](https://github.com/Azure/SONiC/wiki/Supported-Devices-and-Platforms)
We have one SONiC Image per ASIC vendor. You can download SONiC Image [here](https://github.com/sonic-net/SONiC/wiki/Supported-Devices-and-Platforms)

You can also build SONiC from source and the instructions can be found [here](https://github.com/Azure/sonic-buildimage).
You can also build SONiC from source and the instructions can be found [here](https://github.com/sonic-net/sonic-buildimage).

Once the image is available in your local machine, the image can be installed either by installing using a USB thumb drive or over the network as given in following sub-sections.
In case if the device is already preloaded with SONiC image, the device can be booted without the installation process.
Expand Down Expand Up @@ -241,19 +241,19 @@ This TSG gives the instruction of how to reset a SONiC switch password.
1. Edit Grub boot menu options
1.1 First you need to get into grub menu options. This menu is displayed right at the beginning of the boot. You should get something similar to this, but not the exactly the same.
Choose the choice Start with SONiC-:
![image.png](https://github.com/Azure/SONiC/blob/master/images/PW-1.png)
![image.png](https://github.com/sonic-net/SONiC/blob/master/images/PW-1.png)

1.2 Now we attempt to edit grub's boot option. Press "e" to edit the first grub menu option and navigate to kernel line:
![image.png](https://github.com/Azure/SONiC/blob/master/images/PW-2.png)
![image.png](https://github.com/sonic-net/SONiC/blob/master/images/PW-2.png)

1.3 Remove quiet and add init=/bin/bash
![image.png](https://github.com/Azure/SONiC/blob/master/images/PW-3.png)
![image.png](https://github.com/sonic-net/SONiC/blob/master/images/PW-3.png)

1.4 Press Ctrl-x to boot

2. Remount / and /proc
2.1 After successfully boot you will be presented with bash command prompt:
![image.png](https://github.com/Azure/SONiC/blob/master/images/PW-4.png)
![image.png](https://github.com/sonic-net/SONiC/blob/master/images/PW-4.png)

```
mount -o remount,rw /
Expand All @@ -264,7 +264,7 @@ mount -o remount,rw /proc
3.1 To reset an actual password is now simple as typing :
`passwd admin`

![image.png](https://github.com/Azure/SONiC/blob/master/images/PW-5.png)
![image.png](https://github.com/sonic-net/SONiC/blob/master/images/PW-5.png)

```
sync
Expand All @@ -279,13 +279,13 @@ sudo reboot -f

SONiC is managing configuration in a single source of truth - a redisDB instance that we refer as ConfigDB. Applications subscribe to ConfigDB and generate their running configuration correspondingly.

Details about ConfigDB and schema design, please find it [here](https://github.com/Azure/SONiC/wiki/Configuration)
Details about ConfigDB and schema design, please find it [here](https://github.com/sonic-net/SONiC/wiki/Configuration)

Before Sep 2017, we were using an XML file named minigraph.xml to configure SONiC devices. For historical documentation, please refer to [Configuration with Minigraph](https://github.com/Azure/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))
Before Sep 2017, we were using an XML file named minigraph.xml to configure SONiC devices. For historical documentation, please refer to [Configuration with Minigraph](https://github.com/sonic-net/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))

SONiC includes commands that allow user to show platform, transceivers, L2, IP, BGP status, etc.

- [Command Reference](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md)
- [Command Reference](https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md)

Note that all the configuration commands need root privileges to execute them and the commands are case-sensitive.
Show commands can be executed by all users without the root privileges.
Expand All @@ -305,7 +305,7 @@ SONiC does not provide a CLI to configure the static IP for the management inter
```
Note that SONiC does not support management VRF and hence it is not possible to differentiate data traffic and management traffic. Work is in progress to support the mgmtVRF in Aug2019 release.

2) use config_db.json and configure the MGMT_INTERFACE key with the appropriate values. Refer [here](https://github.com/Azure/SONiC/wiki/Configuration#Management-Interface)
2) use config_db.json and configure the MGMT_INTERFACE key with the appropriate values. Refer [here](https://github.com/sonic-net/SONiC/wiki/Configuration#Management-Interface)


Add the following example configuration in a file (ex: mgmt_ip.json) and load it as follows.
Expand All @@ -331,7 +331,7 @@ Note that SONiC does not support management VRF and hence it is not possible to
After removing the key, users can load the new configuration using "config load mgmt_ip.json" command and then do "systemctl restart interfaces-config" to make it effective. Users shall verify the configured management interface IP address value using "ifconfig" linux command.


3) use minigraph.xml and configure "ManagementIPInterfaces" tag inside "DpgDesc" tag as given at the [page](https://github.com/Azure/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))
3) use minigraph.xml and configure "ManagementIPInterfaces" tag inside "DpgDesc" tag as given at the [page](https://github.com/sonic-net/SONiC/wiki/Configuration-with-Minigraph-(~Sep-2017))

Once the IP address is configured, the same can be verified using "/sbin/ifconfig eth0" linux command.
Users can SSH login to this management interface IP address from their management network.
Expand Down Expand Up @@ -403,32 +403,32 @@ Go Back To [Beginning of the document](#SONiC-COMMAND-LINE-INTERFACE-GUIDE) or [

## 3.2.2 Check features available in this version

[SONiC roadmap planning](https://github.com/Azure/SONiC/wiki/Sonic-Roadmap-Planning) explains the various features that are added in every software release.
[SONiC roadmap planning](https://github.com/sonic-net/SONiC/wiki/Sonic-Roadmap-Planning) explains the various features that are added in every software release.
TBD: Is this enough? Need information from Xin.


## 3.2.3 Upgrade Or Downgrade Version

SONiC software can be installed in two methods, viz, using "ONIE Installer" or by using "sonic_installer tool".
SONiC software can be installed in two methods, viz, using "ONIE Installer" or by using "sonic-installer tool".
"ONIE Installer" shall be used as explained in the [QuickStartGuide](#Quick-Start-Guide)
"sonic_installer" shall be used as given below.
"sonic-installer" shall be used as given below.


### 3.2.3.1 SONiC Installer
This is a command line tool available as part of the SONiC software; If the device is already running the SONiC software, this tool can be used to install an alternate image in the partition.
This tool has facility to install an alternate image, list the available images and to set the next reboot image.

**sonic_installer install**
**sonic-installer install**

This command is used to install a new image on the alternate image partition. This command takes a path to an installable SONiC image or URL and installs the image.

- Usage:
sonic_installer install <path>
sonic-installer install <path>


- Example:
```
admin@sonic:~$ sonic_installer install https://sonic-jenkins.westus.cloudapp.azure.com/job/xxxx/job/buildimage-xxxx-all/xxx/artifact/target/sonic-xxxx.bin
admin@sonic:~$ sonic-installer install https://sonic-jenkins.westus.cloudapp.azure.com/job/xxxx/job/buildimage-xxxx-all/xxx/artifact/target/sonic-xxxx.bin
New image will be installed, continue? [y/N]: y
Downloading image...
...100%, 480 MB, 3357 KB/s, 146 seconds passed
Expand Down Expand Up @@ -460,57 +460,57 @@ This command is used to install a new image on the alternate image partition. T
Done
```

**sonic_installer list**
**sonic-installer list**

This command displays information about currently installed images. It displays a list of installed images, currently running image and image set to be loaded in next reboot.

- Usage:
sonic_installer list
sonic-installer list

- Example:
```
admin@sonic:~$ sonic_installer list
admin@sonic:~$ sonic-installer list
Current: SONiC-OS-HEAD.XXXX
Next: SONiC-OS-HEAD.XXXX
Available:
SONiC-OS-HEAD.XXXX
SONiC-OS-HEAD.YYYY
```

**sonic_installer set_default**
**sonic-installer set_default**

This command is be used to change the image which can be loaded by default in all the subsequent reboots.

- Usage:
sonic_installer set_default <image_name>
sonic-installer set_default <image_name>

- Example:
```
admin@sonic:~$ sonic_installer set_default SONiC-OS-HEAD.XXXX
admin@sonic:~$ sonic-installer set_default SONiC-OS-HEAD.XXXX
```

**sonic_installer set_next_boot**
**sonic-installer set_next_boot**

This command is used to change the image that can be loaded in the *next* reboot only. Note that it will fallback to current image in all other subsequent reboots after the next reboot.

- Usage:
sonic_installer set_next_boot <image_name>
sonic-installer set_next_boot <image_name>

- Example:
```
admin@sonic:~$ sonic_installer set_next_boot SONiC-OS-HEAD.XXXX
admin@sonic:~$ sonic-installer set_next_boot SONiC-OS-HEAD.XXXX
```

**sonic_installer remove**
**sonic-installer remove**

This command is used to remove the unused SONiC image from the disk. Note that it's *not* allowed to remove currently running image.

- Usage:
sonic_installer remove <image_name>
sonic-installer remove <image_name>

- Example:
```
admin@sonic:~$ sonic_installer remove SONiC-OS-HEAD.YYYY
admin@sonic:~$ sonic-installer remove SONiC-OS-HEAD.YYYY
Image will be removed, continue? [y/N]: y
Updating GRUB...
Done
Expand Down Expand Up @@ -579,11 +579,11 @@ Basic cable connectivity shall be verified by configuring the IP address for the

| # | Module | CLI Link | ConfigDB Link | Remarks |
| --- | --- | --- | --- | --- |
| 1 | Interface |[Interface CLI](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md#Interface-Configuration-And-Show-Commands) | [Interface ConfigDB](Configuration.md)| To view the details about the interface |
| 2 | BGP |[BGP CLI](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md#BGP-Configuration-And-Show-Commands) | [BGP ConfigDB](Configuration.md)| To view the details about the BGP |
| 3 | ACL |[ACL CLI](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md#ACL-Configuration-And-Show) | [ACL ConfigDB](Configuration.md)| To view the details about the ACL |
| 1 | Interface |[Interface CLI](https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md#Interface-Configuration-And-Show-Commands) | [Interface ConfigDB](Configuration.md)| To view the details about the interface |
| 2 | BGP |[BGP CLI](https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md#BGP-Configuration-And-Show-Commands) | [BGP ConfigDB](Configuration.md)| To view the details about the BGP |
| 3 | ACL |[ACL CLI](https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md#ACL-Configuration-And-Show) | [ACL ConfigDB](Configuration.md)| To view the details about the ACL |
| 4 | COPP |COPP CLI Not Available | [COPP ConfigDB](Configuration.md)| To view the details about the COPP |
| 5 | Mirroring |[Mirroring CLI](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md#mirroring-configuration-and-show) | [Mirroring ConfigDB](Configuration.md)| To view the details about the Mirroring |
| 5 | Mirroring |[Mirroring CLI](https://github.com/sonic-net/sonic-utilities/blob/master/doc/Command-Reference.md#mirroring-configuration-and-show) | [Mirroring ConfigDB](Configuration.md)| To view the details about the Mirroring |



Expand Down
Loading

0 comments on commit 48a2c4f

Please sign in to comment.