Skip to content

Commit a624faf

Browse files
authored
updates for ndk 0.5.0, bond 0.3.0 and ndk and py packages (#198)
1 parent cbd3f73 commit a624faf

File tree

6 files changed

+38
-2
lines changed

6 files changed

+38
-2
lines changed

docs/ndk/guide/agent.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,10 @@ application-name:
145145
# 'imm' - runs on the imm
146146
# 'cpm' - runs on the cpm (default)
147147
launch-restrictions: ['hw:cpm', 'hw:chassis:imm']
148+
# [Optional] The list of linux capabilities to grant to the application.
149+
# The capabilities are specified as a list of capability keys (without the 'CAP_' prefix).
150+
capability-bounding-set:
151+
- NET_ADMIN
148152
yang-modules:
149153
# [Mandatory] The names of the YANG modules to load. This is usually the file-name without '.yang'
150154
names: [module-name, other-module-name]

docs/ndk/guide/architecture.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Leveraging gRPC and protobufs provides some substantial benefits for NDK users:
4444

4545
NDK is composed of a collection of gRPC services, each of which enables custom applications to interact with a particular subsystem on an SR Linux NOS, delivering a high level of integration and extensibility.
4646

47+
/// note
48+
Starting with SR Linux 25.3.1, the NDK service is disabled by default. Users should enable it by configuring the `system ndk-server admin-state enable` leaf in the system configuration.
49+
///
50+
4751
With this architecture, NDK applications act as gRPC clients that execute remote procedure calls (RPC) on a system that runs a gRPC server.
4852

4953
On SR Linux, `ndk_mgr` is the application that runs the NDK gRPC server. Fig 3. shows how custom agents interact via gRPC with NDK, and NDK facilitates communication between custom apps and the rest of the system via IDB's pub/sub interface.

docs/ndk/guide/dev/go/with-bond/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ cd ndk-greeter-go
2626

2727
/// note
2828
attrs: {class: inline end}
29-
[Containerlab v0.57.2](https://containerlab.dev/install) version and SR Linux 24.3.3 are used in this tutorial. Users are advised to use these version to have the same outputs as in this tutorial.
29+
[Containerlab v0.68.0](https://containerlab.dev/install) version, `srl-labs/bond` v0.3.0 and SR Linux 25.3 are used in this tutorial. Users are advised to use these version to have the same outputs as in this tutorial.
3030

3131
Newer versions of Containerlab and SR Linux should work as well, but the outputs might be slightly different.
3232
///

docs/ndk/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Browse our [Apps Catalog](apps/index.md) with a growing list of NDK apps that No
3636
A list of links to various NDK artifacts:
3737

3838
* NDK Proto files: [`nokia/srlinux-ndk-protobufs`](https://github.com/nokia/srlinux-ndk-protobufs)
39-
* [Generated NDK Service documentation](https://rawcdn.githack.com/nokia/srlinux-ndk-protobufs/v0.2.0/doc/index.html)
39+
* [Generated NDK Service documentation](https://ndk.srlinux.dev)
4040
* Go bindings for NDK: [`nokia/srlinux-ndk-go`](https://github.com/nokia/srlinux-ndk-go)
4141
* Python bindings for NDK: [`nokia/srlinux-ndk-py`](https://github.com/nokia/srlinux-ndk-py)
4242

docs/ndk/releases/0.5.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
version: v0.5.0
3+
prev_version: v0.4.0
4+
---
5+
# NDK -{{version}}- Release Notes
6+
7+
* Documentation - [ndk.srlinux.dev](https://ndk.srlinux.dev/doc/sdk?version=-{{version}}-)
8+
* Protobuf definitions - [github.com/nokia/srlinux-ndk-protobufs](https://github.com/nokia/srlinux-ndk-protobufs/tree/-{{version}}-)
9+
* Language bindings - [Go](https://github.com/nokia/srlinux-ndk-go/tree/-{{version}}-), [Python](https://github.com/nokia/srlinux-ndk-py/tree/-{{version}}-).
10+
* Introduced with SR Linux `v25.3.1`.
11+
* Diff with the previous release: [`-{{prev_version}}-...-{{version}}-`](https://github.com/nokia/srlinux-ndk-protobufs/compare/-{{prev_version}}-...-{{version}}-)
12+
13+
## NDK Admin state
14+
15+
Release 25.3.1 changes the default enablement state of the NDK server and introduces the `system ndk-server admin-state` leaf to control the server's status. From Release 25.3.1 onwards, the NDK server is disabled by default.
16+
17+
If a system that has NDK applications is upgraded from a previous release, the NDK server is kept enabled to ensure seamless operation.
18+
19+
## Defining Linux capabilities for the NDK agents
20+
21+
From Release 25.3.1 onwards, a user may specify the Linux capability set that will be granted to the NDK application. When an app needs to perform privileged operations, it may set the capability set instead of running with `sudo` privileges.
22+
23+
A user may specify the capability bounding set as a list of capability keys (without the `CAP_` prefix) as a list under the `capability-bounding-set` key in the [application YAML file](../guide/agent.md#application-manager-and-application-configuration-file).
24+
25+
## NDK proto messages harmonization
26+
27+
Release 25.3.1 aligns the majority of the NDK proto messages and fields in them to the protobuf style guide as outlined in the protobuf specification. This alignment may require NDK developers to rename the methods and field accessors accordingly.

docs/ndk/releases/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,6 @@ The following table shows the mapping between SR Linux and NDK releases:
1919
| [v0.2.0](0.2.md) | 23.10.1 | |
2020
| [v0.3.0](0.3.md) | 24.3.1 | |
2121
| [v0.4.0](0.4.md) | 24.10.1 | |
22+
| [v0.5.0](0.5.md) | 25.3.1 | Breaking changes! |
2223

2324
[^1]: SR Linux release where NDK changes were introduced.

0 commit comments

Comments
 (0)