kumahq / kuma

🐻 The multi-zone service mesh for containers, Kubernetes and VMs. Built with Envoy. CNCF Sandbox Project.
https://kuma.io/install
Apache License 2.0
3.6k stars 332 forks source link

Improve help for "kumactl install observability" #4924

Open lobkovilya opened 2 years ago

lobkovilya commented 2 years ago

What happened?

Today the output looks like this:

Install Observability (Metrics, Logging, Tracing) backend in Kubernetes cluster (Prometheus + Grafana + Loki + Jaeger + Zipkin) in its own namespace.

Usage:
  kumactl install observability [flags]

Flags:
      --components strings          list of components (default [grafana,prometheus,loki,jaeger])
  -h, --help                        help for observability
      --jaeger-address string       the address of jaeger to query (default "http://jaeger-query.mesh-observability")
      --kuma-cp-address string      the address of Kuma CP (default "http://kuma-control-plane.kuma-system:5676")
      --loki-address string         the address of the loki to query (default "http://loki.mesh-observability:3100")
  -m, --mesh string                 mesh to use (default "default")
      --namespace string            namespace to install observability to (default "mesh-observability")
      --prometheus-address string   the address of the prometheus server (default "http://prometheus-server.mesh-observability")

Global Flags:
      --api-timeout duration   the timeout for api calls. It includes connection time, any redirects, and reading the response body. A timeout of zero means no timeout (default 1m0s)
      --config-file string     path to the configuration file to use
      --log-level string       log level: one of off|info|debug (default "off")
      --no-config              if set no config file and config directory will be created

There are 2 problems:

  1. You may think that --components should be passed as a list with square brackets. If you pass with square brackets there is no error, but the output is incorrect.
  2. No reminder that metrics backend should be added to the mesh object.
github-actions[bot] commented 1 year ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

DhritiShikhar commented 1 year ago

Hi, I would like to fix this issue. Can I assign this to myself? @jakubdyszkiewicz

johnharris85 commented 1 year ago

Hey @DhritiShikhar did you still want to work on this?

github-actions[bot] commented 1 year ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 10 months ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

tfalbo commented 8 months ago

Hi! Can I take this one?

github-actions[bot] commented 5 months ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.

github-actions[bot] commented 1 month ago

This issue was inactive for 90 days. It will be reviewed in the next triage meeting and might be closed. If you think this issue is still relevant, please comment on it or attend the next triage meeting.