feat: Bump microcluster to v3 by HomayoonAlimohammadi · Pull Request #9 · canonical/k8sd

HomayoonAlimohammadi · 2026-01-29T07:14:30Z

Overview

This PR bumps Microcluster to v3. There were a couple of breaking changes between v2 and v3:

The cluster package is now internal to Microcluster. Functions like cluster.DeleteClusterMember, cluster.GetClusterMember etc. are now not accessible externally. The Microcluster app instance offers these functionalities in v3 by creating a local client and calling into the internal API.
Some packages were shuffled around (e.g. /microcluster/types)
We're no longer using lxd/response, instead it's baked into Microcluster. However, some functionalities were missing and a PR is currently open to add the missing functionalities: feat: Add response and log functionalities microcluster#603

github-actions · 2026-01-29T07:14:41Z

Microcluster Schema Changes Detected

⚠️ Warning: This pull request contains changes to the microcluster version.

Please ensure that the changes are intentional and have been reviewed by the appropriate team members.

Adding a migration:

You should not change the Microcluster migration files in interim Kubernetes releases to ensure a smooth
upgrade path from one LTS to the next. In case of upgrade failures, we need to be able to rollback to the last Kubernetes LTS which is only possible if the microcluster migrations have not been changed.

Do not under any circumstances remove any migrations and never change the order of migrations in the microcluster schema files.

Copilot

Pull request overview

This PR upgrades the project from Microcluster v2 to v3, which introduces several breaking API changes. The upgrade addresses package reorganization, internal API restrictions, and response handling consolidation.

Changes:

Updated all import paths from microcluster/v2 to microcluster/v3 and reorganized package imports (e.g., rest/types → microcluster/types, lxd/response → microcluster/rest/response)
Replaced database cluster operations (cluster.Stmt, cluster.RegisterStmt) with new db package equivalents (db.Stmt, db.RegisterStmt)
Migrated from s.Leader() client to snap.K8sdClient("") for cluster operations, and updated method names (e.g., DeleteClusterMember → RemoveClusterMember)
Updated State API method calls to function calls (e.g., s.FileSystem().StateDir → s.FileSystem().StateDir())
Created new utils.Path() helper function to replace the removed s.Address().Path() method
Added microcluster client methods to the mock implementation and k8sd client interface

Reviewed changes

Copilot reviewed 66 out of 67 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
pkg/utils/url.go	New utility function for URL path construction
pkg/utils/node/node.go	Updated to accept snap parameter and use new k8sd client
pkg/utils/microcluster/state.go	Updated microcluster import path
pkg/utils/http.go	Migrated from lxd response to microcluster response
pkg/snap/mock/provider.go	Updated microcluster import path
pkg/k8sd/features/*	Updated microcluster import paths
pkg/k8sd/database/*	Migrated from cluster package to db package for database operations
pkg/k8sd/controllers/feature.go	Updated microcluster import path
pkg/k8sd/app/*	Updated hooks to use new APIs, removed deprecated config fields, updated certificate methods
pkg/k8sd/api/*	Updated all response types and client access patterns
pkg/client/k8sd/*	Updated client implementation and added cluster member operations
cmd/k8sd/*	Updated filesystem API calls and deprecated flag descriptions
go.mod/go.sum	Updated dependency to microcluster v3 with temporary replace directive

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

HomayoonAlimohammadi · 2026-02-27T08:44:28Z

e2e tests on the k8s-snap repo: canonical/k8s-snap#2347

louiseschmidtgen

A few smaller comments, could you also trigger the version upgrade and rollback tests (nightly suite) for this PR?

louiseschmidtgen · 2026-03-05T06:46:49Z

+			retries++
+		} else {
+			// NOTE(Hue): We can not check for `cluster.Pending` with the `Role` type since it's internal to Microcluster
+			notPending = member.Role != "PENDING"


Can we ask Julian to expose this type for us? Checking for the string equivalent doesn't seem ideal.

Great point! I've raised this PR: canonical/microcluster#650

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

HomayoonAlimohammadi · 2026-03-05T08:44:36Z

I've decided to bump to v3.0.2 since it's been out recently and there's almost no changes compared to the commit hash that we've been using in this PR.

bschimke95

LGTM, please create a follow up card "bump to 3.0.3" to address Louise comment. IMHO we don't need to wait on this to merge this PR. It has been long enough.

HomayoonAlimohammadi · 2026-03-05T15:05:22Z

The e2e tests are passing. Let's gooo!

* feat: Bump microcluster to v3 * chore: use mctypes alias for microcluster/types import --------- Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

HomayoonAlimohammadi requested review from bschimke95 and Copilot January 29, 2026 07:14

Copilot started reviewing on behalf of HomayoonAlimohammadi January 29, 2026 07:14 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

Comment thread pkg/k8sd/app/hooks_remove.go Outdated

Comment thread pkg/k8sd/api/cluster_remove.go Outdated

Comment thread go.mod Outdated

HomayoonAlimohammadi force-pushed the KU-5052/microcluster-v3 branch 4 times, most recently from 5a801d2 to eb5503d Compare January 30, 2026 09:54

HomayoonAlimohammadi mentioned this pull request Jan 30, 2026

test: Use custom k8sd branch to see if e2e tests pass canonical/k8s-snap#2347

Closed

HomayoonAlimohammadi force-pushed the KU-5052/microcluster-v3 branch 4 times, most recently from 69d80ab to f46eb6c Compare February 6, 2026 07:08

feat: Bump microcluster to v3

149fd61

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

HomayoonAlimohammadi force-pushed the KU-5052/microcluster-v3 branch from f46eb6c to 149fd61 Compare February 10, 2026 07:58

HomayoonAlimohammadi added 3 commits February 25, 2026 18:53

fix: bump to the latest version with the member delete fix

c7a7c68

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

fix: lint

d284606

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

chore: use mctypes alias for microcluster/types import

f73b042

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

louiseschmidtgen reviewed Mar 5, 2026

View reviewed changes

feat: bump microcluster to an actual v3 stable tag, address comments

a686a56

Signed-off-by: Homayoon (Hue) Alimohammadi <homayoon.alimohammadi@canonical.com>

bschimke95 approved these changes Mar 5, 2026

View reviewed changes

HomayoonAlimohammadi merged commit 7af059e into main Mar 5, 2026
6 checks passed

HomayoonAlimohammadi deleted the KU-5052/microcluster-v3 branch March 5, 2026 15:06

bschimke95 mentioned this pull request Apr 2, 2026

fix(deps): bump google.golang.org/grpc to v1.79.3 (CVE-2026-33186) #20

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Bump microcluster to v3#9

feat: Bump microcluster to v3#9
HomayoonAlimohammadi merged 5 commits into
mainfrom
KU-5052/microcluster-v3

HomayoonAlimohammadi commented Jan 29, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jan 29, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HomayoonAlimohammadi commented Feb 27, 2026

Uh oh!

louiseschmidtgen left a comment •

edited

Loading

Uh oh!

louiseschmidtgen Mar 5, 2026

Uh oh!

HomayoonAlimohammadi Mar 5, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HomayoonAlimohammadi commented Mar 5, 2026

Uh oh!

bschimke95 left a comment

Uh oh!

HomayoonAlimohammadi commented Mar 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

HomayoonAlimohammadi commented Jan 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Uh oh!

github-actions Bot commented Jan 29, 2026

Microcluster Schema Changes Detected

Adding a migration:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

HomayoonAlimohammadi commented Feb 27, 2026

Uh oh!

louiseschmidtgen left a comment • 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!

louiseschmidtgen Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

HomayoonAlimohammadi Mar 5, 2026 • 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!

Uh oh!

Uh oh!

Uh oh!

HomayoonAlimohammadi commented Mar 5, 2026

Uh oh!

bschimke95 left a comment

Choose a reason for hiding this comment

Uh oh!

HomayoonAlimohammadi commented Mar 5, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

HomayoonAlimohammadi commented Jan 29, 2026 •

edited

Loading

louiseschmidtgen left a comment •

edited

Loading

HomayoonAlimohammadi Mar 5, 2026 •

edited

Loading