projects / mirror_frr.git / blame
| Commit | Line | Data |
|---|---|---|
| d92f5fd8 RZ |
1 | .. _grpc: |
| 2 | ||
| 3 | *************** | |
| 4 | Northbound gRPC | |
| 5 | *************** | |
| 6 | ||
| 7 | .. program:: configure | |
| 8 | ||
| 9 | *gRPC* provides a combined front end to all FRR daemons using the YANG | |
| 10 | northbound. It is currently disabled by default due its experimental | |
| 11 | stage, but it can be enabled with :option:`--enable-grpc` option in the | |
| 12 | configure script. | |
| 13 | ||
| 14 | ||
| 15 | .. _grpc-features: | |
| 16 | ||
| 17 | Northbound gRPC Features | |
| 18 | ======================== | |
| 19 | ||
| 20 | * Get/set configuration using JSON/XML/XPath encondings. | |
| 21 | * Execute YANG RPC calls. | |
| 22 | * Lock/unlock configuration. | |
| 23 | * Create/edit/load/update/commit candidate configuration. | |
| 24 | * List/get transactions. | |
| 25 | ||
| 26 | ||
| 27 | .. note:: | |
| 28 | ||
| 29 | There is currently no support for YANG notifications. | |
| 30 | ||
| 31 | ||
| 32 | .. note:: | |
| 33 | ||
| 34 | You can find more information on how to code programs to interact | |
| 35 | with FRR by reading the gRPC Programming Language Bindings section | |
| 36 | in the `developer's documentation | |
| 37 | <http://docs.frrouting.org/projects/dev-guide/en/latest/grpc.html>`_. | |
| 38 | ||
| 39 | ||
| 40 | .. _grpc-config: | |
| 41 | ||
| 42 | Daemon gRPC Configuration | |
| 43 | ========================= | |
| 44 | ||
| 45 | The *gRPC* module accepts the following run time option: | |
| 46 | ||
| 47 | - ``port``: the port to listen to (defaults to ``50051``). | |
| 48 | ||
| 49 | ||
| 50 | .. note:: | |
| 51 | ||
| 52 | At the moment only localhost connections with no SSL/TLS are | |
| 53 | supported. | |
| 54 | ||
| 55 | ||
| 56 | To configure FRR daemons to listen to gRPC you need to append the | |
| 57 | following parameter to the daemon's command line: ``-M grpc`` | |
| 58 | (optionally ``-M grpc:PORT`` to specify listening port). | |
| 59 | ||
| 60 | To do that in production you need to edit the ``/etc/frr/daemons`` file | |
| 61 | so the daemons get started with the command line argument. Example: | |
| 62 | ||
| 63 | :: | |
| 64 | ||
| 65 | # other daemons... | |
| 66 | bfdd_options=" --daemon -A 127.0.0.1 -M grpc" |