Merge pull request #4120 from twz123/move-containerd-component-into-subpackage

Move Containerd component into the containerd subpackage

Author: twz123

cmd/worker/worker.go

@@ -34,6 +34,7 @@ import (
 	"github.com/k0sproject/k0s/pkg/component/status"
 	"github.com/k0sproject/k0s/pkg/component/worker"
 	workerconfig "github.com/k0sproject/k0s/pkg/component/worker/config"
+	"github.com/k0sproject/k0s/pkg/component/worker/containerd"
 	"github.com/k0sproject/k0s/pkg/component/worker/nllb"
 	"github.com/k0sproject/k0s/pkg/config"
 	"github.com/k0sproject/k0s/pkg/kubernetes"
@@ -148,7 +149,7 @@ func (c *Command) Start(ctx context.Context) error {
 	}
 
 	if c.CriSocket == "" {
-		componentManager.Add(ctx, worker.NewContainerd(c.Logging["containerd"], c.K0sVars, workerConfig))
+		componentManager.Add(ctx, containerd.NewComponent(c.Logging["containerd"], c.K0sVars, workerConfig))
 	}
 
 	componentManager.Add(ctx, worker.NewOCIBundleReconciler(c.K0sVars))

pkg/component/worker/containerd.go pkg/component/worker/containerd/component.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package worker
+package containerd
 
 import (
 	"bufio"
@@ -41,7 +41,6 @@ import (
 	"github.com/k0sproject/k0s/pkg/assets"
 	"github.com/k0sproject/k0s/pkg/component/manager"
 	workerconfig "github.com/k0sproject/k0s/pkg/component/worker/config"
-	"github.com/k0sproject/k0s/pkg/component/worker/containerd"
 	"github.com/k0sproject/k0s/pkg/config"
 	"github.com/k0sproject/k0s/pkg/constant"
 	"github.com/k0sproject/k0s/pkg/debounce"
@@ -68,8 +67,8 @@ const confPathWindows = "C:\\Program Files\\containerd\\config.toml"
 const importsPathPosix = "/etc/k0s/containerd.d/"
 const importsPathWindows = "C:\\etc\\k0s\\containerd.d\\"
 
-// Containerd implements the component interface to manage containerd as a k0s component.
-type Containerd struct {
+// Component implements the component interface to manage containerd as a k0s component.
+type Component struct {
 	supervisor    supervisor.Supervisor
 	LogLevel      string
 	K0sVars       *config.CfgVars
@@ -80,8 +79,8 @@ type Containerd struct {
 	importsPath   string
 }
 
-func NewContainerd(logLevel string, vars *config.CfgVars, profile *workerconfig.Profile) *Containerd {
-	c := &Containerd{
+func NewComponent(logLevel string, vars *config.CfgVars, profile *workerconfig.Profile) *Component {
+	c := &Component{
 		LogLevel: logLevel,
 		K0sVars:  vars,
 		Profile:  profile,
@@ -99,10 +98,10 @@ func NewContainerd(logLevel string, vars *config.CfgVars, profile *workerconfig.
 	return c
 }
 
-var _ manager.Component = (*Containerd)(nil)
+var _ manager.Component = (*Component)(nil)
 
 // Init extracts the needed binaries
-func (c *Containerd) Init(ctx context.Context) error {
+func (c *Component) Init(ctx context.Context) error {
 	g, _ := errgroup.WithContext(ctx)
 	for _, bin := range c.binaries {
 		b := bin
@@ -116,7 +115,7 @@ func (c *Containerd) Init(ctx context.Context) error {
 	return g.Wait()
 }
 
-func (c *Containerd) windowsInit() error {
+func (c *Component) windowsInit() error {
 	if runtime.GOOS != "windows" {
 		return nil
 	}
@@ -127,7 +126,7 @@ func (c *Containerd) windowsInit() error {
 }
 
 // Run runs containerd.
-func (c *Containerd) Start(ctx context.Context) error {
+func (c *Component) Start(ctx context.Context) error {
 	logrus.Info("Starting containerd")
 
 	if err := c.setupConfig(); err != nil {
@@ -162,21 +161,21 @@ func (c *Containerd) Start(ctx context.Context) error {
 	return nil
 }
 
-func (c *Containerd) windowsStart(_ context.Context) error {
+func (c *Component) windowsStart(_ context.Context) error {
 	if err := winExecute("Start-Service containerd"); err != nil {
 		return fmt.Errorf("failed to start Windows Service %q: %w", "containerd", err)
 	}
 	return nil
 }
 
-func (c *Containerd) windowsStop() error {
+func (c *Component) windowsStop() error {
 	if err := winExecute("Stop-Service containerd"); err != nil {
 		return fmt.Errorf("failed to stop Windows Service %q: %w", "containerd", err)
 	}
 	return nil
 }
 
-func (c *Containerd) setupConfig() error {
+func (c *Component) setupConfig() error {
 	// Check if the config file is user managed
 	// If it is, we should not touch it
 
@@ -195,9 +194,18 @@ func (c *Containerd) setupConfig() error {
 	if err := dir.Init(filepath.Dir(c.importsPath), 0755); err != nil {
 		return fmt.Errorf("can't create containerd config imports dir: %w", err)
 	}
-	containerdConfigurer := containerd.NewConfigurer(c.Profile.PauseImage, filepath.Join(c.importsPath, "*.toml"))
 
-	imports, err := containerdConfigurer.HandleImports()
+	configurer := &configurer{
+		loadPath:       filepath.Join(c.importsPath, "*.toml"),
+		pauseImage:     c.Profile.PauseImage.URI(),
+		log:            logrus.WithField("component", "containerd"),
+		criRuntimePath: "/run/k0s/containerd-cri.toml",
+	}
+	if runtime.GOOS == "windows" {
+		configurer.criRuntimePath = `C:\var\lib\k0s\run\containerd-cri.toml`
+	}
+
+	imports, err := configurer.handleImports()
 	if err != nil {
 		return fmt.Errorf("can't handle imports: %w", err)
 	}
@@ -217,7 +225,7 @@ func (c *Containerd) setupConfig() error {
 	return file.WriteContentAtomically(c.confPath, output.Bytes(), 0644)
 }
 
-func (c *Containerd) watchDropinConfigs(ctx context.Context) {
+func (c *Component) watchDropinConfigs(ctx context.Context) {
 	log := logrus.WithField("component", "containerd")
 	watcher, err := fsnotify.NewWatcher()
 	if err != nil {
@@ -265,7 +273,7 @@ func (c *Containerd) watchDropinConfigs(ctx context.Context) {
 	}
 }
 
-func (c *Containerd) restart() {
+func (c *Component) restart() {
 	log := logrus.WithFields(logrus.Fields{"component": "containerd", "phase": "restart"})
 
 	log.Info("restart requested")
@@ -293,7 +301,7 @@ func (c *Containerd) restart() {
 }
 
 // Stop stops containerd.
-func (c *Containerd) Stop() error {
+func (c *Component) Stop() error {
 	if runtime.GOOS == "windows" {
 		return c.windowsStop()
 	}

pkg/component/worker/containerd_test.go pkg/component/worker/containerd/component_test.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package worker
+package containerd
 
 import (
 	"os"

pkg/component/worker/containerd/criconfig.go pkg/component/worker/containerd/configurer.go

@@ -25,46 +25,26 @@ import (
 	"runtime"
 	"strings"
 
-	"github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
 	"github.com/mesosphere/toml-merge/pkg/patch"
 	"github.com/pelletier/go-toml"
 	"github.com/sirupsen/logrus"
 
 	criconfig "github.com/containerd/containerd/pkg/cri/config"
 )
 
-// TODO: move to K0sVars
-const containerdCRIConfigPathPosix = "/run/k0s/containerd-cri.toml"
-const containerdCRIConfigPathWindows = "C:\\var\\lib\\k0s\\run\\containerd-cri.toml"
-
-type CRIConfigurer struct {
+type configurer struct {
 	loadPath       string
 	pauseImage     string
 	criRuntimePath string
 
 	log *logrus.Entry
 }
 
-func NewConfigurer(pauseImage *v1beta1.ImageSpec, importsPath string) *CRIConfigurer {
-	c := &CRIConfigurer{
-		loadPath:   importsPath,
-		pauseImage: pauseImage.URI(),
-		log:        logrus.WithField("component", "containerd"),
-	}
-	if runtime.GOOS == "windows" {
-		c.criRuntimePath = containerdCRIConfigPathWindows
-
-	} else {
-		c.criRuntimePath = containerdCRIConfigPathPosix
-	}
-	return c
-}
-
-// HandleImports Resolves containerd imports from the import glob path.
+// Resolves containerd imports from the import glob path.
 // If the partial config has CRI plugin enabled, it will add to the runc CRI config (single file).
 // if no CRI plugin is found, it will add the file as-is to imports list returned.
 // Once all files are processed the concatenated CRI config file is written and added to the imports list.
-func (c *CRIConfigurer) HandleImports() ([]string, error) {
+func (c *configurer) handleImports() ([]string, error) {
 	var imports []string
 	var criConfigBuffer bytes.Buffer
 
@@ -124,23 +104,21 @@ func escapedPath(s string) string {
 	return s
 }
 
-// We need to use custom struct so we can unmarshal the CRI plugin config only
-type config struct {
-	Version int
-	Plugins map[string]interface{} `toml:"plugins"`
-}
-
 // generateDefaultCRIConfig generates the default CRI config and writes it to the given writer
 // It uses the containerd containerd package to generate the config so we can keep it in sync with containerd
-func (c *CRIConfigurer) generateDefaultCRIConfig(w io.Writer) error {
+func (c *configurer) generateDefaultCRIConfig(w io.Writer) error {
 	criPluginConfig := criconfig.DefaultConfig()
 	// Set pause image
 	criPluginConfig.SandboxImage = c.pauseImage
 	if runtime.GOOS == "windows" {
 		criPluginConfig.CniConfig.NetworkPluginBinDir = "c:\\opt\\cni\\bin"
 		criPluginConfig.CniConfig.NetworkPluginConfDir = "c:\\opt\\cni\\conf"
 	}
-	containerdConfig := config{
+	// We need to use custom struct so we can unmarshal the CRI plugin config only
+	containerdConfig := struct {
+		Version int
+		Plugins map[string]interface{} `toml:"plugins"`
+	}{
 		Version: 2,
 		Plugins: map[string]interface{}{
 			"io.containerd.grpc.v1.cri": criPluginConfig,
@@ -154,7 +132,7 @@ func (c *CRIConfigurer) generateDefaultCRIConfig(w io.Writer) error {
 	return nil
 }
 
-func (c *CRIConfigurer) hasCRIPluginConfig(data []byte) (bool, error) {
+func (c *configurer) hasCRIPluginConfig(data []byte) (bool, error) {
 	var tomlConfig map[string]interface{}
 	if err := toml.Unmarshal(data, &tomlConfig); err != nil {
 		return false, err

pkg/component/worker/containerd/criconfig_test.go pkg/component/worker/containerd/configurer_test.go

@@ -22,21 +22,24 @@ import (
 	"testing"
 
 	srvconfig "github.com/containerd/containerd/services/server/config"
-	"github.com/k0sproject/k0s/pkg/apis/k0s/v1beta1"
 	"github.com/sirupsen/logrus"
 	"github.com/stretchr/testify/require"
 )
 
 const testImportsPath = "/etc/k0s/containerd.d/"
 
-func TestCRIConfigurer_hasCRIPluginConfig(t *testing.T) {
+func TestConfigurer_hasCRIPluginConfig(t *testing.T) {
 	t.Run("should return true if config has cri plugin configs", func(t *testing.T) {
 		cfg := `
 [plugins."io.containerd.grpc.v1.cri".registry.mirrors]
   [plugins."io.containerd.grpc.v1.cri".registry.mirrors."docker.io"]
     endpoint = ["https://registry-1.docker.io"]
 `
-		c := NewConfigurer(&v1beta1.DefaultClusterImages().Pause, testImportsPath)
+
+		c := configurer{
+			loadPath: testImportsPath,
+			log:      logrus.New().WithField("test", t.Name()),
+		}
 		hasCRIPluginConfig, err := c.hasCRIPluginConfig([]byte(cfg))
 		require.NoError(t, err)
 		require.True(t, hasCRIPluginConfig)
@@ -47,15 +50,19 @@ func TestCRIConfigurer_hasCRIPluginConfig(t *testing.T) {
 timeout = 3
 version = 2
 `
-		c := NewConfigurer(&v1beta1.DefaultClusterImages().Pause, testImportsPath)
+
+		c := configurer{
+			loadPath: testImportsPath,
+			log:      logrus.New().WithField("test", t.Name()),
+		}
 		hasCRIPluginConfig, err := c.hasCRIPluginConfig([]byte(cfg))
 		require.NoError(t, err)
 		require.False(t, hasCRIPluginConfig)
 	})
 
 }
 
-func TestCRIConfigurer_HandleImports(t *testing.T) {
+func TestConfigurer_HandleImports(t *testing.T) {
 	t.Run("should merge CRI configs", func(t *testing.T) {
 		tmp := t.TempDir()
 		testLoadPath := filepath.Join(tmp, "*.toml")
@@ -67,12 +74,12 @@ func TestCRIConfigurer_HandleImports(t *testing.T) {
 `
 		err := os.WriteFile(filepath.Join(tmp, "foo.toml"), []byte(criRuntimeConfig), 0644)
 		require.NoError(t, err)
-		c := CRIConfigurer{
+		c := configurer{
 			loadPath:       testLoadPath,
 			criRuntimePath: criRuntimePath,
 			log:            logrus.New().WithField("test", t.Name()),
 		}
-		_, err = c.HandleImports()
+		_, err = c.handleImports()
 		require.NoError(t, err)
 
 		// Dump the config for inspection
@@ -92,12 +99,12 @@ func TestCRIConfigurer_HandleImports(t *testing.T) {
 	t.Run("should have single import for CRI if there's nothing in imports dir", func(t *testing.T) {
 		testLoadPath := filepath.Join(t.TempDir(), "*.toml")
 		criRuntimePath := filepath.Join(t.TempDir(), "cri.toml")
-		c := CRIConfigurer{
+		c := configurer{
 			loadPath:       testLoadPath,
 			criRuntimePath: criRuntimePath,
 			log:            logrus.New().WithField("test", t.Name()),
 		}
-		imports, err := c.HandleImports()
+		imports, err := c.handleImports()
 		require.NoError(t, err)
 		require.Len(t, imports, 1)
 		require.Equal(t, escapedPath(criRuntimePath), imports[0])
@@ -114,12 +121,12 @@ func TestCRIConfigurer_HandleImports(t *testing.T) {
 `
 		err := os.WriteFile(filepath.Join(tmp, "foo.toml"), []byte(criRuntimeConfig), 0644)
 		require.NoError(t, err)
-		c := CRIConfigurer{
+		c := configurer{
 			loadPath:       testLoadPath,
 			criRuntimePath: criRuntimePath,
 			log:            logrus.New().WithField("test", t.Name()),
 		}
-		imports, err := c.HandleImports()
+		imports, err := c.handleImports()
 		require.NoError(t, err)
 		require.Len(t, imports, 1)
 		require.Contains(t, imports, escapedPath(criRuntimePath))
@@ -145,12 +152,12 @@ version = 2
 		nonCriConfigPath := filepath.Join(tmp, "foo.toml")
 		err := os.WriteFile(nonCriConfigPath, []byte(criRuntimeConfig), 0644)
 		require.NoError(t, err)
-		c := CRIConfigurer{
+		c := configurer{
 			loadPath:       testLoadPath,
 			criRuntimePath: criRuntimePath,
 			log:            logrus.New().WithField("test", t.Name()),
 		}
-		imports, err := c.HandleImports()
+		imports, err := c.handleImports()
 		require.NoError(t, err)
 		require.Len(t, imports, 2)
 		require.Contains(t, imports, escapedPath(criRuntimePath))

pkg/component/worker/utils_linux.go pkg/component/worker/containerd/utils_linux.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package worker
+package containerd
 
 func winExecute(args ...string) error {
 	panic("Invariant broken: this function should never be called on non-winodws platforms")

pkg/component/worker/utils_windows.go pkg/component/worker/containerd/utils_windows.go

@@ -13,7 +13,8 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
-package worker
+
+package containerd
 
 import (
 	"os"