forked from openconfig/gnmic
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
281 lines (249 loc) · 10.4 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# © 2022 Nokia.
#
# This code is a Contribution to the gNMIc project (“Work”) made under the Google Software Grant and Corporate Contributor License Agreement (“CLA”) and governed by the Apache License 2.0.
# No other rights or licenses in or to any of Nokia’s intellectual property are granted for any other purpose.
# This code is provided on an “as is” basis without any warranties of any kind.
#
# SPDX-License-Identifier: Apache-2.0
site_name: gNMIc
nav:
- Home: index.md
- Getting started:
- Installation: install.md
- Basic usage: basic_usage.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
- global_flags.md
- Environment variables: user_guide/configuration_env.md
- File configuration: user_guide/configuration_file.md
- Targets:
- Configuration: user_guide/targets.md
- Discovery:
- Introduction: user_guide/target_discovery/discovery_intro.md
- File Discovery: user_guide/target_discovery/file_discovery.md
- Consul Discovery: user_guide/target_discovery/consul_discovery.md
- Docker Discovery: user_guide/target_discovery/docker_discovery.md
- HTTP Discovery: user_guide/target_discovery/http_discovery.md
- Subscriptions: user_guide/subscriptions.md
- Prompt mode: user_guide/prompt_suggestions.md
- gNMI Server: user_guide/gnmi_server.md
- Tunnel Server: user_guide/tunnel_server.md
- Inputs:
- Introduction: user_guide/inputs/input_intro.md
- NATS: user_guide/inputs/nats_input.md
- STAN: user_guide/inputs/stan_input.md
- Kafka: user_guide/inputs/kafka_input.md
- Outputs:
- Introduction: user_guide/outputs/output_intro.md
- File: user_guide/outputs/file_output.md
- NATS:
- NATS: user_guide/outputs/nats_output.md
- STAN: user_guide/outputs/stan_output.md
- Jetstream: user_guide/outputs/jetstream_output.md
- Kafka: user_guide/outputs/kafka_output.md
- InfluxDB: user_guide/outputs/influxdb_output.md
- Prometheus:
- Scrape Based (Pull): user_guide/outputs/prometheus_output.md
- Remote Write (Push): user_guide/outputs/prometheus_write_output.md
- gNMI Server: user_guide/outputs/gnmi_output.md
- TCP: user_guide/outputs/tcp_output.md
- UDP: user_guide/outputs/udp_output.md
- Processors:
- Introduction: user_guide/event_processors/intro.md
- Add Tag: user_guide/event_processors/event_add_tag.md
- Allow: user_guide/event_processors/event_allow.md
- Convert: user_guide/event_processors/event_convert.md
- Data Convert: user_guide/event_processors/event_data_convert.md
- Date string: user_guide/event_processors/event_date_string.md
- Delete: user_guide/event_processors/event_delete.md
- Drop: user_guide/event_processors/event_drop.md
- Duration Convert: user_guide/event_processors/event_duration_convert.md
- Extract Tags: user_guide/event_processors/event_extract_tags.md
- Group by: user_guide/event_processors/event_group_by.md
- JQ: user_guide/event_processors/event_jq.md
- Merge: user_guide/event_processors/event_merge.md
- Override TS: user_guide/event_processors/event_override_ts.md
- Strings: user_guide/event_processors/event_strings.md
- To Tag: user_guide/event_processors/event_to_tag.md
- Trigger: user_guide/event_processors/event_trigger.md
- Value Tag: user_guide/event_processors/event_value_tag.md
- Write: user_guide/event_processors/event_write.md
- Actions: user_guide/actions/actions.md
- Caching: user_guide/caching.md
- Clustering: user_guide/HA.md
- REST API:
- Introduction: user_guide/api/api_intro.md
- Configuration: user_guide/api/configuration.md
- Targets: user_guide/api/targets.md
- Cluster: user_guide/api/cluster.md
- Golang Package:
- Introduction: user_guide/golang_package/intro.md
- Target Options: user_guide/golang_package/target_options.md
- gNMI Options: user_guide/golang_package/gnmi_options.md
- Examples:
- Capabilities: user_guide/golang_package/examples/capabilities.md
- Get: user_guide/golang_package/examples/get.md
- Set: user_guide/golang_package/examples/set.md
- Subcribe: user_guide/golang_package/examples/subscribe.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
- gNMIc Single Instance:
- NATS Output:
- Containerlab: deployments/single-instance/containerlab/nats-output.md
- Docker Compose: deployments/single-instance/docker-compose/nats-output.md
- Kafka output:
- Containerlab: deployments/single-instance/containerlab/kafka-output.md
- Docker Compose: deployments/single-instance/docker-compose/kafka-output.md
- InfluxDB output:
- Containerlab: deployments/single-instance/containerlab/influxdb-output.md
- Docker Compose: deployments/single-instance/docker-compose/influxdb-output.md
- Prometheus output:
- Containerlab: deployments/single-instance/containerlab/prometheus-output.md
- Docker Compose: deployments/single-instance/docker-compose/prometheus-output.md
- Prometheus Remote Write output:
- Containerlab: deployments/single-instance/containerlab/prometheus-remote-write-output.md
- Multiple outputs:
- Containerlab: deployments/single-instance/containerlab/multiple-outputs.md
- Docker Compose: deployments/single-instance/docker-compose/multiple-outputs.md
- gNMIc Cluster:
- InfluxDB output:
- Containerlab: deployments/clusters/containerlab/cluster_with_influxdb_output.md
- Docker Compose: deployments/clusters/docker-compose/cluster_with_influxdb_output.md
- Prometheus output:
- Containerlab: deployments/clusters/containerlab/cluster_with_prometheus_output.md
- Docker Compose: deployments/clusters/docker-compose/cluster_with_prometheus_output.md
- Kubernetes: deployments/clusters/kubernetes/cluster_with_prometheus_output.md
- Prometheus output with data replication:
- Containerlab: deployments/clusters/containerlab/cluster_with_nats_input_and_prometheus_output.md
- Docker Compose: deployments/clusters/docker-compose/cluster_with_nats_input_and_prometheus_output.md
- gNMI Server Cluster:
- Containerlab: deployments/clusters/containerlab/cluster_with_gnmi_server_and_prometheus_output.md
- gNMIc Pipeline:
- NATS to Prometheus:
- Docker Compose: deployments/pipelines/docker-compose/nats_prometheus.md
- NATS to InfluxDB:
- Docker Compose: deployments/pipelines/docker-compose/nats_influxdb.md
- Clustered pipeline:
- Docker Compose: deployments/pipelines/docker-compose/gnmic_cluster_nats_prometheus.md
- Forked pipeline:
- Docker Compose: deployments/pipelines/docker-compose/forked_pipeline.md
- Changelog: changelog.md
# - Blog: blog/index.md
site_author: Karim Radhouani
site_description: >-
gnmi client and collector command line interface
# Repository
repo_name: openconfig/gnmic
repo_url: https://github.com/openconfig/gnmic
edit_uri: ""
theme:
name: material
features:
- navigation.tabs
#- navigation.expand
- navigation.top
#- navigation.sections
# 404 page
static_templates:
- 404.html
# Don't include MkDocs' JavaScript
include_search_page: false
search_index_only: true
# Default values, taken from mkdocs_theme.yml
language: en
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: cyan
toggle:
icon: material/toggle-switch
name: Switch to light mode
font:
text: Manrope
code: Fira Mono
icon:
logo: octicons/pulse-24
favicon: images/pulse.svg
extra_css:
- stylesheets/extra.css
# Plugins
plugins:
- search
- minify:
minify_html: true
# Customization
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/karimra
analytics:
provider: google
property: UA-177206500-1
# Extensions
markdown_extensions:
- markdown.extensions.admonition
- markdown.extensions.attr_list
- markdown.extensions.codehilite:
guess_lang: false
- markdown.extensions.def_list
- markdown.extensions.footnotes
- markdown.extensions.meta
- markdown.extensions.toc:
permalink: "#"
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight:
linenums_style: pymdownx-inline
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: squidfunk
repo: mkdocs-material
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences
- pymdownx.tabbed
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde