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

Server section of promtail documentation is incomplete #9583

Open
a-a-abramov opened this issue May 31, 2023 · 0 comments
Open

Server section of promtail documentation is incomplete #9583

a-a-abramov opened this issue May 31, 2023 · 0 comments
Assignees
Labels
help wanted We would love help on these issues. Please come help us! type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories

Comments

@a-a-abramov
Copy link

a-a-abramov commented May 31, 2023

Describe the bug
Some fields are absent from server section of Promtail's configuration. For instance http_tls_config – it's possible to run Promtail's loki_push_api behind TLS, but this part of documentation is missing.

We're pretty sure it's documentation issue only, because (1.) both Loki and Promtail use the same web server package from Weaveworks and (2.) this Promtail config actually works as expected – :3100 is accessible via https only:

server:
  http_listen_port: 3200

positions:
  filename: /var/lib/promtail/positions.yaml

clients:
- url: https://example.com:3100/loki/api/v1/push
  tenant_id: tenant1
  external_labels:
    dc: dc1
    host: example.dc1.com

scrape_configs:
- job_name: loki_push_api
  loki_push_api:
    server:
      http_listen_port: 3100
      http_tls_config:
        cert_file: /etc/ssl/certs/some.crt
        key_file: /etc/ssl/private/some.key
    use_incoming_timestamp: true
  pipeline_stages:
    ...

To Reproduce
Nothing besides documentation is broken.

Expected behavior
Documentation page clearly states that it's possible to run loki_push_api behind TLS.

Environment:

Screenshots, Promtail config, or terminal output

@JStickler JStickler added the type/docs Issues related to technical documentation; the Docs Squad uses this label across many repositories label May 31, 2023
@JStickler JStickler self-assigned this May 31, 2023
@JStickler JStickler added the help wanted We would love help on these issues. Please come help us! label Aug 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted We would love help on these issues. Please come help us! 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

2 participants