You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ For example:
34
34
* Use issues to keep track of what is going on
35
35
36
36
##Expectations for pull requests
37
-
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).
37
+
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).
38
38
39
39
## Commiting new test
40
40
When commiting a new feature with a new test, please complete a [test plan from the template](doc/SONiC%20Test%20Plan%20Template.md)
Copy file name to clipboardexpand all lines: doc/SONiC-User-Manual.md
+22-22
Original file line number
Diff line number
Diff line change
@@ -43,15 +43,15 @@ Table of Contents
43
43
# Introduction
44
44
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.
45
45
46
-
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.
46
+
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.
47
47
48
-
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.
48
+
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.
49
49
Users shall use the default username/password "admin/YourPaSsWoRd" to login to the device through the console port.
50
50
51
51
After logging into the device, SONiC software can be configured in following three methods.
52
-
1)[Command Line Interface](https://github.com/Azure/sonic-utilities/blob/master/doc/Command-Reference.md)
Users can use all of the above methods or choose either one method to configure and to view the status of the device.
57
57
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.
@@ -78,9 +78,9 @@ This guide details the steps to install a SONiC image on your supported switch.
78
78
79
79
## 1.1 Download Image
80
80
81
-
We have one SONiC Image per ASIC vendor. You can download SONiC Image [here](https://github.com/Azure/SONiC/wiki/Supported-Devices-and-Platforms)
81
+
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)
82
82
83
-
You can also build SONiC from source and the instructions can be found [here](https://github.com/Azure/sonic-buildimage).
83
+
You can also build SONiC from source and the instructions can be found [here](https://github.com/sonic-net/sonic-buildimage).
84
84
85
85
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.
86
86
In case if the device is already preloaded with SONiC image, the device can be booted without the installation process.
@@ -241,19 +241,19 @@ This TSG gives the instruction of how to reset a SONiC switch password.
241
241
1. Edit Grub boot menu options
242
242
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.
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.
281
281
282
-
Details about ConfigDB and schema design, please find it [here](https://github.com/Azure/SONiC/wiki/Configuration)
282
+
Details about ConfigDB and schema design, please find it [here](https://github.com/sonic-net/SONiC/wiki/Configuration)
283
283
284
-
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))
284
+
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))
285
285
286
286
SONiC includes commands that allow user to show platform, transceivers, L2, IP, BGP status, etc.
Note that all the configuration commands need root privileges to execute them and the commands are case-sensitive.
291
291
Show commands can be executed by all users without the root privileges.
@@ -305,7 +305,7 @@ SONiC does not provide a CLI to configure the static IP for the management inter
305
305
```
306
306
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.
307
307
308
-
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)
308
+
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)
309
309
310
310
311
311
Add the following example configuration in a file (ex: mgmt_ip.json) and load it as follows.
@@ -331,7 +331,7 @@ Note that SONiC does not support management VRF and hence it is not possible to
331
331
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.
332
332
333
333
334
-
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))
334
+
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))
335
335
336
336
Once the IP address is configured, the same can be verified using "/sbin/ifconfig eth0" linux command.
337
337
Users can SSH login to this management interface IP address from their management network.
@@ -403,7 +403,7 @@ Go Back To [Beginning of the document](#SONiC-COMMAND-LINE-INTERFACE-GUIDE) or [
403
403
404
404
## 3.2.2 Check features available in this version
405
405
406
-
[SONiC roadmap planning](https://github.com/Azure/SONiC/wiki/Sonic-Roadmap-Planning) explains the various features that are added in every software release.
406
+
[SONiC roadmap planning](https://github.com/sonic-net/SONiC/wiki/Sonic-Roadmap-Planning) explains the various features that are added in every software release.
407
407
TBD: Is this enough? Need information from Xin.
408
408
409
409
@@ -579,11 +579,11 @@ Basic cable connectivity shall be verified by configuring the IP address for the
579
579
580
580
| # | Module | CLI Link | ConfigDB Link | Remarks |
581
581
| --- | --- | --- | --- | --- |
582
-
| 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 |
583
-
| 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 |
584
-
| 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 |
582
+
| 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 |
583
+
| 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 |
584
+
| 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 |
585
585
| 4 | COPP |COPP CLI Not Available | [COPP ConfigDB](Configuration.md)| To view the details about the COPP |
586
-
| 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 |
586
+
| 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 |
0 commit comments