diff --git a/docs/changelog.md b/docs/changelog.md index 4ceed49d9..e5ad29a0e 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -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`. diff --git a/docs/user_guide/api/api_intro.md b/docs/user_guide/api/api_intro.md index 2870cc063..01d821b20 100644 --- a/docs/user_guide/api/api_intro.md +++ b/docs/user_guide/api/api_intro.md @@ -51,3 +51,5 @@ api-server: * [Configuration](./configuration.md) * [Targets](./targets.md) + +* [Cluster](./cluster.md) diff --git a/mkdocs.yml b/mkdocs.yml index 277714b26..3ceb701a4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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 @@ -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 @@ -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: >-