From 9cf24ffd1fcc22977f46a7d84a60ba94f73fbfc4 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:11:43 -0600 Subject: [PATCH 01/12] Add criteria for distributions --- README.md | 19 +++++++++++++++++-- 1 file changed, 17 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ebab3a5b..944e0dd1 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,8 @@ This repository assembles OpenTelemetry Collector distributions, such as the "co Each distribution contains: -- Binaries for a multitude of platforms and architectures -- Multi-arch container images (x86_64, 386, arm, arm64 and ppc64le) +- Binaries for a multitude of platforms and architectures (at least linux_amd64, linux_arm64, windows_amd64 and darwin_arm64) +- Multi-arch container images (at least amd64 and arm64) - Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) More details about each individual distribution can be seen in its own readme files. @@ -16,3 +16,18 @@ Current list of distributions: - [OpenTelemetry Collector (also known as "otelcol")](./distributions/otelcol) - [OpenTelemetry Collector Contrib (also known as "otelcol-contrib")](./distributions/otelcol-contrib) + +## Criteria for Distributions + +- To honor commitments made by OpenTelemetry to other Open Source projects the Collector SIG should support at least 1 distribution that includes support for Prometheus, Jaeger, Zipkin, and OpenCensus. +- Distributions supported by the Collector SIG should serve a specific purpose and those purposes should have minimal overlap. +- Distributions supported by the Collector SIG should meet general needs and not be too niche. +- Distributions supported by the Collector SIG should only target the needs of the OpenTelemetry project. +- Distributions supported by the Collector SIG are not required to be production ready and may be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG considers it to be production ready. +- Distributions supported by the Collector SIG must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories. +- Distributions supported by the Collector SIG should have a clearly defined list of criteria for which components are included. +- Distributions supported by the Collector 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: + - 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. + From 3e27e05f9b65a555b7f569c3dfe688fd1ba07d44 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 09:14:13 -0600 Subject: [PATCH 02/12] Add definition of support --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 944e0dd1..672d73a1 100644 --- a/README.md +++ b/README.md @@ -31,3 +31,4 @@ Current list of distributions: - linux_amd64 and linux_arm64 container images - Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) for each distributed binary. +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. From b85d5b6fee0173243d6e8ba80f2336d49fc63e24 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 11:09:15 -0600 Subject: [PATCH 03/12] Apply suggestions from code review Co-authored-by: Pablo Baeyens --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 672d73a1..6b7dcc5f 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Each distribution contains: - Binaries for a multitude of platforms and architectures (at least linux_amd64, linux_arm64, windows_amd64 and darwin_arm64) - Multi-arch container images (at least amd64 and arm64) -- Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) +- Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) for the above mentioned architectures More details about each individual distribution can be seen in its own readme files. @@ -26,7 +26,7 @@ Current list of distributions: - Distributions supported by the Collector SIG are not required to be production ready and may be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG considers it to be production ready. - Distributions supported by the Collector SIG must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories. - Distributions supported by the Collector SIG should have a clearly defined list of criteria for which components are included. -- Distributions supported by the Collector 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: +- Distributions supported by the Collector SIG 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: - 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. From 72937768d5410a87cb5e7d018bc0760859b3741e Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 11:23:41 -0600 Subject: [PATCH 04/12] Apply feedback --- README.md | 16 ---------------- distributions/README.md | 19 +++++++++++++++++++ 2 files changed, 19 insertions(+), 16 deletions(-) create mode 100644 distributions/README.md diff --git a/README.md b/README.md index 6b7dcc5f..93c77cce 100644 --- a/README.md +++ b/README.md @@ -16,19 +16,3 @@ Current list of distributions: - [OpenTelemetry Collector (also known as "otelcol")](./distributions/otelcol) - [OpenTelemetry Collector Contrib (also known as "otelcol-contrib")](./distributions/otelcol-contrib) - -## Criteria for Distributions - -- To honor commitments made by OpenTelemetry to other Open Source projects the Collector SIG should support at least 1 distribution that includes support for Prometheus, Jaeger, Zipkin, and OpenCensus. -- Distributions supported by the Collector SIG should serve a specific purpose and those purposes should have minimal overlap. -- Distributions supported by the Collector SIG should meet general needs and not be too niche. -- Distributions supported by the Collector SIG should only target the needs of the OpenTelemetry project. -- Distributions supported by the Collector SIG are not required to be production ready and may be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG considers it to be production ready. -- Distributions supported by the Collector SIG must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories. -- Distributions supported by the Collector SIG should have a clearly defined list of criteria for which components are included. -- Distributions supported by the Collector SIG 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: - - 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. - -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. diff --git a/distributions/README.md b/distributions/README.md new file mode 100644 index 00000000..c3874606 --- /dev/null +++ b/distributions/README.md @@ -0,0 +1,19 @@ +# Criteria for Supported Distributions + +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. + +Distributions supported by the Collector SIG should fulfill the following criteria: + +1. To honor commitments made by OpenTelemetry to other Open Source projects the Collector SIG should support at least 1 distribution that includes support for Prometheus, Jaeger, Zipkin, and OpenCensus. +2. Distributions supported by the Collector SIG should serve a specific purpose and those purposes should have minimal overlap. +3. Distributions supported by the Collector SIG should meet general needs and not be too niche. +4. Distributions supported by the Collector SIG should only target the needs of the OpenTelemetry project. +5. Distributions supported by the Collector SIG are not required to be production ready and may be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG considers it to be production ready. +6. Distributions supported by the Collector SIG must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories. +7. Distributions supported by the Collector SIG should have a clearly defined list of criteria for which components are included. +8. Distributions supported by the Collector SIG 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: + - 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. + + From 8c6c263546b47f1178563297f0c9084c133a39da Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 11:26:51 -0600 Subject: [PATCH 05/12] Update wording --- distributions/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/distributions/README.md b/distributions/README.md index c3874606..53197da4 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -4,14 +4,14 @@ Support for a distribution implies all the duties covered by the Approver and Ma Distributions supported by the Collector SIG should fulfill the following criteria: -1. To honor commitments made by OpenTelemetry to other Open Source projects the Collector SIG should support at least 1 distribution that includes support for Prometheus, Jaeger, Zipkin, and OpenCensus. -2. Distributions supported by the Collector SIG should serve a specific purpose and those purposes should have minimal overlap. -3. Distributions supported by the Collector SIG should meet general needs and not be too niche. -4. Distributions supported by the Collector SIG should only target the needs of the OpenTelemetry project. -5. Distributions supported by the Collector SIG are not required to be production ready and may be focused on development and proof of concept use cases. The distribution should clearly indicate whether the Collector SIG considers it to be production ready. -6. Distributions supported by the Collector SIG must only include components from the `opentelemetry-collector` and `opentelemetry-collector-contrib` repositories. -7. Distributions supported by the Collector SIG should have a clearly defined list of criteria for which components are included. -8. Distributions supported by the Collector SIG 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. Support at least 1 distribution that 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: - 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. From ddaf75c796786bc408eed05735a6de75f61a4b3c Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 11:31:02 -0600 Subject: [PATCH 06/12] Typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 93c77cce..ec4dc033 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Each distribution contains: - Binaries for a multitude of platforms and architectures (at least linux_amd64, linux_arm64, windows_amd64 and darwin_arm64) - Multi-arch container images (at least amd64 and arm64) -- Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) for the above mentioned architectures +- Packages to be used with Linux distributions (apk, RPM, deb), Mac OS (brew) for the above-mentioned architectures More details about each individual distribution can be seen in its own readme files. From 8f55c0d6477b0455419e027c96db509bc92da846 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Wed, 26 Jul 2023 12:32:20 -0600 Subject: [PATCH 07/12] Add `recommended for production` criteria to 1. --- distributions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/distributions/README.md b/distributions/README.md index 53197da4..bda4871f 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -4,7 +4,7 @@ Support for a distribution implies all the duties covered by the Approver and Ma Distributions supported by the Collector SIG should fulfill the following criteria: -1. Support at least 1 distribution that includes support for Prometheus, Jaeger, Zipkin, and OpenCensus. +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. From 7c6c6bc76ac4a78f731e6ce28763ecbb88131eea Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Thu, 27 Jul 2023 15:22:33 -0600 Subject: [PATCH 08/12] Apply feedback --- distributions/README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/distributions/README.md b/distributions/README.md index bda4871f..8ff20fdb 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -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. + 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. +2. Meet general needs and not be too niche. +3. Only target the needs of the OpenTelemetry project. +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. +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. +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: - 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. From 081801e372b7f8c8f08f7588d2a5c43162e08ab1 Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Thu, 3 Aug 2023 09:22:15 -0600 Subject: [PATCH 09/12] Apply suggestions from code review Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com> --- distributions/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/distributions/README.md b/distributions/README.md index 8ff20fdb..da158f73 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -2,17 +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. +The Collector SIG will support at least one distribution that is recommended for production which includes support for Prometheus, Jaeger, Zipkin, and OpenCensus. Distributions supported by the Collector SIG should fulfill the following criteria: -1. Serve a specific purpose and those purposes should have minimal overlap. +1. Serve a specific purpose that has minimal overlap with the purpose of any other distribution. 2. Meet general needs and not be too niche. 3. Only target the needs of the OpenTelemetry project. -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. +4. May be focused on development or proof of concept use cases. The distribution should clearly indicate whether the Collector SIG recommends the distribution be used in production environments. 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. -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: +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 assets may be included if the distro desires: - 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. From 2725075876dea3728e30647cda531d90654b4f4a Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Thu, 3 Aug 2023 10:18:27 -0600 Subject: [PATCH 10/12] Apply feedback --- distributions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/distributions/README.md b/distributions/README.md index da158f73..63dc82c9 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -12,7 +12,7 @@ Distributions supported by the Collector SIG should fulfill the following criter 4. May be focused on development or proof of concept use cases. The distribution should clearly indicate whether the Collector SIG recommends the distribution be used in production environments. 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. -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 assets may be included if the distro desires: +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 assets may be included if the maintainers agree: - 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. From 4512f7561322e36903e3eaeb15a4481ba611b2fe Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Fri, 4 Aug 2023 10:31:38 -0600 Subject: [PATCH 11/12] Adjust rules 2 and 3 --- distributions/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/distributions/README.md b/distributions/README.md index 63dc82c9..3530216f 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -7,8 +7,8 @@ The Collector SIG will support at least one distribution that is recommended for Distributions supported by the Collector SIG should fulfill the following criteria: 1. Serve a specific purpose that has minimal overlap with the purpose of any other distribution. -2. Meet general needs and not be too niche. -3. Only target the needs of the OpenTelemetry project. +2. Should meet general needs and be desired by many users. +3. Should not be specific to any vendor. 4. May be focused on development or proof of concept use cases. The distribution should clearly indicate whether the Collector SIG recommends the distribution be used in production environments. 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. From d7803b7d22eebc00f5bf679e258e34ebd56b8f0d Mon Sep 17 00:00:00 2001 From: Tyler Helmuth <12352919+TylerHelmuth@users.noreply.github.com> Date: Tue, 8 Aug 2023 09:12:59 -0600 Subject: [PATCH 12/12] Update distributions/README.md Co-authored-by: Evan Bradley <11745660+evan-bradley@users.noreply.github.com> --- distributions/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/distributions/README.md b/distributions/README.md index 3530216f..9d647afe 100644 --- a/distributions/README.md +++ b/distributions/README.md @@ -15,6 +15,6 @@ Distributions supported by the Collector SIG should fulfill the following criter 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 assets may be included if the maintainers agree: - 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. + - Packages to be used with Linux distributions (apk, RPM, deb), macOS (brew) for each distributed binary.