pyrra-dev / pyrra

Making SLOs with Prometheus manageable, accessible, and easy to use for everyone!
https://demo.pyrra.dev
Apache License 2.0
1.25k stars 113 forks source link

Give proper command to show help #1184

Closed bbrandt closed 6 months ago

bbrandt commented 6 months ago

After running through the instructions all the way through make all, there does not seem to be a ./bin/api produced from the build. ./pyrra api --help was able to give me these instructions:

Usage: pyrra api [flags]

Runs Pyrra's API and UI.

Flags:
  -h, --help                                    Show context-sensitive help.
      --log-level="info"                        Used to set the logging level of the application. Valid options are 'debug', 'info',
                                                'warn' or 'error'
      --log-format="logfmt"                     Used to set the logging format. Valid options are 'logfmt' or 'json'

      --prometheus-url=http://localhost:9090    The URL to the Prometheus to query.
      --prometheus-external-url=PROMETHEUS-EXTERNAL-URL
                                                The URL for the UI to redirect users to when opening Prometheus. If empty the same as
                                                prometheus.url
      --api-url=http://localhost:9444           The URL to the API service like a Kubernetes Operator.
      --route-prefix=""                         The route prefix Pyrra uses. If run behind a proxy you can change it to something like
                                                /pyrra here.
      --ui-route-prefix=""                      The route prefix Pyrra's UI uses. This is helpful for when the prefix is stripped by a
                                                proxy but still runs on /pyrra. Defaults to --route-prefix
      --prometheus-bearer-token-path=""         Bearer token path
      --prometheus-basic-auth-username=""       The HTTP basic authentication username
      --prometheus-basic-auth-password=""       The HTTP basic authentication password
      --tls-cert-file=""                        File containing the default x509 Certificate for HTTPS.
      --tls-private-key-file=""                 File containing the default x509 private key matching --tls-cert-file.
      --tls-client-ca-file=""                   File containing the CA certificate for the client