Skip to content

Commit

Permalink
fix index.md and proto file for linter
Browse files Browse the repository at this point in the history
  • Loading branch information
brianneville committed Dec 15, 2023
1 parent cf94995 commit 51d39f2
Show file tree
Hide file tree
Showing 3 changed files with 108 additions and 109 deletions.
26 changes: 13 additions & 13 deletions pathz/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,18 +95,18 @@ sent, the proposed configuration is rolled back automatically.

When a gNMI client connects and begins a subscription, the active
pathz policy on the system is applied to that subscription for the entire
duration of that subscription.
duration of that subscription. <br>
If a new pathz policy is rotated and finalized, ongoing subscriptions will not be
affected and will continue to be subscribed with whatever authorization
they had upon beginning the subscription.
they had upon beginning the subscription. <br>
These clients will not be aware that the pathz policy has been updated
until they disconnect and reconnect, at which point the new policy will
be applied to their subscription, and the subset of YANG leafs which they are
permitted to read may change.

While rotating a pathz policy, network operators may wish to know which of
the ongoing subscriptions would be affected if the rotation were finalized and
the gNMI subscriber were to then disconnect and reconnect.
the gNMI subscriber were to then disconnect and reconnect. <br>
For this purpose, the `pathz.UploadResponse` contains information about the
current ongoing subscriptions, as well as whether or not these subscriptions
would be impacted by the pathz policy which was uploaded in the
Expand All @@ -119,19 +119,19 @@ rule for that user and path (or any subpaths underneath that path) would change
the rotation gets finalized.

For example, consider a system with the following installed rules:
```
```text
/a/b/[k0=*]/c -> user Alice, action PERMIT
/a/b/[k0=*]/c -> user Bob, action PERMIT
/a/b/[k0=*]/c -> user Charlie, action PERMIT
```
Then:
user Alice subscribes to `/a`
user Bob subscribes to `/a`
user Charlie subscribes to `/a/b/[k0=X]/c/d`
Then: <br>
user Alice subscribes to `/a` <br>
user Bob subscribes to `/a` <br>
user Charlie subscribes to `/a/b/[k0=X]/c/d` <br>

Next, a pathz Rotate stream begins, and a `pathz.UploadRequest` is sent containing
the following policy:
```
```text
/a/b/[k0=*]/c -> user Alice, action PERMIT READ
/a/b/[k0=*]/c -> user Bob, action PERMIT READ
/a/b/[k0=Y]/c -> user Bob, action DENY READ
Expand All @@ -140,15 +140,15 @@ the following policy:
```

The uploadResponse returned specifies that for this incoming policy:
1. Alice's subscription to `/a` is not impacted.
2. Bob's subscription to `/a` is impacted.
1. Alice's subscription to `/a` is not impacted.
2. Bob's subscription to `/a` is impacted.
3. Charlie's subscription `/a/b/[k0=X]/c/d` is not impacted

- Alice's subscription is not impacted as the best-matching rule for `/a`
and every path beneath `/a` remains the same.
and every path beneath `/a` remains the same.
- Bob's subscription is impacted as currently the best-matching rule
for the subpath `/a/b/[k0=Y]/c` is PERMIT READ, while under this
incoming policy it is DENY READ.
incoming policy it is DENY READ. <br>
If this rotation is finalized, his view of the YANG tree would change
when he disconnects/reconnects.
- Charlie's subscription is not impacted as the best-matching rule for his path
Expand Down
Loading

0 comments on commit 51d39f2

Please sign in to comment.