Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs feedback: /docs/sources/setup/install/helm/install-scalable/_index.md #13088

Closed
edsoncelio opened this issue May 30, 2024 · 6 comments
Closed
Labels
area/helm type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories

Comments

@edsoncelio
Copy link
Contributor

Hello,

If you try to follow these docs to set up a minimal installation you will receive this error:

Error: INSTALLATION FAILED: execution error at (loki/templates/validate.yaml:40:4): You must provide a schema_config for Loki, one is not provided as this will be individual for every Loki cluster. See [Storage schema | Grafana Loki documentation](https://grafana.com/docs/loki/latest/operations/storage/schema/) for schema information. For quick testing (with no persistence) add --set loki.useTestSchema=true

To fix it you need to add the schemaConfig block, like this:

loki:
  schemaConfig:
    configs:
      - from: 2024-04-01
        store: tsdb
        object_store: s3
        schema: v13
        index:
          prefix: index_
          period: 24h

And then it will work fine.

Besides that, the examples that are referencing the schemaConfig are outdated, referencing to to schema_config: https://grafana.com/docs/loki/latest/configure/examples/configuration-examples/

It will be good to add this block above (or a similar one) to achieve the docs goal or add the flag to use the test schema with a few words explaining the reason.

Another suggestion is to specify a version of the helm chart used in this guide, this will help to not break the docs in breaking changes.

I can open a PR to update these docs (If this is an expected behavior).

@JStickler JStickler added area/helm type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Jun 3, 2024
@zhihali
Copy link

zhihali commented Jun 18, 2024

Hi there, It's been three weeks since this issue was opened. Are you currently working on it? If not, I would be happy to start working on it.

@edsoncelio
Copy link
Contributor Author

Hi there, It's been three weeks since this issue was opened. Are you currently working on it? If not, I would be happy to start working on it.

@Charlie-lizhihan As far as I know, most of this issue was covered by this PR: #13083

Only this part:

Besides that, the examples that are referencing the schemaConfig are outdated, referencing to schema_config: https://grafana.com/docs/loki/latest/configure/examples/configuration-examples/

was not fixed yet.

@derek-cadzow
Copy link
Contributor

@JStickler is this one you should be shepherding or is it one of the ones we spoke about the other week that is not?

@Jayclifford345
Copy link
Contributor

Hi all I just wanted to check in on this issue. I updated the docs back on the June 5th which should remove the use of schema_config but let me know if more needs to be done here. Apologies for not updating this issue.

@JStickler
Copy link
Contributor

FYI - @Jayclifford345's PRs that updated this topic were #13083 and #13347.

@edsoncelio
Copy link
Contributor Author

It looks like everything has been updated, I'll close this issue.
Thank you so much, folks!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/helm type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

No branches or pull requests

5 participants