From e75d678fc57c342aed986b1469783e45a0718447 Mon Sep 17 00:00:00 2001 From: Karim Radhouani Date: Fri, 7 Oct 2022 10:17:01 -0700 Subject: [PATCH] update docs URL --- .goreleaser.yml | 2 +- README.md | 34 ++++++++++++++++---------------- app/app.go | 2 +- app/version.go | 4 ++-- cmd/root.go | 2 +- docs/CNAME | 2 +- docs/index.md | 18 ++++++++--------- docs/install.md | 8 ++++---- docs/user_guide/tunnel_server.md | 2 +- goreleaser-alpine.dockerfile | 2 +- goreleaser-scratch.dockerfile | 2 +- install.sh | 2 +- utils/tls.go | 4 ++-- 13 files changed, 42 insertions(+), 42 deletions(-) diff --git a/.goreleaser.yml b/.goreleaser.yml index ff733f37..5ff9e35d 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -67,7 +67,7 @@ nfpms: darwin: Darwin linux: Linux vendor: gnmic - homepage: https://gnmic.kmrd.dev + homepage: https://gnmic.openconfig.net maintainer: Karim Radhouani , Roman Dodin description: gNMI CLI client and collector license: Apache 2.0 diff --git a/README.md b/README.md index 39c446bb..680f4749 100644 --- a/README.md +++ b/README.md @@ -3,51 +3,51 @@ [![github release](https://img.shields.io/github/release/openconfig/gnmic.svg?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://github.com/openconfig/gnmic/releases/) [![Github all releases](https://img.shields.io/github/downloads/openconfig/gnmic/total.svg?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://github.com/openconfig/gnmic/releases/) [![Go Report](https://img.shields.io/badge/go%20report-A%2B-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://goreportcard.com/report/github.com/openconfig/gnmic) -[![Doc](https://img.shields.io/badge/Docs-gnmic.kmrd.dev-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://gnmic.kmrd.dev) +[![Doc](https://img.shields.io/badge/Docs-gnmic.openconfig.net-blue?style=flat-square&color=00c9ff&labelColor=bec8d2)](https://gnmic.openconfig.net) [![build](https://img.shields.io/github/workflow/status/openconfig/gnmic/Test/main?style=flat-square&labelColor=bec8d2)](https://github.com/openconfig/gnmic/releases/) --- `gnmic` (_pronoun.: gee·en·em·eye·see_) is a gNMI CLI client that provides full support for Capabilities, Get, Set and Subscribe RPCs with collector capabilities. -Documentation available at [https://gnmic.kmrd.dev](https://gnmic.kmrd.dev) +Documentation available at [https://gnmic.openconfig.net](https://gnmic.openconfig.net) ## Features * **Full support for gNMI RPCs** - Every gNMI RPC has a [corresponding command](https://gnmic.kmrd.dev/basic_usage/) with all of the RPC options configurable by means of the local and global flags. + Every gNMI RPC has a [corresponding command](https://gnmic.openconfig.net/basic_usage/) with all of the RPC options configurable by means of the local and global flags. * **Flexible collector deployment** - `gnmic` can be deployed as a gNMI collector that supports multiple output types ([NATS](https://gnmic.kmrd.dev/user_guide/outputs/nats_output/), [Kafka](https://gnmic.kmrd.dev/user_guide/outputs/kafka_output/), [Prometheus](https://gnmic.kmrd.dev/user_guide/outputs/prometheus_output/), [InfluxDB](https://gnmic.kmrd.dev/user_guide/outputs/influxdb_output/),...). - The collector can be deployed either as a [single instance](https://gnmic.kmrd.dev/deployments/deployments_intro/#single-instance), as part of a [cluster](https://gnmic.kmrd.dev/user_guide/HA/), or used to form [data pipelines](https://gnmic.kmrd.dev/deployments/deployments_intro/#pipelines). + `gnmic` can be deployed as a gNMI collector that supports multiple output types ([NATS](https://gnmic.openconfig.net/user_guide/outputs/nats_output/), [Kafka](https://gnmic.openconfig.net/user_guide/outputs/kafka_output/), [Prometheus](https://gnmic.openconfig.net/user_guide/outputs/prometheus_output/), [InfluxDB](https://gnmic.openconfig.net/user_guide/outputs/influxdb_output/),...). + The collector can be deployed either as a [single instance](https://gnmic.openconfig.net/deployments/deployments_intro/#single-instance), as part of a [cluster](https://gnmic.openconfig.net/user_guide/HA/), or used to form [data pipelines](https://gnmic.openconfig.net/deployments/deployments_intro/#pipelines). * **Support gRPC tunnel based dialout telemetry** - `gnmic` can be deployed as a gNMI collector with an [embedded tunnel server](https://gnmic.kmrd.dev/user_guide/tunnel_server/). + `gnmic` can be deployed as a gNMI collector with an [embedded tunnel server](https://gnmic.openconfig.net/user_guide/tunnel_server/). * **gNMI data manipulation** - `gnmic` collector has [data transformation](https://gnmic.kmrd.dev/user_guide/event_processors/intro/) capabilities that can be used to adapt the collected data to your specific use case. + `gnmic` collector has [data transformation](https://gnmic.openconfig.net/user_guide/event_processors/intro/) capabilities that can be used to adapt the collected data to your specific use case. * **Dynamic targets loading** - `gnmic` support [target loading at runtime](https://gnmic.kmrd.dev/user_guide/target_discovery/discovery_intro/) based on input from external systems. + `gnmic` support [target loading at runtime](https://gnmic.openconfig.net/user_guide/target_discovery/discovery_intro/) based on input from external systems. * **YANG-based path suggestions** - Your CLI magically becomes a YANG browser when `gnmic` is executed in [prompt](https://gnmic.kmrd.dev/user_guide/prompt_suggestions/) mode. In this mode the flags that take XPATH values will get auto-suggestions based on the provided YANG modules. In other words - voodoo magic :exploding_head: + Your CLI magically becomes a YANG browser when `gnmic` is executed in [prompt](https://gnmic.openconfig.net/user_guide/prompt_suggestions/) mode. In this mode the flags that take XPATH values will get auto-suggestions based on the provided YANG modules. In other words - voodoo magic :exploding_head: * **Multi-target operations** - Commands can operate on [multiple gNMI targets](https://gnmic.kmrd.dev/user_guide/targets/) for bulk configuration/retrieval/subscription. + Commands can operate on [multiple gNMI targets](https://gnmic.openconfig.net/user_guide/targets/) for bulk configuration/retrieval/subscription. * **Multiple configuration sources** - gnmic supports [flags](https://gnmic.kmrd.dev/user_guide/configuration_flags), [environment variables](https://gnmic.kmrd.dev/user_guide/configuration_env/) as well as [file based]((https://gnmic.kmrd.dev/user_guide/configuration_file/)) configurations. + gnmic supports [flags](https://gnmic.openconfig.net/user_guide/configuration_flags), [environment variables](https://gnmic.openconfig.net/user_guide/configuration_env/) as well as [file based]((https://gnmic.openconfig.net/user_guide/configuration_file/)) configurations. * **Inspect raw gNMI messages** With the `prototext` output format you can see the actual gNMI messages being sent/received. Its like having a gNMI looking glass! * **(In)secure gRPC connection** - gNMI client supports both TLS and [non-TLS](https://gnmic.kmrd.dev/global_flags/#insecure) transports so you can start using it in a lab environment without having to care about the PKI. + gNMI client supports both TLS and [non-TLS](https://gnmic.openconfig.net/global_flags/#insecure) transports so you can start using it in a lab environment without having to care about the PKI. * **Dial-out telemetry** - The [dial-out telemetry server](https://gnmic.kmrd.dev/cmd/listen/) is provided for Nokia SR OS. + The [dial-out telemetry server](https://gnmic.openconfig.net/cmd/listen/) is provided for Nokia SR OS. * **Pre-built multi-platform binaries** - Statically linked [binaries](https://github.com/openconfig/gnmic/releases) made in our release pipeline are available for major operating systems and architectures. Making [installation](https://gnmic.kmrd.dev/install/) a breeze! + Statically linked [binaries](https://github.com/openconfig/gnmic/releases) made in our release pipeline are available for major operating systems and architectures. Making [installation](https://gnmic.openconfig.net/install/) a breeze! * **Extensive and friendly documentation** - You won't be in need to dive into the source code to understand how `gnmic` works, our [documentation site](https://gnmic.kmrd.dev) has you covered. + You won't be in need to dive into the source code to understand how `gnmic` works, our [documentation site](https://gnmic.openconfig.net) has you covered. ## Quick start guide ### Installation ``` -bash -c "$(curl -sL https://get-gnmic.kmrd.dev)" +bash -c "$(curl -sL https://get-gnmic.openconfig.net)" ``` ### Capabilities request @@ -80,7 +80,7 @@ gnmic -a 10.1.0.11:57400 -u admin -p admin --insecure \ ### Prompt mode -The [prompt mode](https://gnmic.kmrd.dev/user_guide/prompt_suggestions/) is an interactive mode of the gnmic CLI client for user convenience. +The [prompt mode](https://gnmic.openconfig.net/user_guide/prompt_suggestions/) is an interactive mode of the gnmic CLI client for user convenience. ```bash # clone repository with YANG models (Openconfig example) diff --git a/app/app.go b/app/app.go index b9a4192a..989f5a0c 100644 --- a/app/app.go +++ b/app/app.go @@ -213,7 +213,7 @@ func (a *App) PreRunE(cmd *cobra.Command, args []string) error { a.Logger.SetOutput(logOutput) a.Logger.SetFlags(flags) a.Config.Address = config.SanitizeArrayFlagValue(a.Config.Address) - a.Logger.Printf("version=%s, commit=%s, date=%s, gitURL=%s, docs=https://gnmic.kmrd.dev", version, commit, date, gitURL) + a.Logger.Printf("version=%s, commit=%s, date=%s, gitURL=%s, docs=https://gnmic.openconfig.net", version, commit, date, gitURL) if a.Config.Debug { grpclog.SetLogger(a.Logger) //lint:ignore SA1019 see https://github.com/karimra/gnmic/issues/59 diff --git a/app/version.go b/app/version.go index 26731a9e..84a4738e 100644 --- a/app/version.go +++ b/app/version.go @@ -37,7 +37,7 @@ func (a *App) VersionRun(cmd *cobra.Command, args []string) { fmt.Printf(" commit : %s\n", commit) fmt.Printf(" date : %s\n", date) fmt.Printf(" gitURL : %s\n", gitURL) - fmt.Printf(" docs : https://gnmic.kmrd.dev\n") + fmt.Printf(" docs : https://gnmic.openconfig.net\n") return } b, err := json.Marshal(map[string]string{ @@ -45,7 +45,7 @@ func (a *App) VersionRun(cmd *cobra.Command, args []string) { "commit": commit, "date": date, "gitURL": gitURL, - "docs": "https://gnmic.kmrd.dev", + "docs": "https://gnmic.openconfig.net", }) // need indent? use jq if err != nil { a.Logger.Printf("failed: %v", err) diff --git a/cmd/root.go b/cmd/root.go index 1eaca751..7a05e69f 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -40,7 +40,7 @@ var gApp = app.New() func newRootCmd() *cobra.Command { gApp.RootCmd = &cobra.Command{ Use: "gnmic", - Short: "run gnmi rpcs from the terminal (https://gnmic.kmrd.dev)", + Short: "run gnmi rpcs from the terminal (https://gnmic.openconfig.net)", Annotations: map[string]string{ "--encoding": "ENCODING", "--config": "FILE", diff --git a/docs/CNAME b/docs/CNAME index ffdb8dbd..030df928 100644 --- a/docs/CNAME +++ b/docs/CNAME @@ -1 +1 @@ -gnmic.kmrd.dev \ No newline at end of file +gnmic.openconfig.net \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index e01feee0..214de8b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,7 +10,7 @@ ## Features * **Full support for gNMI RPCs** - Every gNMI RPC has a [corresponding command](https://gnmic.kmrd.dev/basic_usage/) with all of the RPC options configurable by means of the local and global flags. + Every gNMI RPC has a [corresponding command](https://gnmic.openconfig.net/basic_usage/) with all of the RPC options configurable by means of the local and global flags. * **Flexible collector deployment** `gnmic` can be deployed as a gNMI collector that supports multiple output types ([NATS](user_guide/outputs/nats_output.md), [Kafka](user_guide/outputs/kafka_output.md), [Prometheus](user_guide/outputs/prometheus_output.md), [InfluxDB](user_guide/outputs/influxdb_output.md),...). The collector can be deployed either as a [single instance](deployments/deployments_intro/#single-instance), as part of a [cluster](user_guide/HA/), or used to form [data pipelines](deployments/deployments_intro/#pipelines). @@ -21,26 +21,26 @@ * **YANG-based path suggestions** Your CLI magically becomes a YANG browser when `gnmic` is executed in [prompt](user_guide/prompt_suggestions.md) mode. In this mode the flags that take XPATH values will get auto-suggestions based on the provided YANG modules. In other words - voodoo magic :exploding_head: * **Multiple configuration sources** - gnmic supports [flags](user_guide/configuration_flags), [environment variables](user_guide/configuration_env/) as well as [file based](https://gnmic.kmrd.dev/user_guide/configuration_file/) configurations. + gnmic supports [flags](user_guide/configuration_flags), [environment variables](user_guide/configuration_env/) as well as [file based](https://gnmic.openconfig.net/user_guide/configuration_file/) configurations. * **Multi-target operations** - Commands can operate on [multiple gNMI targets](https://gnmic.kmrd.dev/user_guide/targets/) for bulk configuration/retrieval/subscription. + Commands can operate on [multiple gNMI targets](https://gnmic.openconfig.net/user_guide/targets/) for bulk configuration/retrieval/subscription. * **Multiple subscriptions** - With file based configuration it is possible to define and configure [multiple subscriptions](https://gnmic.kmrd.dev/user_guide/subscriptions/) which can be independently associated with gNMI targets. + With file based configuration it is possible to define and configure [multiple subscriptions](https://gnmic.openconfig.net/user_guide/subscriptions/) which can be independently associated with gNMI targets. * **Inspect gNMI messages** With the `textproto` output format and the logging capabilities of `gnmic` you can see the actual gNMI messages being sent/received. Its like having a gNMI looking glass! * **Configurable TLS enforcement** - gNMI client supports both TLS and [non-TLS](https://gnmic.kmrd.dev/global_flags/#insecure) transports so you can start using it in a lab environment without having to care about the PKI. + gNMI client supports both TLS and [non-TLS](https://gnmic.openconfig.net/global_flags/#insecure) transports so you can start using it in a lab environment without having to care about the PKI. * **Dial-out telemetry** - The [dial-out telemetry server](https://gnmic.kmrd.dev/cmd/listen/) is provided for Nokia SR OS. + The [dial-out telemetry server](https://gnmic.openconfig.net/cmd/listen/) is provided for Nokia SR OS. * **Pre-built multi-platform binaries** - Statically linked [binaries](https://github.com/openconfig/gnmic/releases) made in our release pipeline are available for major operating systems and architectures. Making [installation](https://gnmic.kmrd.dev/install/) a breeze! + Statically linked [binaries](https://github.com/openconfig/gnmic/releases) made in our release pipeline are available for major operating systems and architectures. Making [installation](https://gnmic.openconfig.net/install/) a breeze! * **Extensive and friendly documentation** - You won't be in need to dive into the source code to understand how `gnimc` works, our [documentation site](https://gnmic.kmrd.dev) has you covered. + You won't be in need to dive into the source code to understand how `gnimc` works, our [documentation site](https://gnmic.openconfig.net) has you covered. ## Quick start guide ### Installation ``` -bash -c "$(curl -sL https://get-gnmic.kmrd.dev)" +bash -c "$(curl -sL https://get-gnmic.openconfig.net)" ``` ### Capabilities request ``` diff --git a/docs/install.md b/docs/install.md index 88aa8a6f..ae9f1e6c 100644 --- a/docs/install.md +++ b/docs/install.md @@ -5,7 +5,7 @@ To download & install the latest release the following automated [installation script](https://github.com/openconfig/gnmic/blob/main/install.sh) can be used: ```bash -bash -c "$(curl -sL https://get-gnmic.kmrd.dev)" +bash -c "$(curl -sL https://get-gnmic.openconfig.net)" ``` As a result, the latest `gnmic` version will be installed in the `/usr/local/bin` directory and the version information will be printed out. @@ -18,14 +18,14 @@ version : 0.0.3 commit : f541948 date : 2020-04-23T12:06:07Z gitURL : https://github.com/openconfig/gnmic.git - docs : https://gnmic.kmrd.dev + docs : https://gnmic.openconfig.net Installation complete! ``` To install a specific version of `gnmic`, provide the version with `-v` flag to the installation script: ```bash -bash -c "$(curl -sL https://get-gnmic.kmrd.dev)" -- -v 0.5.0 +bash -c "$(curl -sL https://get-gnmic.openconfig.net)" -- -v 0.5.0 ``` #### Packages @@ -33,7 +33,7 @@ bash -c "$(curl -sL https://get-gnmic.kmrd.dev)" -- -v 0.5.0 Linux users running distributions with support for `deb`/`rpm` packages can install `gnmic` using pre-built packages: ```bash -bash -c "$(curl -sL https://get-gnmic.kmrd.dev)" -- --use-pkg +bash -c "$(curl -sL https://get-gnmic.openconfig.net)" -- --use-pkg ``` #### Upgrade diff --git a/docs/user_guide/tunnel_server.md b/docs/user_guide/tunnel_server.md index 10b7f5bb..7ed61e0c 100644 --- a/docs/user_guide/tunnel_server.md +++ b/docs/user_guide/tunnel_server.md @@ -36,7 +36,7 @@ $ gnmic --config tunnel_server_config.yaml \ --use-tunnel-server \ get \ --path /configure/system/name -2022/03/09 10:12:34.729037 [gnmic] version=dev, commit=none, date=unknown, gitURL=, docs=https://gnmic.kmrd.dev +2022/03/09 10:12:34.729037 [gnmic] version=dev, commit=none, date=unknown, gitURL=, docs=https://gnmic.openconfig.net 2022/03/09 10:12:34.729063 [gnmic] using config file "tunnel_server_config.yaml" 2022/03/09 10:12:34.730472 [gnmic] waiting for targets to register with the tunnel server... 2022/03/09 10:12:36.435521 [gnmic] tunnel server discovered target {ID:sr1 Type:GNMI_GNOI} diff --git a/goreleaser-alpine.dockerfile b/goreleaser-alpine.dockerfile index 2c05e3d4..a3d0595c 100644 --- a/goreleaser-alpine.dockerfile +++ b/goreleaser-alpine.dockerfile @@ -9,7 +9,7 @@ FROM alpine LABEL maintainer="Karim Radhouani , Roman Dodin " -LABEL documentation="https://gnmic.kmrd.dev" +LABEL documentation="https://gnmic.openconfig.net" LABEL repo="https://github.com/openconfig/gnmic" COPY gnmic /app/gnmic diff --git a/goreleaser-scratch.dockerfile b/goreleaser-scratch.dockerfile index 451a630a..2d2477a6 100644 --- a/goreleaser-scratch.dockerfile +++ b/goreleaser-scratch.dockerfile @@ -9,7 +9,7 @@ FROM scratch LABEL maintainer="Karim Radhouani , Roman Dodin " -LABEL documentation="https://gnmic.kmrd.dev" +LABEL documentation="https://gnmic.openconfig.net" LABEL repo="https://github.com/openconfig/gnmic" COPY gnmic /app/gnmic diff --git a/install.sh b/install.sh index 8eda4ce3..36c162ff 100644 --- a/install.sh +++ b/install.sh @@ -19,7 +19,7 @@ : ${BIN_INSTALL_DIR:="/usr/local/bin"} : ${REPO_NAME:="openconfig/gnmic"} : ${REPO_URL:="https://github.com/$REPO_NAME"} -: ${PROJECT_URL:="https://gnmic.kmrd.dev"} +: ${PROJECT_URL:="https://gnmic.openconfig.net"} : ${LATEST_URL:="https://api.github.com/repos/$REPO_NAME/releases/latest"} # detectArch discovers the architecture for this system. detectArch() { diff --git a/utils/tls.go b/utils/tls.go index 74374dd7..51e9e80f 100644 --- a/utils/tls.go +++ b/utils/tls.go @@ -105,9 +105,9 @@ func SelfSignedCerts() (tls.Certificate, error) { certTemplate := &x509.Certificate{ SerialNumber: serialNumber, Subject: pkix.Name{ - Organization: []string{"kmrd.dev"}, + Organization: []string{"openconfig.net"}, }, - DNSNames: []string{"kmrd.dev"}, + DNSNames: []string{"openconfig.net"}, NotBefore: notBefore, NotAfter: notAfter, KeyUsage: x509.KeyUsageKeyEncipherment | x509.KeyUsageDigitalSignature,