Distrogen Documentation #455
Open
Conversation
This file contains hidden or 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
jefferbrecht
reviewed
Jan 8, 2026
docs/distrogen/distribution.md
Outdated
| | Field | Type | Default | Description | | ||
| |-------|------|---------|-------------| | ||
| | `name` | string | | The name for the distribution. | | ||
| | `display_name` | string | A human-readable name to use for the distribution. It is used in the title for the generated README. | |
Member
There was a problem hiding this comment.
Suggested change
| | `display_name` | string | A human-readable name to use for the distribution. It is used in the title for the generated README. | | |
| | `display_name` | string | | A human-readable name to use for the distribution. It is used in the title for the generated README. | |
jefferbrecht
reviewed
Jan 8, 2026
| | `boringcrypto` | bool | false | Whether to build the binary with [BoringCrypto](https://csrc.nist.gov/CSRC/media/projects/cryptographic-module-validation-program/documents/security-policies/140sp3678.pdf). | | ||
| | `collector_cgo` | bool | false | Whether to build the binary with `CGO_ENABLED=1`. This must be true if `boringcrypto` is turned on. | | ||
| | `build_container` | enum | `debian` | The base to use for the `Dockerfile.build` container's build layer. Only `debian` and `alpine` are supported right now. | | ||
| | `feature_gates` | string[] | | The [`featuregates`](https://github.com/open-telemetry/opentelemetry-collector/tree/main/featuregate) to enable in the Collector. This is leveraged in the default `ENTRYPOINT` of image builds. | |
Member
There was a problem hiding this comment.
Should feature gates also be propagated to the systemd and Windows service wrappers?
Contributor
Author
There was a problem hiding this comment.
Yeah they should. I will fix that in a followup PR.
braydonk
force-pushed
the
distrogen_docs
branch
from
2141f44 to
21465f0
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds usage documentation for
distrogen. While writing the docs, I found some minor usability issues that I fixed at the same time:Distro Makefile:
COLLECTOR_LD_FLAGS_*variables are specified a bit differently nowrelease.mkand put the local container target into the same Makefile (it was supposed to only be there temporarily)Project Makefile:
tidy-allandtest-alland renamed the targets to be more clear that it's about doing this in components