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

Clarify how and where to download the Loki config file from #7346

Merged
merged 2 commits into from
Oct 5, 2022

Conversation

mostafa
Copy link
Member

@mostafa mostafa commented Oct 5, 2022

What this PR does / why we need it:
The config file URL mentioned in the docs contain config options that doesn't match the latest version of Loki, which, as of now, is v2.6.1.

Which issue(s) this PR fixes:
Fixes #6915

Special notes for your reviewer:
Disclaimer: I am a Grafanista from k6.

Checklist

  • Reviewed the CONTRIBUTING.md guide
  • Documentation added
  • Tests updated
  • CHANGELOG.md updated
  • Changes that require user attention or interaction to upgrade are documented in docs/sources/upgrading/_index.md

@mostafa mostafa added size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories labels Oct 5, 2022
@mostafa mostafa requested a review from a team as a code owner October 5, 2022 15:50
@@ -17,10 +17,11 @@ The configuration specifies running Loki as a single binary.
3. Download the Loki and Promtail .zip files that correspond to your system.
**Note:** Do not download LogCLI or Loki Canary at this time. [LogCLI](../../getting-started/logcli/) allows you to run Loki queries in a command line interface. [Loki Canary](../../operations/loki-canary/) is a tool to audit Loki performance.
4. Unzip the package contents into the same directory. This is where the two programs will run.
5. In the command line, change directory (`cd` on most systems) to the directory with Loki and Promtail. Copy and paste the commands below into your command line to download generic configuration files:
5. In the command line, change directory (`cd` on most systems) to the directory with Loki and Promtail. Copy and paste the commands below into your command line to download generic configuration files.
**Note:** Use the corresponding Git refs that match your downloaded Loki version to get the correct configuration file. For example, if you are using Loki version 2.6.1, you need to use the `https://raw.githubusercontent.com/grafana/loki/v2.6.1/cmd/loki/loki-local-config.yaml` URL to download the configuration file that corresponds to the Loki version you aim to run.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to phrase it as best as I can. Feel free to change it to make it more clear.

@CLAassistant
Copy link

CLAassistant commented Oct 5, 2022

CLA assistant check
All committers have signed the CLA.

@grafanabot
Copy link
Collaborator

./tools/diff_coverage.sh ../loki-main/test_results.txt test_results.txt ingester,distributor,querier,querier/queryrange,iter,storage,chunkenc,logql,loki

Change in test coverage per package. Green indicates 0 or positive change, red indicates that test coverage for a package fell.

+           ingester	0%
+        distributor	0%
+            querier	0%
+ querier/queryrange	0%
+               iter	0%
+            storage	0%
+           chunkenc	0%
+              logql	0%
+               loki	0%

Copy link
Member

@owen-d owen-d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@owen-d owen-d merged commit f07e562 into main Oct 5, 2022
@owen-d owen-d deleted the clarify-git-ref-match-loki-version branch October 5, 2022 16:48
lxwzy pushed a commit to lxwzy/loki that referenced this pull request Nov 7, 2022
…7346)

**What this PR does / why we need it**:
The config file URL mentioned in the docs contain config options that
doesn't match the latest version of Loki, which, as of now, is v2.6.1.

**Which issue(s) this PR fixes**:
Fixes grafana#6915 

**Special notes for your reviewer**:
Disclaimer: I am a Grafanista from k6.

**Checklist**
- [x] Reviewed the `CONTRIBUTING.md` guide
- [ ] Documentation added
- [ ] Tests updated
- [x] `CHANGELOG.md` updated
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/upgrading/_index.md`
changhyuni pushed a commit to changhyuni/loki that referenced this pull request Nov 8, 2022
…7346)

**What this PR does / why we need it**:
The config file URL mentioned in the docs contain config options that
doesn't match the latest version of Loki, which, as of now, is v2.6.1.

**Which issue(s) this PR fixes**:
Fixes grafana#6915 

**Special notes for your reviewer**:
Disclaimer: I am a Grafanista from k6.

**Checklist**
- [x] Reviewed the `CONTRIBUTING.md` guide
- [ ] Documentation added
- [ ] Tests updated
- [x] `CHANGELOG.md` updated
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/upgrading/_index.md`
Abuelodelanada pushed a commit to canonical/loki that referenced this pull request Dec 1, 2022
…7346)

**What this PR does / why we need it**:
The config file URL mentioned in the docs contain config options that
doesn't match the latest version of Loki, which, as of now, is v2.6.1.

**Which issue(s) this PR fixes**:
Fixes grafana#6915 

**Special notes for your reviewer**:
Disclaimer: I am a Grafanista from k6.

**Checklist**
- [x] Reviewed the `CONTRIBUTING.md` guide
- [ ] Documentation added
- [ ] Tests updated
- [x] `CHANGELOG.md` updated
- [ ] Changes that require user attention or interaction to upgrade are
documented in `docs/sources/upgrading/_index.md`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/XS type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories
Projects
None yet
Development

Successfully merging this pull request may close these issues.

field embedded_cache not found in type cache.Config
4 participants