kubevela/pkg/resourcekeeper/dispatch.go

/*
Copyright 2021 The KubeVela Authors.

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 resourcekeeper

import (
	"context"
	"fmt"

	velaslices "github.com/kubevela/pkg/util/slices"
	"github.com/pkg/errors"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	utilfeature "k8s.io/apiserver/pkg/util/feature"

	"github.com/oam-dev/kubevela/apis/core.oam.dev/v1alpha1"
	"github.com/oam-dev/kubevela/pkg/auth"
	"github.com/oam-dev/kubevela/pkg/features"
	"github.com/oam-dev/kubevela/pkg/multicluster"
	"github.com/oam-dev/kubevela/pkg/oam"
	"github.com/oam-dev/kubevela/pkg/resourcetracker"
	"github.com/oam-dev/kubevela/pkg/utils/apply"
	velaerrors "github.com/oam-dev/kubevela/pkg/utils/errors"
)

// MaxDispatchConcurrent is the max dispatch concurrent number
var MaxDispatchConcurrent = 10

// DispatchOption option for dispatch
type DispatchOption interface {
	ApplyToDispatchConfig(*dispatchConfig)
}

type dispatchConfig struct {
	rtConfig
	metaOnly bool
	creator  string
}

func newDispatchConfig(options ...DispatchOption) *dispatchConfig {
	cfg := &dispatchConfig{}
	for _, option := range options {
		option.ApplyToDispatchConfig(cfg)
	}
	return cfg
}

// Dispatch dispatch resources
func (h *resourceKeeper) Dispatch(ctx context.Context, manifests []*unstructured.Unstructured, applyOpts []apply.ApplyOption, options ...DispatchOption) (err error) {
	if utilfeature.DefaultMutableFeatureGate.Enabled(features.ApplyOnce) ||
		(h.applyOncePolicy != nil && h.applyOncePolicy.Enable && h.applyOncePolicy.Rules == nil) {
		options = append(options, MetaOnlyOption{})
	}
	h.ClearNamespaceForClusterScopedResources(manifests)
	// 0. check admission
	if err = h.AdmissionCheck(ctx, manifests); err != nil {
		return err
	}
	// 1. pre-dispatch check
	opts := []apply.ApplyOption{apply.MustBeControlledByApp(h.app), apply.NotUpdateRenderHashEqual()}
	if len(applyOpts) > 0 {
		opts = append(opts, applyOpts...)
	}
	if utilfeature.DefaultMutableFeatureGate.Enabled(features.PreDispatchDryRun) {
		if err = h.dispatch(ctx,
			velaslices.Map(manifests, func(manifest *unstructured.Unstructured) *unstructured.Unstructured { return manifest.DeepCopy() }),
			append([]apply.ApplyOption{apply.DryRunAll()}, opts...)); err != nil {
			return fmt.Errorf("pre-dispatch dryrun failed: %w", err)
		}
	}
	// 2. record manifests in resourcetracker
	if err = h.record(ctx, manifests, options...); err != nil {
		return err
	}
	// 3. apply manifests
	return h.dispatch(ctx, manifests, opts)
}

func (h *resourceKeeper) record(ctx context.Context, manifests []*unstructured.Unstructured, options ...DispatchOption) error {
	h.mu.Lock()
	defer h.mu.Unlock()
	var skipGCManifests []*unstructured.Unstructured
	var rootManifests []*unstructured.Unstructured
	var versionManifests []*unstructured.Unstructured

	for _, manifest := range manifests {
		if manifest != nil {
			_options := options
			if h.garbageCollectPolicy != nil {
				if strategy := h.garbageCollectPolicy.FindStrategy(manifest); strategy != nil {
					_options = append(_options, GarbageCollectStrategyOption(*strategy))
				}
			}
			cfg := newDispatchConfig(_options...)
			switch {
			case cfg.skipGC:
				skipGCManifests = append(skipGCManifests, manifest)
			case cfg.useRoot:
				rootManifests = append(rootManifests, manifest)
			default:
				versionManifests = append(versionManifests, manifest)
			}
		}
	}

	cfg := newDispatchConfig(options...)
	ctx = auth.ContextClearUserInfo(ctx)
	if len(rootManifests)+len(skipGCManifests) != 0 {
		rt, err := h.getRootRT(ctx)
		if err != nil {
			return errors.Wrapf(err, "failed to get resourcetracker")
		}
		if err = resourcetracker.RecordManifestsInResourceTracker(multicluster.ContextInLocalCluster(ctx), h.Client, rt, rootManifests, cfg.metaOnly, false, cfg.creator); err != nil {
			return errors.Wrapf(err, "failed to record resources in resourcetracker %s", rt.Name)
		}
		if err = resourcetracker.RecordManifestsInResourceTracker(multicluster.ContextInLocalCluster(ctx), h.Client, rt, skipGCManifests, cfg.metaOnly, true, cfg.creator); err != nil {
			return errors.Wrapf(err, "failed to record resources (skip-gc) in resourcetracker %s", rt.Name)
		}
	}

	rt, err := h.getCurrentRT(ctx)
	if err != nil {
		return errors.Wrapf(err, "failed to get resourcetracker")
	}
	if err = resourcetracker.RecordManifestsInResourceTracker(multicluster.ContextInLocalCluster(ctx), h.Client, rt, versionManifests, cfg.metaOnly, false, cfg.creator); err != nil {
		return errors.Wrapf(err, "failed to record resources in resourcetracker %s", rt.Name)
	}
	return nil
}

func (h *resourceKeeper) dispatch(ctx context.Context, manifests []*unstructured.Unstructured, applyOpts []apply.ApplyOption) error {
	errs := velaslices.ParMap(manifests, func(manifest *unstructured.Unstructured) error {
		applyCtx := multicluster.ContextWithClusterName(ctx, oam.GetCluster(manifest))
		applyCtx = auth.ContextWithUserInfo(applyCtx, h.app)
		ao := applyOpts
		if h.isShared(manifest) {
			ao = append([]apply.ApplyOption{apply.SharedByApp(h.app)}, ao...)
		}
		if h.isReadOnly(manifest) {
			ao = append([]apply.ApplyOption{apply.ReadOnly()}, ao...)
		}
		if h.canTakeOver(manifest) {
			ao = append([]apply.ApplyOption{apply.TakeOver()}, ao...)
		}
		if strategy := h.getUpdateStrategy(manifest); strategy != nil {
			ao = append([]apply.ApplyOption{apply.WithUpdateStrategy(*strategy)}, ao...)
		}
		manifest, err := ApplyStrategies(applyCtx, h, manifest, v1alpha1.ApplyOnceStrategyOnAppUpdate)
		if err != nil {
			return errors.Wrapf(err, "failed to apply once policy for application %s,%s", h.app.Name, err.Error())
		}
		if manifest == nil {
			return nil
		}
		return h.applicator.Apply(applyCtx, manifest, ao...)
	}, velaslices.Parallelism(MaxDispatchConcurrent))
	return velaerrors.AggregateErrors(errs)
}