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.

Sign up for GitHub

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

[admin] Add criteria for distributions #376

Merged
merged 12 commits into from
Aug 8, 2023
Merged

[admin] Add criteria for distributions #376

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9cf24ff
Add criteria for distributions
TylerHelmuth Jul 26, 2023
3e27e05
Add definition of support
TylerHelmuth Jul 26, 2023
b85d5b6
Apply suggestions from code review
TylerHelmuth Jul 26, 2023
7293776
Apply feedback
TylerHelmuth Jul 26, 2023
8c6c263
Update wording
TylerHelmuth Jul 26, 2023
ddaf75c
Typo
TylerHelmuth Jul 26, 2023
8f55c0d
Add `recommended for production` criteria to 1.
TylerHelmuth Jul 26, 2023
7c6c6bc
Apply feedback
TylerHelmuth Jul 27, 2023
081801e
Apply suggestions from code review
TylerHelmuth Aug 3, 2023
2725075
Apply feedback
TylerHelmuth Aug 3, 2023
4512f75
Adjust rules 2 and 3
TylerHelmuth Aug 4, 2023
d7803b7
Update distributions/README.md
TylerHelmuth Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions distributions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,17 @@

Support for a distribution implies all the duties covered by the Approver and Maintainer role requirements. In addition, support means that the Collector SIG is the owner and maintainer of the binaries/images of the different Collector distributions and is responsible for the pipeline that produces those artifacts.

The Collector SIG must support at least one distribution that is recommended for production which includes support for Prometheus, Jaeger, Zipkin, and OpenCensus.
Copy link
Member

Choose a reason for hiding this comment

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

Jaeger and OpenCensus will be deprecated and removed at some point. Will we update this one later or better rephrase it now?

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 say we update it once we aren't being held to that expectation. As far as I am aware we still are. @jpkrohling can you confirm?

Copy link
Member

@jpkrohling jpkrohling Aug 2, 2023 •
edited
Loading

Choose a reason for hiding this comment

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

They will be, but they are not yet. I'd keep them here, and remove when time comes.

TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved

Distributions supported by the Collector SIG should fulfill the following criteria:

1. Support at least one distribution that is recommended for production which includes support for Prometheus, Jaeger, Zipkin, and OpenCensus.
2. Serve a specific purpose and those purposes should have minimal overlap.
3. Meet general needs and not be too niche.
4. Only target the needs of the OpenTelemetry project.
5. May be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG recommends the distribution be used in Production environments.
6. Must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories.
7. Have a clearly defined list of criteria for which components are included.
8. Must include the following assets except where the specific purpose of the distribution is naturally associated with a subset of these assets. In such cases, it should be clearly stated which assets are skipped and why. Additional asset may be included if the distro desires:
1. Serve a specific purpose and those purposes should have minimal overlap.
TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved
2. Meet general needs and not be too niche.
3. Only target the needs of the OpenTelemetry project.
Aneurysm9 marked this conversation as resolved.
Show resolved Hide resolved
4. May be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG recommends the distribution be used in Production environments.
TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved
5. Must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories.
6. Have a clearly defined list of criteria for which components are included.
djaglowski marked this conversation as resolved.
Show resolved Hide resolved
7. Must include the following assets except where the specific purpose of the distribution is naturally associated with a subset of these assets. In such cases, it should be clearly stated which assets are skipped and why. Additional asset may be included if the distro desires:
djaglowski marked this conversation as resolved.
Show resolved Hide resolved
TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved
- Binaries for linux_amd64, linux_arm64, windows_amd64 and darwin_arm64
- linux_amd64 and linux_arm64 container images
- Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) for each distributed binary.
TylerHelmuth marked this conversation as resolved.
Show resolved Hide resolved
Expand Down