upcoming: [M3-8960] - Update Kubernetes version upgrade components for LKE-E by mjac0bs · Pull Request #11415 · linode/manager

mjac0bs · 2024-12-12T22:28:16Z

Description 📝

With the addition of tiered versions, components that use the current useKubernetesVersionQuery to fetch all (standard)/versions need to be updated to use the new useKubernetesTieredVersionsQuery, which supports k8 versions for both existing standard and new enterprise tiers. This change will prevent the UI from recommending incorrect and incompatible version upgrades to clusters.

Changes 🔄

Adds a new hook useLkeStandardOrEnterpriseVersions to return the correct version data from queries and reduce duplicate logic until we're in GA
- Uses hooks in version upgrade components and on the cluster create flow for version selection
Adds test coverage
- For kubeUtil functions related to versions
- For lke-upgrade.spec.ts to confirm enterprise versions can be upgraded

Preview 📷

Before	After

How to test 🧪

Prerequisites

(How to setup test environment)

Have the customer tag for LKE-E on your account (see project tracker)
Create an LKE-E cluster

Reproduction steps

(How to reproduce the issue, if applicable)

On the develop branch, navigate to the Kubernetes landing page and observe that there is an 'Upgrade' chip on your LKE-E cluster, and clicking it recommends an incorrect upgrade version
Visit the LKE-E cluster's details page observe that the upgrade banner is displayed, recommending an incorrect upgrade version
Click on the Upgrade button in the banner and observe that an incorrect upgrade version is displayed

Verification steps

(How to verify changes)

On this branch, navigate to the Kubernetes landing page and observe that there is not an Upgrade chip for the LKE-E cluster because it's on the latest enterprise version
Visit the LKE-E cluster's details page observe that no upgrade banner is displayed because it's on the latest enterprise version
Confirm test coverage looks good and related tests pass:

yarn test kubeUtils

yarn cy:run -s "cypress/e2e/core/kubernetes/lke-create.spec.ts,cypress/e2e/core/kubernetes/lke-update.spec.ts"

Author Checklists

As an Author, to speed up the review process, I considered 🤔

👀 Doing a self review
❔ Our contribution guidelines
🤏 Splitting feature into small PRs
➕ Adding a changeset
🧪 Providing/improving test coverage
🔐 Removing all sensitive information from the code and PR description
🚩 Using a feature flag to protect the release
👣 Providing comprehensive reproduction steps
📑 Providing or updating our documentation
🕛 Scheduling a pair reviewing session
📱 Providing mobile support
♿ Providing accessibility support

I have read and considered all applicable items listed above.

As an Author, before moving this PR from Draft to Open, I confirmed ✅

All unit tests are passing
TypeScript compilation succeeded without errors
Code passes all linting rules

mjac0bs · 2024-12-13T16:40:13Z

  });

-  if (typesError || regionsError || versionLoadError) {
+  if (typesError || regionsError || versionsError) {


Updates with error and loading variables were just to update to the values returned from the hook.

Now the tiered version query is disabled when the LKE-E feature is disabled (and isFetching will be false), so we shouldn't need to check isLkeEnterpriseLAFeatureEnabled && enterpriseTierVersionDataIsLoading.

mjac0bs · 2024-12-13T16:49:15Z


  const region = regions?.find((r) => r.id === cluster.region);

+  const { versions } = useLkeStandardOrEnterpriseVersions(


We default to standard if the tier is undefined (LKE-E feature not enabled) because all current clusters are 'standard'.

mjac0bs · 2024-12-13T16:51:41Z

-   * If LKE-E is disabled, use the data from the existing /versions endpoint.
-   * @todo LKE-E: Clean up use of versionData once LKE-E is in GA.
-   */
-  const versionData =


This logic was moved inside useLkeStandardOrEnterpriseVersions.

mjac0bs · 2024-12-13T16:57:36Z

    });
  });
+
+  describe('getNextVersion', () => {


Added test coverage for this previously untested function since the upgrade dialog uses it.

mjac0bs · 2024-12-13T16:59:25Z

-        capabilities: [],
-      },
+describe('hooks', () => {
+  describe('useIsLkeEnterpriseEnabled', () => {


Lines 241-308 (tests for useIsLkeEnterpriseEnabled) are not new, I just wrapped these tests in a describe('hooks'... so they're in the diff.

What is new are the tests for useLkeStandardOrEnterpriseVersions.

github-actions · 2024-12-13T17:35:25Z

Coverage Report: ✅
Base Coverage: 86.98%
Current Coverage: 86.98%

hana-akamai

Functionality is looking good!

hana-akamai · 2024-12-13T21:20:32Z

+      const oldVersion = '1.31.1+lke1';
+      const newVersion = '1.31.1+lke2';


Are new LKE-E versions denoted by a higher number after lke or the "base" standard version number?

Both? Versioning is what confuses me the most right now, tbh.

The LKE folks said earier:

LKE-E exposes the patch version, and an overall "lke" version, so the customer is able to specifically choose when to include any upgrade of any component. in both LKE and LKE-E only the "latest" version of each kubernetes minor version is available. In other words, if 1.31.1+lke1 is installed, and then 1.31.2+lke1 comes out. New installs can only choose 1.31.2+lke1, not any arbitrary version

So there are still minor version increases, and patch increases, and then there's this new(ly exposed?) "lke" version and that can change too.

And from some LKE-E docs:

Only one patch version per minor version will be supported at any point in time. For example, at a point in time, the following would be the supported versions “v1.29.8-lke1”, “v1.30.2-lke2”, “v1.31.1-lke1”. Customers will be notified and prompted in Cloud Manager when there is a new patch version available. For example, a customer who created a cluster with ““v1.30.1-lke1” would be notified when ““v1.30.1-lke2” or “v1.30.2-lke2”” is available.

I think that last part is consistent with the test spec here. We have a patch version that gets a new lke version, so that is considered the latest patch to update to.

jdamore-linode

Looks good @mjac0bs! Thanks for the tests!

jdamore-linode · 2024-12-13T21:07:13Z

+export const kubernetesStandardTierVersionFactory = Factory.Sync.makeFactory<KubernetesTieredVersion>(
+  {
+    id: '1.31',
+    tier: 'standard',
+  }
+);
+
+export const kubernetesEnterpriseTierVersionFactory = Factory.Sync.makeFactory<KubernetesTieredVersion>(
+  {
+    id: 'v1.31.1+lke1',
+    tier: 'enterprise',
+  }
+);


Would it make any sense to use Factory.each((i) => ... on these IDs to let the values increment, or would it just complicate things / be inconsistent with the actual data?

Done in 0f35afa. 👍🏼 I incremented the minor version in the standard tier factory, and the patch in the enterprise tier factory. Tests continue to pass and I think this will be consistent enough with possible data/not overly complicated.

jdamore-linode · 2024-12-13T21:08:21Z

     * - Confirms that Kubernetes upgrade prompt is hidden when up-to-date.
     */
-    it('can upgrade kubernetes version from the details page', () => {
+    it('can upgrade standard kubernetes version from the details page', () => {


Thanks for adding this distinction! (+ the other test)

jdamore-linode · 2024-12-16T14:17:01Z

Any thoughts about unit tests to confirm that the Upgrade chip is present when a new LKE version is available and is absent when there is no new version? Don't think it needs to block this PR but might be good to have as a small standalone test ticket.

Good call out - yeah, let's do this in a standalone test ticket. It looks like the LKE landing page spec isn't testing version upgrades chip at all currently. I made M3-9023 and will get that done as part of this LKE-E epic!

harsh-akamai

PR looks good! Thanks @mjac0bs

…nents-for-lke-e

linode-gh-bot · 2024-12-17T16:58:02Z

Cloud Manager UI test results

🎉 468 passing tests on test run #7 ↗︎

❌ Failing	✅ Passing	↪️ Skipped	🕐 Duration
`0 Failing`	`468 Passing`	`2 Skipped`	`89m 8s`

cypress · 2024-12-17T18:25:32Z

Cloud Manager E2E Run #6982

Run Properties: Failed #6982 • d5fb831f1b: upcoming: [M3-8960] - Update Kubernetes version upgrade components for LKE-E (#1...

Project	`Cloud Manager E2E`
Branch Review	`develop`
Run status	`Failed #6982`
Run duration	`30m 13s`
Commit	`d5fb831f1b: upcoming: [M3-8960] - Update Kubernetes version upgrade components for LKE-E (#1...`
Committer	`Mariah Jacobs`
View all properties for this run ↗︎

Test results
Failures	`3`
Flaky	`0`
Pending	`2`
Skipped	`2`
Passing	`463`
View all changes introduced in this branch ↗︎

Tests for review

linodes/rebuild-linode.spec.ts • 2 failed tests

View Output Video

Test		Artifacts
rebuild linode > rebuilds a linode from Community StackScript		`Screenshots` `Video`
rebuild linode > rebuilds a linode from Account StackScript		`Screenshots` `Video`

objectStorage/object-storage.e2e.spec.ts • 1 failed test

View Output Video

Test		Artifacts
object storage end-to-end tests > can create and delete object storage buckets		`Screenshots` `Video`

…r LKE-E (linode#11415) * Make a hook because this is getting repetitive * Determine enterprise or standard versions with hook * Update versions type for util - need to test * Improve hook and use in cluster create flow * Move hook to kubeUtils * Add test coverage and factories * Clean up kubeUtils.test.ts * Add kubeUtils helper function test coverage for LKE-E * Update Cypress test coverage for enterprise version upgrades * Clean up * Added changeset: Update Kubernetes version upgrade components for LKE-E * Fix test failure by mocking the LKE-E capability needed * Update TODO * Address PR feedback: increment ids in tiered version factories

mjac0bs added Work in Progress LKE-Enterprise labels Dec 12, 2024

mjac0bs self-assigned this Dec 12, 2024

mjac0bs added 6 commits December 13, 2024 07:06

Make a hook because this is getting repetitive

29f4052

Determine enterprise or standard versions with hook

efb61c7

Update versions type for util - need to test

492a7ed

Improve hook and use in cluster create flow

26ee5e3

Move hook to kubeUtils

0ec7415

Add test coverage and factories

b2ab4fb

mjac0bs force-pushed the M3-8960-update-kube-version-upgrade-components-for-lke-e branch from 6db07ca to b2ab4fb Compare December 13, 2024 15:06

mjac0bs added 3 commits December 13, 2024 07:31

Clean up kubeUtils.test.ts

09d286a

Add kubeUtils helper function test coverage for LKE-E

d9a3600

Update Cypress test coverage for enterprise version upgrades

eb8e9b1

mjac0bs removed the Work in Progress label Dec 13, 2024

mjac0bs added 2 commits December 13, 2024 09:00

Clean up

a1d8be9

Added changeset: Update Kubernetes version upgrade components for LKE-E

8ea979e

mjac0bs marked this pull request as ready for review December 13, 2024 17:01

mjac0bs requested review from a team as code owners December 13, 2024 17:01

mjac0bs requested review from carrillo-erik, harsh-akamai and jdamore-linode and removed request for a team December 13, 2024 17:01

mjac0bs commented Dec 13, 2024

View reviewed changes

mjac0bs added the Ready for Review label Dec 13, 2024

mjac0bs requested a review from hana-akamai December 13, 2024 17:16

Fix test failure by mocking the LKE-E capability needed

7340553

hana-akamai reviewed Dec 13, 2024

View reviewed changes

Update TODO

1151b7b

hana-akamai approved these changes Dec 14, 2024

View reviewed changes

jdamore-linode approved these changes Dec 16, 2024

View reviewed changes

coliu-akamai added Approved Multiple approvals and ready to merge! and removed Ready for Review labels Dec 16, 2024

harsh-akamai approved these changes Dec 17, 2024

View reviewed changes

mjac0bs added 2 commits December 17, 2024 08:18

Address PR feedback: increment ids in tiered version factories

0f35afa

Merge branch 'develop' into M3-8960-update-kube-version-upgrade-compo…

9077ebc

…nents-for-lke-e

mjac0bs merged commit d5fb831 into linode:develop Dec 17, 2024

This was referenced Jan 8, 2025

Release v1.134.0 - release → staging #11494

Closed

Release v1.134.0 - release → staging #11497

Merged

hana-akamai mentioned this pull request Jan 9, 2025

Release v1.134.0 - release → staging #11503

Merged

jaalah-akamai mentioned this pull request Jan 14, 2025

Release v1.134.0 - staging → master #11519

Merged


		const region = regions?.find((r) => r.id === cluster.region);

		const { versions } = useLkeStandardOrEnterpriseVersions(

		const oldVersion = '1.31.1+lke1';
		const newVersion = '1.31.1+lke2';

Uh oh!

Conversation

mjac0bs commented Dec 12, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description 📝

Changes 🔄

Preview 📷

How to test 🧪

Prerequisites

Reproduction steps

Verification steps

As an Author, to speed up the review process, I considered 🤔

As an Author, before moving this PR from Draft to Open, I confirmed ✅

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented Dec 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hana-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jdamore-linode left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mjac0bs Dec 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

harsh-akamai left a comment

Choose a reason for hiding this comment

Uh oh!

linode-gh-bot commented Dec 17, 2024

Cloud Manager UI test results

🎉 468 passing tests on test run #7 ↗︎

Uh oh!

cypress Bot commented Dec 17, 2024

Tests for review

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

mjac0bs commented Dec 12, 2024 •

edited

Loading

github-actions Bot commented Dec 13, 2024 •

edited

Loading

mjac0bs Dec 17, 2024 •

edited

Loading