Skip to content
This repository has been archived by the owner on Oct 28, 2022. It is now read-only.

Commit

Permalink
Merge pull request #522 from karimra/0.21.0-changelog
Browse files Browse the repository at this point in the history
update docs and add 0.21.0 changelog
  • Loading branch information
karimra authored Jan 23, 2022
2 parents ff96cf5 + 97898e2 commit 98514a1
Show file tree
Hide file tree
Showing 3 changed files with 75 additions and 22 deletions.
46 changes: 46 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,51 @@
## Changelog

### v0.21.0 - January 23rd 2021

- [Generate Cmd](cmd/generate/generate_path.md):

Add YANG module namespace to generated paths.

- Outputs:

Outputs [File](user_guide/outputs/file_output.md), [NATS](user_guide/outputs/nats_output.md) and [Kafka](user_guide/outputs/kafka_output.md) now support a `msg-template` field to customize the written messages using Go templates.

- API:

Add [Cluster API](user_guide/api/cluster.md) endpoints.

- Actions:

Add [Template](user_guide/actions/actions.md#template-action) action.

Add Subscribe ONCE RPC to [gNMI](user_guide/actions/actions.md#gnmi-action) action.

Allow [gNMI](user_guide/actions/actions.md#gnmi-action) action on multiple targets.

Add [Script](user_guide/actions/actions.md#script-action) action.

- [Get Cmd](cmd/get.md):

Implement Format `event` for GetResponse messages.

Add the ability to execute processors with Get command flag [`--processor`](cmd/get.md#processor) on GetResponse messages.

- [Target Discovery](user_guide/target_discovery/discovery_intro.md):

Add the ability to run [actions](user_guide/actions/actions.md) on target discovery or deletion.

- [Set Cmd](cmd/set.md):

Add [`--dry-run`](cmd/set.md#dry-run) flag which runs the set request templates and prints their output without sending the SetRequest to the targets.

- TLS:

Add pre-master key logging for TLS connections using the flag [`--log-tls-secret`](global_flags.md#log-tls-secret). The key can be used to decrypt encrypted gNMI messages using wireshark.

- Target:

Add `target.Stop()` method to gracefully close the target underlying gRPC connection.

### v0.20.0 - October 19th 2021

- Add [gomplate](https://docs.gomplate.ca) template functions to all templates rendered by `gnmic`.
Expand Down
2 changes: 2 additions & 0 deletions docs/user_guide/api/api_intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,3 +51,5 @@ api-server:
* [Configuration](./configuration.md)
* [Targets](./targets.md)
* [Cluster](./cluster.md)
49 changes: 27 additions & 22 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
site_name: gNMIc
nav:
- Home: index.md

- Getting started:
- Installation: install.md
- Basic usage: basic_usage.md
- Global flags: global_flags.md
- Releases:
- Changelog: changelog.md

- User guide: user_guide/configuration_intro.md
- Command reference: cmd/capabilities.md
- Deployment examples: deployments/deployments_intro.md
- Changelog: changelog.md

- User guide:
- Configuration:
- Introduction: user_guide/configuration_intro.md
- Flags: user_guide/configuration_flags.md
- Flags:
- user_guide/configuration_flags.md
- global_flags.md
- Environment variables: user_guide/configuration_env.md
- File configuration: user_guide/configuration_file.md

Expand Down Expand Up @@ -76,6 +80,21 @@ nav:
- Targets: user_guide/api/targets.md
- Cluster: user_guide/api/cluster.md

- Command reference:
- Capabilities: cmd/capabilities.md
- Get: cmd/get.md
- Set: cmd/set.md
- GetSet: cmd/getset.md
- Subscribe: cmd/subscribe.md
- Diff: cmd/diff.md
- Listen: cmd/listen.md
- Path: cmd/path.md
- Prompt: cmd/prompt.md
- Generate:
- Generate: 'cmd/generate.md'
- Generate Path: cmd/generate/generate_path.md
- Generate Set-Request: cmd/generate/generate_set_request.md

- Deployment examples:
- Deployments: deployments/deployments_intro.md

Expand Down Expand Up @@ -118,23 +137,9 @@ nav:
- Docker Compose: deployments/pipelines/docker-compose/gnmic_cluster_nats_prometheus.md
- Forked pipeline:
- Docker Compose: deployments/pipelines/docker-compose/forked_pipeline.md

- Command reference:
- Capabilities: cmd/capabilities.md
- Get: cmd/get.md
- Set: cmd/set.md
- GetSet: cmd/getset.md
- Subscribe: cmd/subscribe.md
- Diff: cmd/diff.md
- Listen: cmd/listen.md
- Path: cmd/path.md
- Prompt: cmd/prompt.md
- Generate:
- Generate: 'cmd/generate.md'
- Generate Path: cmd/generate/generate_path.md
- Generate Set-Request: cmd/generate/generate_set_request.md

- Blog: blog/index.md

- Changelog: changelog.md
# - Blog: blog/index.md

site_author: Karim Radhouani
site_description: >-
Expand Down

0 comments on commit 98514a1

Please sign in to comment.