install.go

// Copyright © 2021 Alibaba Group Holding Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// 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 processor

import (
	"context"
	"fmt"
	"strings"

	"golang.org/x/sync/errgroup"
	"k8s.io/apimachinery/pkg/util/sets"

	"github.com/labring/sealos/pkg/buildah"
	"github.com/labring/sealos/pkg/clusterfile"
	"github.com/labring/sealos/pkg/config"
	"github.com/labring/sealos/pkg/filesystem/rootfs"
	"github.com/labring/sealos/pkg/guest"
	"github.com/labring/sealos/pkg/runtime"
	"github.com/labring/sealos/pkg/runtime/factory"
	v2 "github.com/labring/sealos/pkg/types/v1beta1"
	"github.com/labring/sealos/pkg/utils/confirm"
	"github.com/labring/sealos/pkg/utils/logger"
	"github.com/labring/sealos/pkg/utils/maps"
	"github.com/labring/sealos/pkg/utils/rand"
	stringsutil "github.com/labring/sealos/pkg/utils/strings"
)

var ForceOverride bool

type InstallProcessor struct {
	ClusterFile      clusterfile.Interface
	Buildah          buildah.Interface
	Runtime          runtime.Interface
	Guest            guest.Interface
	NewMounts        []v2.MountImage
	NewImages        []string
	ExtraEnvs        map[string]string // parsing from CLI arguments
	imagesToOverride []string
}

func (c *InstallProcessor) Execute(cluster *v2.Cluster) error {
	pipLine, err := c.GetPipeLine()
	if err != nil {
		return err
	}

	for _, f := range pipLine {
		if err = f(cluster); err != nil {
			return err
		}
	}

	return nil
}

func (c *InstallProcessor) GetPipeLine() ([]func(cluster *v2.Cluster) error, error) {
	var todoList []func(cluster *v2.Cluster) error
	todoList = append(todoList,
		c.SyncStatusAndCheck,
		c.ConfirmOverrideApps,
		c.PreProcess,
		c.RunConfig,
		c.MountRootfs,
		c.MirrorRegistry,
		c.UpgradeIfNeed,
		// i.GetPhasePluginFunc(plugin.PhasePreGuest),
		c.RunGuest,
		c.PostProcess,
		// i.GetPhasePluginFunc(plugin.PhasePostInstall),
	)
	return todoList, nil
}

func (c *InstallProcessor) SyncStatusAndCheck(_ *v2.Cluster) error {
	logger.Info("Executing SyncStatusAndCheck Pipeline in InstallProcessor")
	err := c.ClusterFile.Process()
	if err != nil {
		return err
	}
	current := c.ClusterFile.GetCluster()
	if err = SyncClusterStatus(current, c.Buildah, false); err != nil {
		return err
	}
	imageList := sets.NewString(current.Spec.Image...)
	for _, img := range c.NewImages {
		if imageList.Has(img) {
			c.imagesToOverride = append(c.imagesToOverride, img)
		}
	}
	return nil
}

func (c *InstallProcessor) ConfirmOverrideApps(_ *v2.Cluster) error {
	logger.Info("Executing ConfirmOverrideApps Pipeline in InstallProcessor")

	if ForceOverride || len(c.imagesToOverride) == 0 {
		return nil
	}

	prompt := fmt.Sprintf("are you sure to override these following apps? \n%s\t", strings.Join(c.imagesToOverride, "\n"))
	cancelledMsg := "you have canceled to override these apps"
	pass, err := confirm.Confirm(prompt, cancelledMsg)
	if err != nil {
		return err
	}
	if !pass {
		// return a cancelled error to stop apply process.
		return ErrCancelled
	}
	ForceOverride = true
	return nil
}

func (c *InstallProcessor) PreProcess(cluster *v2.Cluster) error {
	logger.Info("Executing PreProcess Pipeline in InstallProcessor")
	if err := c.Buildah.Pull(c.NewImages, buildah.WithPullPolicyOption(buildah.PullIfMissing.String())); err != nil {
		return err
	}
	imageTypes := sets.NewString()
	for _, image := range c.NewImages {
		oci, err := c.Buildah.InspectImage(image)
		if err != nil {
			return err
		}
		if oci.OCIv1.Config.Labels != nil {
			imageTypes.Insert(maps.GetFromKeys(oci.OCIv1.Config.Labels, v2.ImageTypeKeys...))
		} else {
			imageTypes.Insert(string(v2.AppImage))
		}
	}
	for _, img := range c.NewImages {
		var ctrName string
		mount := cluster.FindImage(img)
		if mount != nil {
			if !ForceOverride {
				continue
			}
			logger.Debug("trying to override app %s", img)
			if err := c.Buildah.Delete(mount.Name); err != nil {
				return err
			}
		}
		ctrName = rand.Generator(8)
		cluster.Spec.Image = stringsutil.Merge(cluster.Spec.Image, img)
		bderInfo, err := c.Buildah.Create(ctrName, img)
		if err != nil {
			return err
		}
		mount = &v2.MountImage{
			Name:       bderInfo.Container,
			MountPoint: bderInfo.MountPoint,
			ImageName:  img,
		}

		if err = OCIToImageMount(c.Buildah, mount); err != nil {
			return err
		}
		mount.Env = maps.Merge(mount.Env, c.ExtraEnvs)

		cluster.SetMountImage(mount)
		c.NewMounts = append(c.NewMounts, *mount)
	}

	rt, err := factory.New(cluster, c.ClusterFile.GetRuntimeConfig())
	if err != nil {
		return fmt.Errorf("failed to init runtime, %v", err)
	}
	c.Runtime = rt
	return nil
}

func (c *InstallProcessor) UpgradeIfNeed(cluster *v2.Cluster) error {
	logger.Info("Executing UpgradeIfNeed Pipeline in InstallProcessor")
	for _, img := range c.NewMounts {
		version := img.KubeVersion()
		if version == "" {
			continue
		}
		err := c.Runtime.Upgrade(version)
		if err != nil {
			logger.Error("upgrade cluster failed")
			return err
		}
		//upgrade success; replace the old cluster mount
		cluster.ReplaceRootfsImage()
	}
	return nil
}

func (c *InstallProcessor) PostProcess(*v2.Cluster) error {
	if len(c.NewMounts) == 0 {
		logger.Info("no apps has been changed")
	} else {
		logger.Info("succeeded install app in this cluster")
	}
	return nil
}

func (c *InstallProcessor) RunConfig(_ *v2.Cluster) error {
	if len(c.NewMounts) == 0 {
		return nil
	}
	eg, _ := errgroup.WithContext(context.Background())
	for _, cManifest := range c.NewMounts {
		manifest := cManifest
		eg.Go(func() error {
			cfg := config.NewConfiguration(manifest.ImageName, manifest.MountPoint, c.ClusterFile.GetConfigs())
			return cfg.Dump()
		})
	}
	return eg.Wait()
}

func (c *InstallProcessor) MountRootfs(cluster *v2.Cluster) error {
	logger.Info("Executing pipeline MountRootfs in InstallProcessor.")
	if len(c.NewMounts) == 0 {
		return nil
	}
	hosts := append(cluster.GetMasterIPAndPortList(), cluster.GetNodeIPAndPortList()...)
	fs, err := rootfs.NewRootfsMounter(c.NewMounts)
	if err != nil {
		return err
	}
	return fs.MountRootfs(cluster, hosts)
}

func (c *InstallProcessor) MirrorRegistry(cluster *v2.Cluster) error {
	logger.Info("Executing pipeline MirrorRegistry in InstallProcessor.")
	return MirrorRegistry(cluster, c.NewMounts)
}

func (c *InstallProcessor) RunGuest(cluster *v2.Cluster) error {
	if len(c.NewMounts) == 0 {
		return nil
	}
	return c.Guest.Apply(cluster, c.NewMounts, cluster.GetAllIPS())
}

func NewInstallProcessor(ctx context.Context, clusterFile clusterfile.Interface, images []string) (Interface, error) {
	bder, err := buildah.New(clusterFile.GetCluster().Name)
	if err != nil {
		return nil, err
	}

	gs, err := guest.NewGuestManager()
	if err != nil {
		return nil, err
	}

	return &InstallProcessor{
		ClusterFile: clusterFile,
		Buildah:     bder,
		Guest:       gs,
		NewImages:   images,
		ExtraEnvs:   GetEnvs(ctx),
	}, nil
}