upcoming: [M3-8881, M3-8885] - Add and update beta endpoints and queries for LKE-E #11302

mjac0bs · 2024-11-21T15:19:46Z

Description 📝

This PR supports the /v4beta endpoints and queries necessary for LKE-E.
(Except /regions, which will be done in M3-8884.)

Changes 🔄

Added two new types: KubernetesTieredVersion and KubernetesTier
Updated existing interfaces for CreateKubeClusterPayload and KubernetesCluster with new tier field
Added beta endpoints and queries for v4beta/lke/versions/{tier} and v4beta/lke/versions/{tier}/{versionId}, and v4beta/lke/clusters
Added/updated query keys for GET /clusters and GET /cluster functions to use the beta endpoint if LKE-E feature is enabled
No UI changes

Preview 📷

API Spec: POST /v4beta/lke/clusters

API Spec: GET /v4beta/lke/clusters

API Spec: GET /v4beta/lke/clusters/{clusterID}

API Spec: GET /v4beta/lke/versions/{tier}

API Spec: GET /v4beta/lke/versions/{tier}/{versionId}

How to test 🧪

Prerequisites

(How to setup test environment)

Add the LKE-E tag on your account (see 'LKE-Enterprise Project Tracker')
Or use the MSW Preset > Account > LKE-Enterprise Enabled

Verification steps

(How to verify changes)

Confirm there are no regressions when creating and getting a cluster with APL enabled.
Confirm the changes match the API spec (by viewing the spec in the Preview section above)
Everything else will be tested in the UI tickets to come.

As an Author, I have 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-11-21T16:48:27Z

packages/api-v4/src/kubernetes/types.ts

  apl_enabled?: boolean; // this is not the ideal solution, but a necessary compromise to prevent a lot of duplicated code.
+  /** Marked as 'optional' in this existing interface to prevent duplicated code for beta functionality, in line with the apl_enabled approach.
+   * @todo LKE-E - Make this field required once LKE-E is in GA. tier defaults to 'standard' in the API.
+   */
+  tier?: KubernetesTier;


Context for this is here.

packages/manager/src/queries/kubernetes.ts

github-actions · 2024-11-21T17:34:13Z

Coverage Report: ✅
Base Coverage: 86.81%
Current Coverage: 86.81%

packages/api-v4/src/kubernetes/kubernetes.ts

hkhalil-akamai · 2024-11-21T20:28:38Z

packages/api-v4/src/kubernetes/kubernetes.ts

+/** getKubernetesTieredVersion
+ *
+ * Returns a single tiered Kubernetes version by ID from the beta API.
+ *
+ */
+
+export const getKubernetesTieredVersion = (versionID: string) =>
+  Request<KubernetesTieredVersion>(
+    setMethod('GET'),
+    setURL(
+      `${BETA_API_ROOT}/lke/versions/:tier/${encodeURIComponent(versionID)}`
+    )
+  );


Struggling to understand the purpose of this endpoint... my understanding is that it just returns the same data from the request (the version and the tier)... will this change in the future?

This beta endpoint (which I should have named getKubernetesTieredVersionBeta, fixed this in last commit) returns a single version (which is now version id + tier). The other new beta endpoint (getKubernetesTieredVersionsBeta) returns multiple versions.

The existing endpoints (/versions/{versionId} and /versions) only return a version id (so only standard, e.g. current LKE versions), so in a sense they will be 'deprecated'.

Does that help any?

Edit: Yeah, after re-reading this comment "it just returns the same data from the request", you're right... and we also don't seem to use its older counterpart getKubernetesVersion anywhere in CM. Do we keep these in the apiv4 for completeness? (As to 'will this change the future' - not in any specs I've seen so far.)

I'm fine with keeping it in apiv4 for completeness

hana-akamai · 2024-11-21T20:50:44Z

packages/manager/src/queries/kubernetes.ts

+          useBetaEndpoint
+            ? getAllKubernetesClustersBeta()
+            : getAllKubernetesClusters(),
+        queryKey: [useBetaEndpoint],


Should the queryKey be a boolean?

It currently is a boolean - do you think it should be something else, like [useBetaEndpoint ? 'beta' : 'nonbeta']?

This was following a pattern that is already working for APL with the singular getKubernetesCluster endpoint (which we'd want to replicate here with getKubernetesClusters). My understanding is that we add something (boolean) to the query key to be able to switch between beta and non-beta endpoints and cache each response correctly.

Yeah, I think a string would make more sense and it would be easier from a quick glance looking at it from the React Query dev tools

As long as we make the change consistent across all query keys where we're toggling between endpoints, that sounds fine to me. (Unless I'm missing a particular reason that @bnussman-akamai chose a boolean.)

What's the correct term for "non-beta"? "public", "final"... just null? 'v4beta' and 'v4'?

I went with v4 and v4beta in 6f28d2a - lmk if you have any other suggestions or see anything unexpected with caching.

Account with the LKE-E customer tag and without being enrolled in APL beta Account without the LKE-customer tag and without being enrolled in APL beta

Nice. v4 and v4beta is a good idea. 🧠 I just picked the boolean earlier because it was quick and easy.

linode-gh-bot · 2024-11-21T23:51:51Z

Cloud Manager UI test results

🎉 454 passing tests on test run #5 ↗︎

❌ Failing	✅ Passing	↪️ Skipped	🕐 Duration
`0 Failing`	`454 Passing`	`2 Skipped`	`106m 1s`

hana-akamai

Confirm there are no regressions when creating and getting a cluster with APL enabled.
Confirm the changes match the API spec (by viewing the spec in the Preview section above)

mjac0bs added 3 commits November 21, 2024 07:17

Update types for LKE-E

a85f565

Update apiv4 endpoints for LKE-E

d17670e

Update queries to use LKE-E beta endpoints

3ee0263

mjac0bs added the LKE-Enterprise label Nov 21, 2024

mjac0bs self-assigned this Nov 21, 2024

mjac0bs marked this pull request as ready for review November 21, 2024 16:58

mjac0bs requested a review from a team as a code owner November 21, 2024 16:58

mjac0bs requested review from hkhalil-akamai and harsh-akamai and removed request for a team November 21, 2024 16:58

Add changesets

8f63c21

mjac0bs commented Nov 21, 2024

View reviewed changes

mjac0bs added the Ready for Review label Nov 21, 2024

mjac0bs requested a review from hana-akamai November 21, 2024 17:00

hkhalil-akamai reviewed Nov 21, 2024

View reviewed changes

packages/api-v4/src/kubernetes/kubernetes.ts Outdated Show resolved Hide resolved

hkhalil-akamai reviewed Nov 21, 2024

View reviewed changes

mjac0bs added 2 commits November 21, 2024 12:44

Address feedback: fix missing tier param in path

7dd9386

Add 'Beta' to endpoint name for consistency

5f3f047

hana-akamai reviewed Nov 21, 2024

View reviewed changes

mjac0bs added 3 commits November 21, 2024 12:55

Merge branch 'develop' into M3-8881-update-clusters-endpoints-for-lke-e

3f58b3b

Address feedback: use string for beta query key instead of boolean

6f28d2a

Merge branch 'develop' into M3-8881-update-clusters-endpoints-for-lke-e

198e959

hana-akamai approved these changes Nov 22, 2024

View reviewed changes

hana-akamai added the Add'tl Approval Needed Waiting on another approval! label Nov 22, 2024

bnussman-akamai approved these changes Nov 22, 2024

View reviewed changes

mjac0bs added Approved Multiple approvals and ready to merge! and removed Add'tl Approval Needed Waiting on another approval! Ready for Review labels Nov 22, 2024

mjac0bs merged commit 3ca4f1d into linode:develop Nov 22, 2024
23 checks passed

This was referenced Dec 5, 2024

Release v1.133.0 - release → staging #11377

Merged

Release v1.133.0 - staging → master #11378

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

upcoming: [M3-8881, M3-8885] - Add and update beta endpoints and queries for LKE-E #11302

upcoming: [M3-8881, M3-8885] - Add and update beta endpoints and queries for LKE-E #11302

mjac0bs commented Nov 21, 2024 •

edited

Loading

mjac0bs Nov 21, 2024

github-actions bot commented Nov 21, 2024 •

edited

Loading

hkhalil-akamai Nov 21, 2024

mjac0bs Nov 21, 2024 •

edited

Loading

hana-akamai Nov 22, 2024

hana-akamai Nov 21, 2024

mjac0bs Nov 21, 2024 •

edited

Loading

hana-akamai Nov 21, 2024

mjac0bs Nov 21, 2024 •

edited

Loading

mjac0bs Nov 21, 2024

bnussman-akamai Nov 22, 2024

linode-gh-bot commented Nov 21, 2024

hana-akamai left a comment

upcoming: [M3-8881, M3-8885] - Add and update beta endpoints and queries for LKE-E #11302

upcoming: [M3-8881, M3-8885] - Add and update beta endpoints and queries for LKE-E #11302

Conversation

mjac0bs commented Nov 21, 2024 • edited Loading

Description 📝

Changes 🔄

Preview 📷

How to test 🧪

Prerequisites

Verification steps

As an Author, I have considered 🤔

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

mjac0bs Nov 21, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 21, 2024 • edited Loading

hkhalil-akamai Nov 21, 2024

Choose a reason for hiding this comment

mjac0bs Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

hana-akamai Nov 22, 2024

Choose a reason for hiding this comment

hana-akamai Nov 21, 2024

Choose a reason for hiding this comment

mjac0bs Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

hana-akamai Nov 21, 2024

Choose a reason for hiding this comment

mjac0bs Nov 21, 2024 • edited Loading

Choose a reason for hiding this comment

mjac0bs Nov 21, 2024

Choose a reason for hiding this comment

bnussman-akamai Nov 22, 2024

Choose a reason for hiding this comment

linode-gh-bot commented Nov 21, 2024

Cloud Manager UI test results

🎉 454 passing tests on test run #5 ↗︎

hana-akamai left a comment

Choose a reason for hiding this comment

mjac0bs commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Nov 21, 2024 •

edited

Loading

mjac0bs Nov 21, 2024 •

edited

Loading

mjac0bs Nov 21, 2024 •

edited

Loading

mjac0bs Nov 21, 2024 •

edited

Loading