Skip to content

[doc]: Update README.md #1122

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
merged 7 commits into from
Oct 4, 2022
Merged

[doc]: Update README.md #1122

Changes from 3 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9a6e6bb
Add sonic-sairedis pipelines build URLs
mdanish-kh Sep 8, 2022
715ce00
Update outdated URLs
mdanish-kh Sep 8, 2022
8404daf
Minor description fix
mdanish-kh Sep 8, 2022
2310e5a
Update Azure URLs to sonic-net
mdanish-kh Sep 18, 2022
eb97bd2
Trigger Build
mdanish-kh Oct 3, 2022
7b2ca54
Fix whitespace
mdanish-kh Oct 3, 2022
b6fdbf8
Add CLA information
mdanish-kh Oct 4, 2022
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
25 changes: 17 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
*static analysis:*

[![Total alerts](https://img.shields.io/lgtm/alerts/g/Azure/sonic-sairedis.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Azure/sonic-sairedis/alerts/)
[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/Azure/sonic-sairedis.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Azure/sonic-sairedis/context:cpp)

VS[![Build Status](https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/sonic-sairedis-build/badge/icon)](https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/sonic-sairedis-build/)
*sairedis builds:*

[![master build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=master&label=master)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=master)
[![202205 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202205&label=202205)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202205)
[![202111 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202111&label=202111)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202111)
[![202106 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202106&label=202106)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202106)
[![202012 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=202012&label=202012)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=202012)
[![201911 build](https://dev.azure.com/mssonic/build/_apis/build/status/Azure.sonic-sairedis?branchName=201911&label=201911)](https://dev.azure.com/mssonic/build/_build/latest?definitionId=12&branchName=201911)

# SONiC - SAI Redis - sairedis

## Description
The SAI Redis provides a SAI redis service that built on top of redis database. It contains two major components, 1) a SAI library
that puts SAI objects into the redis database, 2) a syncd that takes the SAI objects and puts them into the ASIC.
The SAI Redis provides a SAI redis service built on top of redis database. It contains two major components:
1) `SAI library` that puts SAI objects into the redis database.
2) `syncd` that takes the SAI objects and puts them into the ASIC.

## Getting Started

Expand Down Expand Up @@ -38,7 +48,7 @@ For your convenience, you can install prepared packages on Debian Jessie:

#### Install from Source

Checkout the source: `git clone https://github.com/Azure/sonic-sairedis.git` and install it yourself.
Checkout the source: `git clone https://github.com/sonic-net/sonic-sairedis.git` and install it yourself.

You will also need SAI submodule: `git submodule update --init --recursive`

Expand All @@ -51,7 +61,7 @@ Install prerequisite packages:

sudo apt-get install libswsscommon libswsscommon-dev libhiredis-dev libzmq3-dev libpython-dev

Note: libswsscommon-dev requires libnl-3-200-dev, libnl-route-3-200-dev and libnl-nf-3-200-dev version >= 3.5.0. If these are not available via apt repositories, you can get them from the latest sonic-buildimage Jenkins build: https://sonic-jenkins.westus2.cloudapp.azure.com/job/vs/job/buildimage-vs-all/lastSuccessfulBuild/artifact/target/debs/buster/.
> Note: libswsscommon-dev requires libnl-3-200-dev, libnl-route-3-200-dev and libnl-nf-3-200-dev version >= 3.5.0. If these are not available via apt repositories, you can get them from the latest [sonic-buildimage build](https://sonic-build.azurewebsites.net/api/sonic/artifacts?branchName=master&platform=vs&format=zip&target=target%2Fdebs%2Fbuster).

Install SAI dependencies:

Expand All @@ -76,13 +86,13 @@ If you do not have libsai, you can build a debian package using:
## Need Help?

For general questions, setup help, or troubleshooting:
- [sonicproject on Google Groups](https://groups.google.com/d/forum/sonicproject)
- [sonicproject on Google Groups](https://groups.google.com/g/sonicproject)

For bug reports or feature requests, please open an Issue.

## Contribution guide

See the [contributors guide](https://github.com/Azure/SONiC/blob/gh-pages/CONTRIBUTING.md) for information about how to contribute.
See the [contributors guide](https://github.com/sonic-net/SONiC/wiki/Becoming-a-contributor) for information about how to contribute.

### GitHub Workflow

Expand Down Expand Up @@ -116,4 +126,3 @@ For example:
* Push your changes to your private fork and do "pull-request" to this repository
* Use a pull request to do code review
* Use issues to keep track of what is going on