Skip to content
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

build: protobuf is required so update building docs #15071

Merged
merged 1 commit into from
Jan 2, 2024
+42 −49
Merged

build: protobuf is required so update building docs #15071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions configure.ac
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1953,6 +1953,10 @@ AC_SUBST([SNMP_CFLAGS])
dnl ---------------
dnl libyang
dnl ---------------
PKG_CHECK_MODULES([LIBYANG], [libyang >= 2.1.128], , [
AC_MSG_WARN([Recommended libyang version is >= 2.1.128.])
])

PKG_CHECK_MODULES([LIBYANG], [libyang >= 2.0.0], , [
AC_MSG_ERROR([libyang (>= 2.0.0) was not found on your system.])
])
Expand Down
8 changes: 1 addition & 7 deletions doc/developer/building-frr-for-archlinux.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,12 @@ Installing Dependencies
git autoconf automake libtool make cmake pcre readline texinfo \
pkg-config pam json-c bison flex python-pytest \
c-ares python python2-ipaddress python-sphinx \
net-snmp perl libcap libelf libunwind
net-snmp perl libcap libelf libunwind protobuf-c
.. include:: building-libunwind-note.rst

.. include:: building-libyang.rst

Protobuf
^^^^^^^^

.. code-block:: console
sudo pacman -S protobuf-c

ZeroMQ
^^^^^^
Expand Down
7 changes: 1 addition & 6 deletions doc/developer/building-frr-for-ubuntu1404.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,11 @@ Installing Dependencies
git autoconf automake libtool make libreadline-dev texinfo \
pkg-config libpam0g-dev libjson-c-dev bison flex python3-pytest \
libc-ares-dev python3-dev python3-sphinx install-info build-essential \
protobuf-c-compiler libprotobuf-c-dev \
libsnmp-dev perl libcap-dev libelf-dev
.. include:: building-libyang.rst

Protobuf
^^^^^^^^

.. code-block:: console
sudo apt-get install protobuf-c-compiler libprotobuf-c-dev

Building & Installing FRR
-------------------------
Expand Down
6 changes: 0 additions & 6 deletions doc/developer/building-frr-for-ubuntu1604.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,6 @@ Installing Dependencies
.. include:: building-libyang.rst

Protobuf
^^^^^^^^

.. code-block:: console
sudo apt-get install protobuf-c-compiler libprotobuf-c-dev

Building & Installing FRR
-------------------------
Expand Down
7 changes: 1 addition & 6 deletions doc/developer/building-frr-for-ubuntu1804.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,13 @@ Installing Dependencies
pkg-config libpam0g-dev libjson-c-dev bison flex \
libc-ares-dev python3-dev python3-sphinx \
install-info build-essential libsnmp-dev perl libcap-dev \
protobuf-c-compiler libprotobuf-c-dev \
libelf-dev libunwind-dev
.. include:: building-libunwind-note.rst

.. include:: building-libyang.rst

Protobuf
^^^^^^^^

.. code-block:: console
sudo apt-get install protobuf-c-compiler libprotobuf-c-dev

ZeroMQ
^^^^^^
Expand Down
25 changes: 18 additions & 7 deletions doc/developer/building-frr-for-ubuntu2004.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,33 @@ Installing Dependencies
pkg-config libpam0g-dev libjson-c-dev bison flex \
libc-ares-dev python3-dev python3-sphinx \
install-info build-essential libsnmp-dev perl \
protobuf-c-compiler libprotobuf-c-dev \
libcap-dev libelf-dev libunwind-dev
.. include:: building-libunwind-note.rst

Note that Ubuntu 20 no longer installs python 2.x, so it must be
installed explicitly. Ensure that your system has a symlink named
``/usr/bin/python`` pointing at ``/usr/bin/python3``.

.. include:: building-libyang.rst

Protobuf
^^^^^^^^
GRPC
^^^^
If GRPC is enabled using ``--enable-grpc`` the following packages should be
installed.

.. code-block:: console
sudo apt-get install libgrpc++-dev protobuf-compiler-grpc \
Config Rollbacks
^^^^^^^^^^^^^^^^

If config rollbacks are enabled using ``--enable-config-rollbacks``
the sqlite3 developer package also should be installed.

.. code-block:: console
sudo apt-get install protobuf-c-compiler libprotobuf-c-dev
sudo apt install libsqlite3-dev
ZeroMQ
^^^^^^
Expand Down
20 changes: 6 additions & 14 deletions doc/developer/building-frr-for-ubuntu2204.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,27 +16,19 @@ Installing Dependencies
libc-ares-dev python3-dev python3-sphinx \
install-info build-essential libsnmp-dev perl \
libcap-dev libelf-dev libunwind-dev \
protobuf-c-compiler libprotobuf-c-dev \
libyang2 libyang2-dev
.. include:: building-libunwind-note.rst

Note that Ubuntu >= 20 no longer installs python 2.x, so it must be
installed explicitly. Ensure that your system has a symlink named
``/usr/bin/python`` pointing at ``/usr/bin/python3``.

.. code-block:: shell
sudo ln -s /usr/bin/python3 /usr/bin/python
python --version
Protobuf
^^^^^^^^
This is optional
GRPC
^^^^
If GRPC is enabled using ``--enable-grpc`` the following packages should be
installed.

.. code-block:: console
sudo apt-get install protobuf-c-compiler libprotobuf-c-dev
sudo apt-get install libgrpc++-dev protobuf-compiler-grpc \
Config Rollbacks
Expand Down
5 changes: 3 additions & 2 deletions doc/developer/building-libyang.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ DEB packages are available as CI artifacts `here

.. warning::

``libyang`` version 2.0.0 or newer is required to build FRR.
``libyang`` version 2.0.0 or newer is required to build FRR, version 2.1.128
or newer is recommended.

.. note::

Expand All @@ -39,7 +40,7 @@ DEB packages are available as CI artifacts `here
git clone https://github.com/CESNET/libyang.git
cd libyang
git checkout v2.0.0
git checkout v2.1.128
mkdir build; cd build
cmake -D CMAKE_INSTALL_PREFIX:PATH=/usr \
-D CMAKE_BUILD_TYPE:String="Release" ..
Expand Down
9 changes: 8 additions & 1 deletion docker/ubuntu-ci/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,12 @@ RUN apt update && apt upgrade -y && \
cmake \
libpcre2-dev \
&& \
# GRPC extra build requirements
apt-get install -y \
libgrpc-dev \
libgrpc++-dev \
protobuf-compiler-grpc \
&& \
# Runtime/triage/testing requirements
apt-get install -y \
curl \
Expand Down Expand Up @@ -91,7 +97,7 @@ USER frr:frr
RUN cd && pwd && ls -al && \
git clone https://github.com/CESNET/libyang.git && \
cd libyang && \
git checkout v2.1.80 && \
git checkout v2.1.128 && \
mkdir build; cd build && \
cmake -DCMAKE_INSTALL_PREFIX:PATH=/usr \
-DCMAKE_BUILD_TYPE:String="Release" .. && \
Expand All @@ -112,6 +118,7 @@ RUN cd ~/frr && \
--enable-user=frr \
--enable-group=frr \
--enable-config-rollbacks \
--enable-grpc \
--enable-vty-group=frrvty \
--enable-snmp=agentx \
--enable-scripting \
Expand Down
Loading