Move MicroCloud to microcluster v2

.github/workflows/tests.yml

@@ -214,29 +214,12 @@ jobs:
           sudo snap install lxd --channel latest/edge || sudo snap refresh lxd --channel latest/edge
           sudo lxd init --auto
 
-      - name: Build MicroOVN from commit 803dc03ea847d214941330c74cc0ae0027550dc0
-        run: |
-          set -eux
-
-          sudo snap refresh
-          sudo snap set lxd daemon.group=adm
-          sudo snap install snapcraft --classic
-          git clone https://github.com/canonical/microovn
-          cd microovn
-          git checkout 803dc03ea847d214941330c74cc0ae0027550dc0
-          # disable golangci-lint as the latest version is not happy with this commit.
-          sed -e "s/golangci-lint run/# &/" -i snap/snapcraft.yaml
-          make microovn.snap
-          export MICROOVN_SNAP_PATH="$(readlink -f microovn.snap)"
-          echo "MICROOVN_SNAP_PATH=${MICROOVN_SNAP_PATH}"   >> "${GITHUB_ENV}"
-          cd -
-
       - name: "Prepare for system tests"
         run: |
           set -eux
           chmod +x ~
           cd test
-          sudo --preserve-env=DEBUG,GITHUB_ACTIONS,MICROCLOUD_DEBUG_PATH,MICROCLOUDD_DEBUG_PATH,SKIP_VM_LAUNCH,SNAPSHOT_RESTORE,TEST_STORAGE_SOURCE,TESTBED_READY,MICROOVN_SNAP_PATH ./main.sh setup
+          sudo --preserve-env=DEBUG,GITHUB_ACTIONS,MICROCLOUD_DEBUG_PATH,MICROCLOUDD_DEBUG_PATH,SKIP_VM_LAUNCH,SNAPSHOT_RESTORE,TEST_STORAGE_SOURCE,TESTBED_READY ./main.sh setup
           echo "TESTBED_READY=1" >> "${GITHUB_ENV}"
 
       - name: "Run system tests (${{ matrix.go }}, ${{ matrix.suite }})"

Makefile

@@ -1,4 +1,4 @@
-GOMIN=1.22.4
+GOMIN=1.22.5
 
 .PHONY: default
 default: build

api/response.go

@@ -21,7 +21,7 @@ func NewResponse(response *http.Response) response.Response {
 }
 
 // Render implements response.Response for Response, enabling use with a rest.EndpointAction Handler function.
-func (r *Response) Render(w http.ResponseWriter) error {
+func (r *Response) Render(w http.ResponseWriter, _ *http.Request) error {
 	decoder := json.NewDecoder(r.response.Body)
 
 	var responseRaw *api.ResponseRaw

api/services.go

@@ -9,8 +9,8 @@ import (
 
 	"github.com/canonical/lxd/lxd/response"
 	"github.com/canonical/lxd/lxd/util"
-	"github.com/canonical/microcluster/rest"
-	"github.com/canonical/microcluster/state"
+	"github.com/canonical/microcluster/v2/rest"
+	"github.com/canonical/microcluster/v2/state"
 
 	"github.com/canonical/microcloud/microcloud/api/types"
 	"github.com/canonical/microcloud/microcloud/service"
@@ -28,7 +28,7 @@ var ServicesCmd = func(sh *service.Handler) rest.Endpoint {
 }
 
 // servicesPut updates the cluster status of the MicroCloud peer.
-func servicesPut(state *state.State, r *http.Request) response.Response {
+func servicesPut(state state.State, r *http.Request) response.Response {
 	// Parse the request.
 	req := types.ServicesPut{}
 
@@ -50,7 +50,7 @@ func servicesPut(state *state.State, r *http.Request) response.Response {
 		addr = req.Address
 	}
 
-	sh, err := service.NewHandler(state.Name(), addr, state.OS.StateDir, false, false, services...)
+	sh, err := service.NewHandler(state.Name(), addr, state.FileSystem().StateDir, services...)
 	if err != nil {
 		return response.SmartError(err)
 	}

api/services_auth.go

@@ -7,17 +7,17 @@ import (
 	"github.com/canonical/lxd/lxd/response"
 	"github.com/canonical/lxd/lxd/util"
 	"github.com/canonical/lxd/shared/logger"
-	"github.com/canonical/microcluster/state"
+	"github.com/canonical/microcluster/v2/state"
 
 	"github.com/canonical/microcloud/microcloud/service"
 )
 
 // endpointHandler is just a convenience for writing clean return types.
-type endpointHandler func(*state.State, *http.Request) response.Response
+type endpointHandler func(state.State, *http.Request) response.Response
 
 // authHandler ensures a request has been authenticated with the mDNS broadcast secret.
 func authHandler(sh *service.Handler, f endpointHandler) endpointHandler {
-	return func(s *state.State, r *http.Request) response.Response {
+	return func(s state.State, r *http.Request) response.Response {
 		if r.RemoteAddr == "@" {
 			logger.Debug("Allowing unauthenticated request through unix socket")
 

api/services_cluster.go

@@ -9,8 +9,8 @@ import (
 	"github.com/canonical/lxd/lxd/response"
 	"github.com/canonical/lxd/shared/api"
 	"github.com/canonical/lxd/shared/logger"
-	"github.com/canonical/microcluster/rest"
-	"github.com/canonical/microcluster/state"
+	"github.com/canonical/microcluster/v2/rest"
+	"github.com/canonical/microcluster/v2/state"
 	"github.com/gorilla/mux"
 
 	"github.com/canonical/microcloud/microcloud/api/types"
@@ -29,7 +29,7 @@ var ServicesClusterCmd = func(sh *service.Handler) rest.Endpoint {
 }
 
 // removeClusterMember removes the given cluster member from all services that it exists in.
-func removeClusterMember(state *state.State, r *http.Request) response.Response {
+func removeClusterMember(state state.State, r *http.Request) response.Response {
 	force := r.URL.Query().Get("force") == "1"
 	name, err := url.PathUnescape(mux.Vars(r)["name"])
 	if err != nil {
@@ -54,7 +54,7 @@ func removeClusterMember(state *state.State, r *http.Request) response.Response
 		return response.SmartError(fmt.Errorf("State address %q is invalid: %w", state.Address().String(), err))
 	}
 
-	sh, err := service.NewHandler(state.Name(), addr, state.OS.StateDir, false, false, existingServices...)
+	sh, err := service.NewHandler(state.Name(), addr, state.FileSystem().StateDir, existingServices...)
 	if err != nil {
 		return response.SmartError(err)
 	}

api/services_proxy.go

@@ -9,9 +9,9 @@ import (
 	"github.com/canonical/lxd/client"
 	"github.com/canonical/lxd/lxd/response"
 	"github.com/canonical/lxd/shared/ws"
-	"github.com/canonical/microcluster/microcluster"
-	"github.com/canonical/microcluster/rest"
-	"github.com/canonical/microcluster/state"
+	"github.com/canonical/microcluster/v2/microcluster"
+	"github.com/canonical/microcluster/v2/rest"
+	"github.com/canonical/microcluster/v2/state"
 
 	"github.com/canonical/microcloud/microcloud/service"
 )
@@ -56,7 +56,7 @@ func proxy(sh *service.Handler, name, path string, handler endpointHandler) rest
 }
 
 // lxdHandler forwards a request made to /1.0/services/lxd/<rest> to /1.0/<rest> on the LXD unix socket.
-func lxdHandler(s *state.State, r *http.Request) response.Response {
+func lxdHandler(s state.State, r *http.Request) response.Response {
 	_, path, ok := strings.Cut(r.URL.Path, "/1.0/services/lxd")
 	if !ok {
 		return response.SmartError(fmt.Errorf("Invalid path %q", r.URL.Path))
@@ -110,8 +110,8 @@ func lxdHandler(s *state.State, r *http.Request) response.Response {
 }
 
 // microHandler forwards a request made to /1.0/services/<microcluster-service>/<rest> to /1.0/<rest> on the service unix socket.
-func microHandler(service string, stateDir string) func(*state.State, *http.Request) response.Response {
-	return func(s *state.State, r *http.Request) response.Response {
+func microHandler(service string, stateDir string) func(state.State, *http.Request) response.Response {
+	return func(s state.State, r *http.Request) response.Response {
 		_, path, ok := strings.Cut(r.URL.Path, fmt.Sprintf("/1.0/services/%s", service))
 		if !ok {
 			return response.SmartError(fmt.Errorf("Invalid path %q", r.URL.Path))

api/services_tokens.go

@@ -7,8 +7,8 @@ import (
 	"net/url"
 
 	"github.com/canonical/lxd/lxd/response"
-	"github.com/canonical/microcluster/rest"
-	"github.com/canonical/microcluster/state"
+	"github.com/canonical/microcluster/v2/rest"
+	"github.com/canonical/microcluster/v2/state"
 	"github.com/gorilla/mux"
 
 	"github.com/canonical/microcloud/microcloud/api/types"
@@ -29,7 +29,7 @@ var ServiceTokensCmd = func(sh *service.Handler) rest.Endpoint {
 // serviceTokensPost issues a token for service using the MicroCloud proxy.
 // Normally a token request to a service would be restricted to trusted systems,
 // so this endpoint validates the mDNS auth token and then proxies the request to the local unix socket of the remote system.
-func serviceTokensPost(s *state.State, r *http.Request) response.Response {
+func serviceTokensPost(s state.State, r *http.Request) response.Response {
 	serviceType, err := url.PathUnescape(mux.Vars(r)["serviceType"])
 	if err != nil {
 		return response.SmartError(err)
@@ -43,12 +43,12 @@ func serviceTokensPost(s *state.State, r *http.Request) response.Response {
 		return response.BadRequest(err)
 	}
 
-	sh, err := service.NewHandler(s.Name(), req.ClusterAddress, s.OS.StateDir, false, false, types.ServiceType(serviceType))
+	sh, err := service.NewHandler(s.Name(), req.ClusterAddress, s.FileSystem().StateDir, types.ServiceType(serviceType))
 	if err != nil {
 		return response.SmartError(err)
 	}
 
-	token, err := sh.Services[types.ServiceType(serviceType)].IssueToken(s.Context, req.JoinerName)
+	token, err := sh.Services[types.ServiceType(serviceType)].IssueToken(r.Context(), req.JoinerName)
 	if err != nil {
 		return response.SmartError(fmt.Errorf("Failed to issue %s token for peer %q: %w", serviceType, req.JoinerName, err))
 	}

client/client.go

@@ -6,7 +6,7 @@ import (
 	"time"
 
 	"github.com/canonical/lxd/shared/api"
-	"github.com/canonical/microcluster/client"
+	"github.com/canonical/microcluster/v2/client"
 
 	"github.com/canonical/microcloud/microcloud/api/types"
 )

client/proxy.go

@@ -8,7 +8,7 @@ import (
 	"strings"
 
 	"github.com/canonical/lxd/shared"
-	"github.com/canonical/microcluster/client"
+	"github.com/canonical/microcluster/v2/client"
 
 	"github.com/canonical/microcloud/microcloud/api/types"
 )

cmd/microcloud/add.go

@@ -5,7 +5,7 @@ import (
 	"fmt"
 	"time"
 
-	"github.com/canonical/microcluster/microcluster"
+	"github.com/canonical/microcluster/v2/microcluster"
 	"github.com/spf13/cobra"
 
 	"github.com/canonical/microcloud/microcloud/api"
@@ -94,7 +94,7 @@ func (c *cmdAdd) Run(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	s, err := service.NewHandler(cfg.name, cfg.address, c.common.FlagMicroCloudDir, c.common.FlagLogDebug, c.common.FlagLogVerbose, services...)
+	s, err := service.NewHandler(cfg.name, cfg.address, c.common.FlagMicroCloudDir, services...)
 	if err != nil {
 		return err
 	}

cmd/microcloud/cluster_members.go

@@ -13,9 +13,9 @@ import (
 	"github.com/canonical/lxd/shared"
 	cli "github.com/canonical/lxd/shared/cmd"
 	"github.com/canonical/lxd/shared/termios"
-	"github.com/canonical/microcluster/client"
-	"github.com/canonical/microcluster/cluster"
-	"github.com/canonical/microcluster/microcluster"
+	"github.com/canonical/microcluster/v2/client"
+	"github.com/canonical/microcluster/v2/cluster"
+	"github.com/canonical/microcluster/v2/microcluster"
 	"github.com/spf13/cobra"
 	"golang.org/x/sys/unix"
 	"gopkg.in/yaml.v2"
@@ -95,7 +95,7 @@ func (c *cmdClusterMembersList) Run(cmd *cobra.Command, args []string) error {
 	}
 
 	// Get all state information.
-	options := microcluster.Args{StateDir: c.common.FlagMicroCloudDir, Verbose: c.common.FlagLogVerbose, Debug: c.common.FlagLogDebug}
+	options := microcluster.Args{StateDir: c.common.FlagMicroCloudDir}
 	m, err := microcluster.App(options)
 	if err != nil {
 		return err
@@ -185,7 +185,7 @@ func (c *cmdClusterMemberRemove) Run(cmd *cobra.Command, args []string) error {
 		return cmd.Help()
 	}
 
-	options := microcluster.Args{StateDir: c.common.FlagMicroCloudDir, Verbose: c.common.FlagLogVerbose, Debug: c.common.FlagLogDebug}
+	options := microcluster.Args{StateDir: c.common.FlagMicroCloudDir}
 	m, err := microcluster.App(options)
 	if err != nil {
 		return err
@@ -219,7 +219,7 @@ func (c *cmdClusterRecover) command() *cobra.Command {
 }
 
 func (c *cmdClusterRecover) run(cmd *cobra.Command, args []string) error {
-	m, err := microcluster.App(microcluster.Args{StateDir: c.common.FlagMicroCloudDir, Verbose: c.common.FlagLogVerbose, Debug: c.common.FlagLogDebug})
+	m, err := microcluster.App(microcluster.Args{StateDir: c.common.FlagMicroCloudDir})
 	if err != nil {
 		return err
 	}

cmd/microcloud/main.go

@@ -7,6 +7,7 @@ import (
 	"os"
 
 	cli "github.com/canonical/lxd/shared/cmd"
+	"github.com/canonical/lxd/shared/logger"
 	"github.com/spf13/cobra"
 
 	"github.com/canonical/microcloud/microcloud/version"
@@ -19,8 +20,6 @@ type CmdControl struct {
 
 	FlagHelp          bool
 	FlagVersion       bool
-	FlagLogDebug      bool
-	FlagLogVerbose    bool
 	FlagMicroCloudDir string
 
 	asker cli.Asker
@@ -34,7 +33,7 @@ func main() {
 	}
 
 	// common flags.
-	commonCmd := CmdControl{asker: cli.NewAsker(bufio.NewReader(os.Stdin))}
+	commonCmd := CmdControl{asker: cli.NewAsker(bufio.NewReader(os.Stdin), logger.Log)}
 
 	useTestConsole := os.Getenv("TEST_CONSOLE")
 	if useTestConsole == "1" {
@@ -70,8 +69,6 @@ EOF`)
 	app.PersistentFlags().StringVar(&commonCmd.FlagMicroCloudDir, "state-dir", "", "Path to store MicroCloud state information"+"``")
 	app.PersistentFlags().BoolVarP(&commonCmd.FlagHelp, "help", "h", false, "Print help")
 	app.PersistentFlags().BoolVar(&commonCmd.FlagVersion, "version", false, "Print version number")
-	app.PersistentFlags().BoolVarP(&commonCmd.FlagLogDebug, "debug", "d", false, "Show all debug messages")
-	app.PersistentFlags().BoolVarP(&commonCmd.FlagLogVerbose, "verbose", "v", false, "Show all information messages")
 
 	app.SetVersionTemplate("{{.Version}}\n")
 

cmd/microcloud/main_init.go

@@ -18,7 +18,7 @@ import (
 	"github.com/canonical/lxd/shared/validate"
 	cephTypes "github.com/canonical/microceph/microceph/api/types"
 	cephClient "github.com/canonical/microceph/microceph/client"
-	"github.com/canonical/microcluster/client"
+	"github.com/canonical/microcluster/v2/client"
 	ovnClient "github.com/canonical/microovn/microovn/client"
 	"github.com/spf13/cobra"
 
@@ -213,7 +213,7 @@ func (c *initConfig) RunInteractive(cmd *cobra.Command, args []string) error {
 		return err
 	}
 
-	s, err := service.NewHandler(c.name, c.address, c.common.FlagMicroCloudDir, c.common.FlagLogDebug, c.common.FlagLogVerbose, services...)
+	s, err := service.NewHandler(c.name, c.address, c.common.FlagMicroCloudDir, services...)
 	if err != nil {
 		return err
 	}

cmd/microcloud/main_init_preseed.go

@@ -155,7 +155,7 @@ func (c *initConfig) RunPreseed(cmd *cobra.Command) error {
 
 	c.name = hostname
 	c.address = listenIP.String()
-	s, err := service.NewHandler(c.name, c.address, c.common.FlagMicroCloudDir, c.common.FlagLogDebug, c.common.FlagLogVerbose, services...)
+	s, err := service.NewHandler(c.name, c.address, c.common.FlagMicroCloudDir, services...)
 	if err != nil {
 		return err
 	}

cmd/microcloud/main_init_test.go

@@ -30,7 +30,7 @@ func newSystemWithUplinkNetConfig(address string, config map[string]string) Init
 }
 
 func newTestHandler(addr string, t *testing.T) *service.Handler {
-	handler, err := service.NewHandler("testSystem", addr, "/tmp/microcloud_test_hander", true, true)
+	handler, err := service.NewHandler("testSystem", addr, "/tmp/microcloud_test_hander")
 	if err != nil {
 		t.Fatalf("Failed to create test service handler: %s", err)
 	}

cmd/microcloud/remove.go

@@ -3,7 +3,7 @@ package main
 import (
 	"context"
 
-	"github.com/canonical/microcluster/microcluster"
+	"github.com/canonical/microcluster/v2/microcluster"
 	"github.com/spf13/cobra"
 
 	cloudClient "github.com/canonical/microcloud/microcloud/client"
@@ -33,7 +33,7 @@ func (c *cmdRemove) Run(cmd *cobra.Command, args []string) error {
 		return cmd.Help()
 	}
 
-	options := microcluster.Args{StateDir: c.common.FlagMicroCloudDir, Verbose: c.common.FlagLogVerbose, Debug: c.common.FlagLogDebug}
+	options := microcluster.Args{StateDir: c.common.FlagMicroCloudDir}
 	m, err := microcluster.App(options)
 	if err != nil {
 		return err

cmd/microcloud/services.go

@@ -11,8 +11,8 @@ import (
 	"github.com/canonical/lxd/client"
 	lxdAPI "github.com/canonical/lxd/shared/api"
 	cli "github.com/canonical/lxd/shared/cmd"
-	"github.com/canonical/microcluster/client"
-	"github.com/canonical/microcluster/microcluster"
+	"github.com/canonical/microcluster/v2/client"
+	"github.com/canonical/microcluster/v2/microcluster"
 	"github.com/spf13/cobra"
 
 	"github.com/canonical/microcloud/microcloud/api"
@@ -99,7 +99,7 @@ func (c *cmdServiceList) Run(cmd *cobra.Command, args []string) error {
 	}
 
 	// Instantiate a handler for the services.
-	s, err := service.NewHandler(status.Name, status.Address.Addr().String(), c.common.FlagMicroCloudDir, c.common.FlagLogDebug, c.common.FlagLogVerbose, services...)
+	s, err := service.NewHandler(status.Name, status.Address.Addr().String(), c.common.FlagMicroCloudDir, services...)
 	if err != nil {
 		return err
 	}
@@ -255,7 +255,7 @@ func (c *cmdServiceAdd) Run(cmd *cobra.Command, args []string) error {
 	}
 
 	// Instantiate a handler for the services.
-	s, err := service.NewHandler(cfg.name, cfg.address, c.common.FlagMicroCloudDir, c.common.FlagLogDebug, c.common.FlagLogVerbose, services...)
+	s, err := service.NewHandler(cfg.name, cfg.address, c.common.FlagMicroCloudDir, services...)
 	if err != nil {
 		return err
 	}