Add DroneCI pipeline stage to validate loki example configs; create example configuration files #4358
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JordanRushing
force-pushed
the
jordanrushing/loki/validate-provided-example-configs
branch
from
333e7d3
to
833ae9d
Compare
owen-d
reviewed
Sep 21, 2021
kavirajk
reviewed
Oct 7, 2021
JordanRushing
force-pushed
the
jordanrushing/loki/validate-provided-example-configs
branch
from
cdab508
to
ed2d53f
Compare
JordanRushing
force-pushed
the
jordanrushing/loki/validate-provided-example-configs
branch
from
ed2d53f
to
0338028
Compare
owen-d
approved these changes
Oct 8, 2021
KMiller-Grafana
suggested changes
Oct 8, 2021
docs/sources/configuration/examples/almost-zero-dependency.yaml
Outdated
Show resolved
Hide resolved
docs/sources/configuration/examples/aws-basic-config-no-creds.yaml
Outdated
Show resolved
Hide resolved
docs/sources/configuration/examples/google-cloud-storage-config.yaml
Outdated
Show resolved
Hide resolved
docs/sources/configuration/examples/google-cloud-storage-config.yaml
Outdated
Show resolved
Hide resolved
…xample configuration files
… target for CI to verify doc is re-generated upon changes to example configs
…onal for config example doc checking
Co-authored-by: Karen Miller <84039272+KMiller-Grafana@users.noreply.github.com>
JordanRushing
force-pushed
the
jordanrushing/loki/validate-provided-example-configs
branch
from
d874f02
to
f0954df
Compare
KMiller-Grafana
approved these changes
Oct 8, 2021
|
We can work out the generation check in CI with more idiomatic make targets, but happy to do that in a followup PR. Nice work! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
We want to provide some form of basic validation for example configurations that we provide to users to lower potential friction when experimenting with Loki.
This PR introduces:
maketargetsvalidate-example-configs,generate-example-config-doc,check-example-config-doccheckto validate example configsdocs/sources/configuration/examples.mdis now dynamically generated based on the file contents of./docs/sources/configuation/examples/*.yamlWhich issue(s) this PR fixes:
N/A
Special notes for your reviewer:
N/A
Checklist