Skip to content

Documentation bugs. Helm chart bug. (With fixes!) #912

Open
@StianOvrevage

Description

@StianOvrevage

Great work on cloudinfo! Looks very well made.

I have a few fixes and suggestions but I don't have time to create a PR for them right now but they are all tiny :)

Documentation bugs

The examples in https://github.com/banzaicloud/cloudinfo#api-calls use http://localhost:9090 which does not work since that is the Prometheus metrics port.

Fix: Should be changed to http://localhost:9090.

The commands to create Google Service Account in https://github.com/banzaicloud/cloudinfo#google-cloud does not work since cloudinfoSA is not a valid name for a service account, since it contains upper-case letters.

Fix: Change service account name from cloudinfoSA to cloudinfoSA

It's not immediately obvious how to populate .Values.providers.google.credentials in the helm chart values.

Fix: Add a hint that it's the base64 encoded contents of the credentials.json file, cloudinfo.gcloud.json if using the commands from https://github.com/banzaicloud/cloudinfo#google-cloud

Helm chart bug

Deploying the helm charts does not work since the liveness and readiness probes gets double slashes:

app:
  logLevel: "info"
  basePath: "/"
...
          livenessProbe:
            httpGet:
              path: {{ .Values.app.basePath }}/status

//status gives 404:

time="2022-09-11T19:10:46Z" level=info correlation-id=f66cffc2-0b98-4b4e-89c3-9f608e0e09a9 latency="27.591µs" method=GET path=//status status=404

Fix:

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions