diff options
Diffstat (limited to 'doc/developer')
| -rw-r--r-- | doc/developer/building-docker.rst | 21 | ||||
| -rw-r--r-- | doc/developer/draft-zebra-00.ms | 8 | ||||
| -rw-r--r-- | doc/developer/logging.rst | 59 |
3 files changed, 77 insertions, 11 deletions
diff --git a/doc/developer/building-docker.rst b/doc/developer/building-docker.rst index 35b51cd9c0..4cf356049e 100644 --- a/doc/developer/building-docker.rst +++ b/doc/developer/building-docker.rst @@ -109,6 +109,27 @@ No script, multi-arch (ex. amd64, arm64):: +Building ubi 8 Image +----------------------- + +Script:: + + ./docker/ubi-8/build.sh + +Script with params, an example could be this (all that info will go to docker label) :: + + ./docker/ubi-8/build.sh frr:ubi-8-my-test "$(git rev-parse --short=10 HEAD)" my_release my_name my_vendor + +No script:: + + docker build -f docker/ubi-8/Dockerfile . + +No script, multi-arch (ex. amd64, arm64):: + + docker buildx build --platform linux/amd64,linux/arm64 -f docker/ubi-8/Dockerfile -t frr-ubi-8:latest . + + + Building Ubuntu 18.04 Image --------------------------- diff --git a/doc/developer/draft-zebra-00.ms b/doc/developer/draft-zebra-00.ms index 25994727a0..b5d6924613 100644 --- a/doc/developer/draft-zebra-00.ms +++ b/doc/developer/draft-zebra-00.ms @@ -179,13 +179,13 @@ Interface information message format. +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Index (1) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Inteface flag (4) | +| Interface flag (4) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Inteface metric (4) | +| Interface metric (4) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Inteface MTU (4) | +| Interface MTU (4) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -| Inteface Address count (4) | +| Interface Address count (4) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ .DE .sp diff --git a/doc/developer/logging.rst b/doc/developer/logging.rst index 7046361204..16d555461d 100644 --- a/doc/developer/logging.rst +++ b/doc/developer/logging.rst @@ -171,7 +171,7 @@ Networking data types :frrfmtout:`(*,1.2.3.4)` - This is *(S,G)* output for use in pimd. (Note prefix_sg is not a prefix + This is *(S,G)* output for use in zebra. (Note prefix_sg is not a prefix "subclass" like the other prefix_* structs.) .. frrfmt:: %pSU (union sockunion *) @@ -205,12 +205,6 @@ Networking data types ``%pNHci``: :frrfmtout:`eth0` — compact interface only -.. frrfmt:: %pBD (struct bgp_dest *) - - :frrfmtout:`fe80::1234/64` - - (only available in bgpd.) - .. frrfmt:: %dPF (int) :frrfmtout:`AF_INET` @@ -361,6 +355,57 @@ FRR library helper formats (The output is aligned to some degree.) +FRR daemon specific formats +^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +The following formats are only available in specific daemons, as the code +implementing them is part of the daemon, not the library. + +zebra +""""" + +.. frrfmt:: %pZN (struct route_node *) + + Print information for a RIB node, including zebra-specific data. + + :frrfmtout:`::/0 src fe80::/64 (MRIB)` (``%pZN``) + + :frrfmtout:`1234` (``%pZNt`` - table number) + +bgpd +"""" + +.. frrfmt:: %pBD (struct bgp_dest *) + + Print prefix for a BGP destination. + + :frrfmtout:`fe80::1234/64` + +.. frrfmt:: %pBP (struct peer *) + + :frrfmtout:`192.168.1.1(leaf1.frrouting.org)` + + Print BGP peer's IP and hostname together. + +pimd/pim6d +"""""""""" + +.. frrfmt:: %pPA (pim_addr *) + + Format IP address according to IP version (pimd vs. pim6d) being compiled. + + :frrfmtout:`fe80::1234` / :frrfmtout:`10.0.0.1` + + :frrfmtout:`*` (``%pPAs`` - replace 0.0.0.0/:: with star) + +.. frrfmt:: %pSG (pim_sgaddr *) + + Format S,G pair according to IP version (pimd vs. pim6d) being compiled. + Braces are included. + + :frrfmtout:`(*,224.0.0.0)` + + General utility formats ^^^^^^^^^^^^^^^^^^^^^^^ |