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

Centralised Documentation of CNCF-Conformant Kubernetes Distribution Variations in Ports, Paths, and Components #48778

Open
developer1622 opened this issue Nov 20, 2024 · 3 comments
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs.

Comments

@developer1622
Copy link

What would you like to be added?

[existing, however] I propose creating a centralised section in the official Kubernetes documentation that provides a comprehensive table listing CNCF-conformant Kubernetes distributions.

The table should outline key details such as:

Ports used by critical components like etcd, kube-apiserver, and kubelet.
Default PKI certificate paths for each component.
Deviations from standard Kubernetes configurations, if any.

This table would act as a reference for understanding the variations in Kubernetes distributions and help teams build tools and solutions that cater to diverse environments.

Basically a overview of distro given by the distro owners how it deviates from upstream k8s.

Why is this needed?

Monitoring and observability solutions often need to support multiple Kubernetes distributions, each of which might have slight differences in configuration, such as:

Non-standard ports for components like etcd or kubelet(if any).
Different PKI certificate paths for authentication and encryption.
Variations in component behavior or configurations that deviate from upstream Kubernetes.

Currently, there is no centralized place to find these details. This leads to challenges for organizations and solution providers who need to support multiple distributions

By documenting these variations in a standardised table, we can:

Simplify the development and deployment of observability tools across diverse Kubernetes distributions.

Reduce the troubleshooting burden for users and vendors.

Promote transparency and a better understanding of Kubernetes environments.

This enhancement aligns with Kubernetes' ethos of being distribution-agnostic while acknowledging practical deviations in implementations

Thank you.

@developer1622 developer1622 added the kind/feature Categorizes issue or PR as related to a new feature. label Nov 20, 2024
@k8s-ci-robot
Copy link
Contributor

There are no sig labels on this issue. Please add an appropriate label by using one of the following commands:

  • /sig <group-name>
  • /wg <group-name>
  • /committee <group-name>

Please see the group list for a listing of the SIGs, working groups, and committees available.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. label Nov 20, 2024
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If a SIG or subproject determines this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Nov 20, 2024
@dims
Copy link
Member

dims commented Nov 20, 2024

/transfer website
/sig docs

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Nov 20, 2024
@k8s-ci-robot k8s-ci-robot transferred this issue from kubernetes/kubernetes Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/docs Categorizes an issue or PR as relevant to SIG Docs.
Projects
None yet
Development

No branches or pull requests

3 participants