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

Added marking add-ons as deprecated #949

Merged
merged 21 commits into from
Apr 11, 2023
Merged

Conversation

kyleprice
Copy link
Contributor

No description provided.

@github-actions
Copy link

github-actions bot commented Mar 23, 2023

@github-actions github-actions bot temporarily deployed to preview March 23, 2023 19:13 Inactive
@github-actions github-actions bot temporarily deployed to preview March 23, 2023 19:27 Inactive
@github-actions github-actions bot temporarily deployed to preview March 23, 2023 19:41 Inactive
@github-actions github-actions bot temporarily deployed to preview March 23, 2023 20:17 Inactive
@kyleprice kyleprice added type::docs Improvements or additions to documentation type::feature New feature or request labels Mar 23, 2023
@github-actions github-actions bot temporarily deployed to preview March 23, 2023 21:24 Inactive
@kyleprice kyleprice marked this pull request as ready for review March 23, 2023 21:25
@kyleprice kyleprice requested a review from a team as a code owner March 23, 2023 21:25
@github-actions github-actions bot temporarily deployed to preview March 23, 2023 22:52 Inactive
Copy link
Member

@AmberAlston AmberAlston left a comment

Choose a reason for hiding this comment

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

Lots of comments. Let me know if you want to discuss any of them in more depth outside of async comments.

Visuals/Content:

  • The Deprecated label is really hard to read unless you’re on a high-res monitor. Maybe it’s the length of the word or the color. We could try using the existing beta red.
  • Why are we stating the start date for deprecation (March 23) on some of the add-ons but not others?
  • Why is Antrea June 1, and AWS is May 1. Latter is beta, but both don’t appear to have any usage
  • How did we reach the date of Sept 1 for the others? That’s approx 5mo. Is that enough time for an add-on like Weave, which is highly used today?
  • For Weave specifically we should say something in the deprecation notice about the upstream maintainers no longer maintaining the project, and as such we can no longer maintain it as a viable CNI add-on for KURL.
  • For Docker specifically we should highlight that “Kubernetes no longer supports Docker as of 1.24, and therefore any in-support versions of Kubernetes must leverage ContainerD”. That way is reinforces that this isn’t our decision. We say something similar later, but it should be in the deprecation notice.
  • We need to change this language in the messages, “Support for existing installs will continue to be best effort.”, it sounds like we’re abandoning our support responsibilities. I’d suggest something like, “Existing installs that use this add-on will continue to be best-effort supported until the deprecation date.” Are we continuing to patch these add-ons during this window? That answer may drive some additional copy tweaks

Other related changes needed:

Non-code complimentary work to address before this is merged:

  • What are we doing to proactively communicate this deprecation to vendors using Longhorn, Docker, and Weave. I don’t want them to stumble across the deprecation notices on the website and ask us about it. These needs to be paired with a formalized announcement to vendors impacted by these changes to let them know: (1) about the deprecation, (2) how they can move forward
  • We also need to let the field facings teams (Sales, SE, CRE) know ahead of pushing this change live, so they are prepared for possible questions.

@github-actions github-actions bot temporarily deployed to preview March 24, 2023 21:55 Inactive

### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st, 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [OpenEBS](https://kurl.sh/docs/add-ons/openebs) or [Rook](https://kurl.sh/docs/add-ons/rook) add-on for your CSI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/install-with-kurl/migrating-csi).
Copy link
Contributor

Choose a reason for hiding this comment

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

What fully vs partial deprecated does means?
It seems that you want say it is deprecated now and at September 31st goes in EOL.

Copy link
Member

Choose a reason for hiding this comment

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

Can we use the term remove rather than deprecate?

Copy link
Member

@AmberAlston AmberAlston left a comment

Choose a reason for hiding this comment

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

Updated comments below

  • Re-reading this again today, I’d suggest we tweak the main deprecation copy as follows. This would help address Camila’s feedback as well.
    • As of March 27, 2023, kURL no longer intends to continue to offer this add-on as part of the ongoing kURL project. This add-on is now considered deprecated, and may no longer be offered by the project after (DATE). Existing installs that use this add-on will be best effort supported during this deprecation window. (MIGRATION GUIDANCE & ANY OTHER INFO)
  • I didn’t get an answer on my question about patching updates during this deprecation window or not. That answer may drive some additional copy tweaks.
  • Docker - I’d still like to see a reference to the K8s incompatibility within the deprecation notice itself. That way it’s clearer this isn’t our decision, it’s deprecated by virtue of K8s moving on from it.
  • It looks like the reference to longhorn was corrected in the "latest" link, but not https://kurl.sh/docs/install-with-kurl/#latest
  • IPv6- I feel like we should just remove the page. It’s in alpha, and we’re not aware of any one using it. By marking it as deprecated we risk implying that we’ve decided we don’t intend to support IPv6 at all. In actuality, we want signals that people want this so we can consider it with Flannel. Marking as deprecated may discourage that signal. If we remove we should include in the SE notification portion of my “Non-code complimentary work to address before this is merged” part of my prior comment.


### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after June 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [Flannel](https://kurl.sh/docs/add-ons/flannel) for your CNI needs moving forward.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after June 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [Flannel](https://kurl.sh/docs/add-ons/flannel) for your CNI needs moving forward.
kURL will not be moving forward with support of this add-on starting March 23, 2023 and will be fully removed after June 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the removal date. Please consider using the [Flannel](https://kurl.sh/docs/add-ons/flannel) add-on for your CNI needs moving forward.


### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after April 31st 2023.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after April 31st 2023.
kURL will not be moving forward with support of this add-on starting March 23, 2023 and will be fully removed after April 31st 2023.


### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. To migrate to [Containerd](https://kurl.sh/docs/add-ons/containerd) please change your kURL spec to containerd to migrate existing installs.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. To migrate to [Containerd](https://kurl.sh/docs/add-ons/containerd) please change your kURL spec to containerd to migrate existing installs.
kURL will not be moving forward with support of this add-on starting March 23, 2023 and will be fully removed after September 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the removal date. Please remove Docker from your spec and replace it with [Containerd](https://kurl.sh/docs/add-ons/containerd) to migrate existing installs.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Took the 2nd part and added it to the add-on page. I used Amber's wording for the first part around removal/support.

Docker is a CRI (Container Runtime Interface).
If Docker is not used, an alternative CRI must be used in its place.
See [containerd documentation](/docs/add-ons/containerd) for more information.

Kubenetes 1.24.0+ does not support Dockershim, therefore you must use an alternative CRI, such as [containerd](/docs/add-ons/containerd), instead.
Kubenetes 1.24.0+ does not support Dockershim. As a result of this, therefore you must use an alternative CRI, such as [containerd](/docs/add-ons/containerd), instead.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Kubenetes 1.24.0+ does not support Dockershim. As a result of this, therefore you must use an alternative CRI, such as [containerd](/docs/add-ons/containerd), instead.
Kubenetes 1.24.0+ no loner supports Dockershim, therefore you must use an alternative CRI such as [containerd](/docs/add-ons/containerd).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Move this to the deprecation section


### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st, 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [OpenEBS](https://kurl.sh/docs/add-ons/openebs) or [Rook](https://kurl.sh/docs/add-ons/rook) add-on for your CSI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/install-with-kurl/migrating-csi).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st, 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [OpenEBS](https://kurl.sh/docs/add-ons/openebs) or [Rook](https://kurl.sh/docs/add-ons/rook) add-on for your CSI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/install-with-kurl/migrating-csi).
kURL will not be moving forward with support of this add-on starting March 23, 2023 and will be fully removed after September 31st, 2023. Existing installs that use this add-on will continue to be best-effort supported until the removal date. Please consider using the [OpenEBS](https://kurl.sh/docs/add-ons/openebs) or [Rook](https://kurl.sh/docs/add-ons/rook) add-on for your CSI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/install-with-kurl/migrating-csi).


### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st, 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [OpenEBS](https://kurl.sh/docs/add-ons/openebs) or [Rook](https://kurl.sh/docs/add-ons/rook) add-on for your CSI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/install-with-kurl/migrating-csi).
Copy link
Member

Choose a reason for hiding this comment

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

Can we use the term remove rather than deprecate?


### This add-on is deprecated.

kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st 2023. This add-on is no longer supported by the upstream maintainers. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [Flannel](https://kurl.sh/docs/add-ons/flannel) for your CNI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/add-ons/flannel#migration-from-weave).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
kURL will not be moving forward with support of this add-on in kURL starting March 23, 2023 and will be fully deprecated after September 31st 2023. This add-on is no longer supported by the upstream maintainers. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. Please consider using the [Flannel](https://kurl.sh/docs/add-ons/flannel) for your CNI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/add-ons/flannel#migration-from-weave).
kURL will not be moving forward with support of this add-on starting March 23, 2023 and will be fully removed after September 31st 2023. This add-on is no longer supported by the upstream maintainers. Existing installs that use this add-on will continue to be best-effort supported until the removal date. Please consider using the [Flannel](https://kurl.sh/docs/add-ons/flannel) add-on for your CNI needs moving forward. We offer a migration path for existing customer installs as described [here](https://kurl.sh/docs/add-ons/flannel#migration-from-weave).


### This feature is deprecated.

kURL will not be moving forward with support of ipv6 in kURL starting March 23, 2023 and will be fully deprecated after June 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. This is due to the deprecation of the Antrea add-on.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
kURL will not be moving forward with support of ipv6 in kURL starting March 23, 2023 and will be fully deprecated after June 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the deprecation date. This is due to the deprecation of the Antrea add-on.
kURL will not be moving forward with support of ipv6 starting March 23, 2023 and will be fully removed after June 31st 2023. Existing installs that use this add-on will continue to be best-effort supported until the removal date. This is due to the deprecation of the Antrea add-on.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removed this page.

@github-actions github-actions bot temporarily deployed to preview March 28, 2023 14:36 Inactive
@github-actions github-actions bot temporarily deployed to preview March 28, 2023 15:31 Inactive
@github-actions github-actions bot temporarily deployed to preview April 10, 2023 14:59 Inactive
@AmberAlston
Copy link
Member

@replicatedhq/replicated-docs - I wanted to make sure you were aware of this pr since I don't see you in the review process yet. The team is planning to push it live in the next couple of days. I have been involved in the review so far on wording, etc.

@paigecalvert
Copy link
Contributor

Thanks @AmberAlston ! @kyleprice , let us know when/if it would be helpful to have a docs review on the language.

@github-actions github-actions bot temporarily deployed to preview April 11, 2023 19:27 Inactive

### This add-on is deprecated.

As of March 27, 2023, the Antrea add-on is deprecated. The Antrea add-on is scheduled to be removed from kURL after June 31st, 2023. Existing installations that use the Antrea add-on are supported during this deprecation window. We recommend that you remove the Antrea add-on and instead use the [Flannel](https://kurl.sh/docs/add-ons/flannel) add-on on or before June 31st, 2023.
Copy link
Contributor

@paigecalvert paigecalvert Apr 11, 2023

Choose a reason for hiding this comment

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

@kyleprice before I review any other notices (which I think are all very similar/the same), could you let me know what you think of these edits? I wanted to cut down on the number of words, and also try to clarify phrases like "may no longer be offered by the project".

A couple questions for you:

  • "may no longer be offered by the project" --> does this mean that you all are removing it? Would it make sense to say "scheduled to be removed", or maybe "tentatively scheduled to be removed"?
  • "after June 31st, 2023" --> does this mean you all are planning to remove it on July 1? Or just anytime after June 31st is fair play?
  • "will be best effort supported" --> is it okay to just say that it's supported? or is there a way to clarify what "best effort" includes/excludes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pretty much we would like to have the option to remove it after x date. We aren't sure if we will remove it or not at the moment but we want to make sure people know its a possibility.

Anytime after June 31st would be fair. We will initially just remove it from the website though after that date.

We can just say it is supported until that date.

@github-actions github-actions bot temporarily deployed to preview April 11, 2023 19:49 Inactive
@github-actions github-actions bot temporarily deployed to preview April 11, 2023 19:56 Inactive
@github-actions github-actions bot temporarily deployed to preview April 11, 2023 20:11 Inactive
@github-actions github-actions bot temporarily deployed to preview April 11, 2023 20:16 Inactive
@github-actions github-actions bot temporarily deployed to preview April 11, 2023 20:30 Inactive
paigecalvert
paigecalvert previously approved these changes Apr 11, 2023
Copy link
Contributor

@paigecalvert paigecalvert left a comment

Choose a reason for hiding this comment

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

done with docs edits @kyleprice !

rrpolanco
rrpolanco previously approved these changes Apr 11, 2023
@kyleprice kyleprice dismissed stale reviews from rrpolanco and paigecalvert via c3acdf1 April 11, 2023 20:45
@github-actions github-actions bot temporarily deployed to preview April 11, 2023 20:48 Inactive
@kyleprice kyleprice merged commit 228ffe1 into main Apr 11, 2023
@kyleprice kyleprice deleted the kyle/add-addon-deprecation branch April 11, 2023 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type::docs Improvements or additions to documentation type::feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants