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

Define and document "experimental" features #741

Closed
dfarrell07 opened this issue Apr 12, 2022 · 6 comments
Closed

Define and document "experimental" features #741

dfarrell07 opened this issue Apr 12, 2022 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation priority:medium wontfix This will not be worked on

Comments

@dfarrell07
Copy link
Member

Better clarify for users which Submariner features are "experimental". This is useful for reducing unnecessary user surprise and providing an overall more clear set of expectations among users and devs.

Also better define the term "experimental" itself.
Also define how features can be added/removed from the experimental matrix.

Ideas for definitions of "experimental":

  • Features without active devs who would likely diagnose issues and fix them quickly.
  • "The project team accommodates these features in the code repositories, but the SLA for supporting them in cases of bugs or if the feature stops working entirely, is best effort" - @mkolesnik

Features that have been mentioned as potentially "experimental":

  • Helm
  • WireGuard
  • OVNKubernetes (trending less experimental)
  • LoadBalancer service mode (trending less experimental)

Ideas for adding/removing features from the experimental matrix:

  • Devs petition to adopt features to remove them from the experimental matrix. Anyone petitions to add features to the experimental matrix if they think the feature meets the definition of "experimental".
@dfarrell07 dfarrell07 added the documentation Improvements or additions to documentation label Apr 12, 2022
@dfarrell07 dfarrell07 self-assigned this Apr 12, 2022
@mkolesnik
Copy link
Contributor

Experimental features are not quite covered in CI, and if they are then such CI is non-blocking for merging PRs.

I see on the website external networks is explicitly documented as "experimental" so it should probably be on the list.

Also how about Calico CNI? We have docs on how to deploy with it, but we're not actively testing it.

Should we also mark some infra support experimental?

  • K3s ?
  • Rancher ?
  • GKE ?

@nyechiel
Copy link
Member

@dfarrell07 are you planning to work on this? I think we can still do it for 0.13, as docs should not be bound to the rc0 due-date.

@dfarrell07
Copy link
Member Author

Yeah this would be a good one to do as 0.13 stabilizes.

@stale
Copy link

stale bot commented Oct 16, 2022

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Oct 16, 2022
@dfarrell07 dfarrell07 added the help wanted Extra attention is needed label Oct 18, 2022
@stale stale bot removed the wontfix This will not be worked on label Oct 18, 2022
@stale
Copy link

stale bot commented Mar 18, 2023

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Mar 18, 2023
@dfarrell07 dfarrell07 removed the wontfix This will not be worked on label Mar 21, 2023
@dfarrell07 dfarrell07 moved this to Todo in Submariner 0.16 May 9, 2023
@dfarrell07 dfarrell07 removed the help wanted Extra attention is needed label May 9, 2023
@stale
Copy link

stale bot commented Sep 17, 2023

This issue has been automatically marked as stale because it has not had activity for 60 days. It will be closed if no further activity occurs. Please make a comment if this issue/pr is still valid. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Sep 17, 2023
@Jaanki Jaanki moved this to Todo in Submariner 0.17 Oct 5, 2023
@stale stale bot closed this as completed Oct 15, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in Submariner 0.17 Oct 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation priority:medium wontfix This will not be worked on
Projects
No open projects
Status: Done
Development

No branches or pull requests

4 participants