From 540fca4f8f7fbb7480139f83d0bbe425bb17693f Mon Sep 17 00:00:00 2001 From: Szilard Parrag Date: Thu, 15 Feb 2024 09:44:31 +0100 Subject: [PATCH 1/2] docs: update README Signed-off-by: Szilard Parrag --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0e2a874e..b2c0a374 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,12 @@ # Axoflow Distribution for OpenTelemetry Collector -This repository assembles OpenTelemetry Collector distributions, such as the "core" distribution, or "contrib". It may contain non-official distributions, focused on specific use-cases, such as the load-balancer. +This repository assembles Axoflow Distribution for OpenTelemetry Collector. -Each distribution contains: +The distribution contains: -- Binaries for a multitude of platforms and architectures (at least linux_amd64, linux_arm64, windows_amd64 and darwin_arm64) +- Binaries for linux_amd64 and linux_arm64 - Multi-arch container images (at least amd64 and arm64) -More details about each individual distribution can be seen in its own readme files. - Current list of distributions: - [Axoflow Distribution for OpenTelemetry Collector (also known as "axoflow-otel-collector")](./distributions/otelcol-contrib) From d8318a1a49dbdbf2144e3eb782a26a8eeef57375 Mon Sep 17 00:00:00 2001 From: Szilard Parrag Date: Thu, 15 Feb 2024 09:45:26 +0100 Subject: [PATCH 2/2] docs: remove distributions/README Signed-off-by: Szilard Parrag --- README.md | 4 ---- distributions/README.md | 21 --------------------- 2 files changed, 25 deletions(-) delete mode 100644 distributions/README.md diff --git a/README.md b/README.md index b2c0a374..528acb19 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,3 @@ The distribution contains: - Binaries for linux_amd64 and linux_arm64 - Multi-arch container images (at least amd64 and arm64) - -Current list of distributions: - -- [Axoflow Distribution for OpenTelemetry Collector (also known as "axoflow-otel-collector")](./distributions/otelcol-contrib) diff --git a/distributions/README.md b/distributions/README.md deleted file mode 100644 index 6a3871de..00000000 --- a/distributions/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# 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. - -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 that has minimal overlap with the purpose of any other distribution. -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. - - Components that are marked [Unmaintained](https://github.com/open-telemetry/opentelemetry-collector#unmaintained) will be kept in any distributions for six months. After six months of being unmaintained the component will be removed from the distributions. -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 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), macOS (brew) for each distributed binary. - -