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.

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

Doc update to introduce Tiered Platform Support Model #8224

Merged
merged 19 commits into from
Sep 25, 2023

Conversation

rrschulze
Copy link
Contributor

Description: This PR adds documentation to introduce a tiered platform support model for the OpenTelemetry Collector. The tiered platform support model provides clarity to the project and its users about how existing platforms are supported today and how requests for new platforms can be supported in future, while balancing between the aim to support as many platforms as possible and to guarantee stability for the most important platforms.

Link to tracking Issue: #8209

@rrschulze rrschulze requested review from a team and dmitryax August 13, 2023 20:06
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Aug 13, 2023

CLA Not Signed

Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up! I did a first review; will be out for a couple weeks and take this back when I return :)

docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Show resolved Hide resolved
- Kubernetes arm64, i386, arm/v7 and ppc64le
- Docker amd64, arm64, i386, arm/v7 and ppc64le

The proposed additional platforms Linux on s390x (#378) and AIX on ppc64 ([#19195](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/19195#issuecomment-1458560971)) will be included into Tier 3 once they're added to the OpenTelemetry Collector as platforms.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
The proposed additional platforms Linux on s390x (#378) and AIX on ppc64 ([#19195](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/19195#issuecomment-1458560971)) will be included into Tier 3 once they're added to the OpenTelemetry Collector as platforms.
The proposed additional platforms Linux on s390x ([#378](https://github.com/open-telemetry/opentelemetry-collector-releases/issues/378#issuecomment-1662371014)) and AIX on ppc64 ([#19195](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues/19195#issuecomment-1458560971)) will be included into Tier 3 once they're added to the OpenTelemetry Collector as platforms.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Instead of linking to specific issue comments here, it is sufficient to link to the related issues. I will update the link for AIX on ppc64.

docs/platform-support.md Outdated Show resolved Hide resolved
@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 14 days.

@github-actions github-actions bot added the Stale label Sep 15, 2023
@mx-psi mx-psi removed the Stale label Sep 15, 2023
@codecov
Copy link

codecov bot commented Sep 18, 2023

Codecov Report

Patch has no changes to coverable lines.

📢 Thoughts on this report? Let us know!.

@mx-psi mx-psi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Sep 21, 2023
Copy link
Member

@mx-psi mx-psi left a comment

Choose a reason for hiding this comment

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

Looks good to me, just one suggestion about formatting. Thanks for your hard work on this @rrschulze!!

docs/platform-support.md Outdated Show resolved Hide resolved
Copy link
Contributor

@codeboten codeboten left a comment

Choose a reason for hiding this comment

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

Thanks for the writeup! Only a few comments.

docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Outdated Show resolved Hide resolved
docs/platform-support.md Show resolved Hide resolved
Removed the listing of specific platforms for container images and added reference to goreleaser configuration.
@codeboten codeboten merged commit ec3570d into open-telemetry:main Sep 25, 2023
31 checks passed
@github-actions github-actions bot added this to the next release milestone Sep 25, 2023
@mx-psi mx-psi mentioned this pull request Sep 26, 2023
7 tasks
@yurishkuro
Copy link
Member

Q: what happens when a tier-3 platform build starts failing? Is the release process already resilient enough to such failures to ensure that the other platforms are still released?

@mx-psi
Copy link
Member

mx-psi commented Nov 29, 2023

Q: what happens when a tier-3 platform build starts failing? Is the release process already resilient enough to such failures to ensure that the other platforms are still released?

@yurishkuro Right now it would make the build fail, but it would be easy enough to temporarily exclude a particular platform from the build with a small PR that we can later revert. Maybe we can make it easier, if you have concrete ideas please file an issue :)

In any case IMO this text should be read as a guide to make decisions (what to do when we have a question such as "should we delay the release because of a problem specific to platform X?") than as a prescription on what our release pipeline should look like.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants