mirror of
https://github.com/k3s-io/k3s.git
synced 2024-06-07 19:41:36 +00:00
1013 lines
32 KiB
Go
1013 lines
32 KiB
Go
/*
|
|
Copyright 2014 The Kubernetes 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 apply
|
|
|
|
import (
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"net/http"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/jonboulle/clockwork"
|
|
"github.com/spf13/cobra"
|
|
corev1 "k8s.io/api/core/v1"
|
|
"k8s.io/apimachinery/pkg/api/errors"
|
|
"k8s.io/apimachinery/pkg/api/meta"
|
|
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
|
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
|
"k8s.io/apimachinery/pkg/runtime"
|
|
"k8s.io/apimachinery/pkg/runtime/schema"
|
|
"k8s.io/apimachinery/pkg/types"
|
|
"k8s.io/apimachinery/pkg/util/jsonmergepatch"
|
|
"k8s.io/apimachinery/pkg/util/mergepatch"
|
|
"k8s.io/apimachinery/pkg/util/sets"
|
|
"k8s.io/apimachinery/pkg/util/strategicpatch"
|
|
"k8s.io/apimachinery/pkg/util/wait"
|
|
"k8s.io/cli-runtime/pkg/genericclioptions"
|
|
"k8s.io/cli-runtime/pkg/printers"
|
|
"k8s.io/cli-runtime/pkg/resource"
|
|
"k8s.io/client-go/discovery"
|
|
"k8s.io/client-go/dynamic"
|
|
"k8s.io/klog"
|
|
oapi "k8s.io/kube-openapi/pkg/util/proto"
|
|
"k8s.io/kubectl/pkg/cmd/delete"
|
|
cmdutil "k8s.io/kubectl/pkg/cmd/util"
|
|
"k8s.io/kubectl/pkg/scheme"
|
|
"k8s.io/kubectl/pkg/util"
|
|
"k8s.io/kubectl/pkg/util/i18n"
|
|
"k8s.io/kubectl/pkg/util/openapi"
|
|
"k8s.io/kubectl/pkg/util/templates"
|
|
"k8s.io/kubectl/pkg/validation"
|
|
)
|
|
|
|
// ApplyOptions defines flags and other configuration parameters for the `apply` command
|
|
type ApplyOptions struct {
|
|
RecordFlags *genericclioptions.RecordFlags
|
|
Recorder genericclioptions.Recorder
|
|
|
|
PrintFlags *genericclioptions.PrintFlags
|
|
ToPrinter func(string) (printers.ResourcePrinter, error)
|
|
|
|
DeleteFlags *delete.DeleteFlags
|
|
DeleteOptions *delete.DeleteOptions
|
|
|
|
ServerSideApply bool
|
|
ForceConflicts bool
|
|
FieldManager string
|
|
Selector string
|
|
DryRun bool
|
|
ServerDryRun bool
|
|
Prune bool
|
|
PruneResources []pruneResource
|
|
cmdBaseName string
|
|
All bool
|
|
Overwrite bool
|
|
OpenAPIPatch bool
|
|
PruneWhitelist []string
|
|
|
|
Validator validation.Schema
|
|
Builder *resource.Builder
|
|
Mapper meta.RESTMapper
|
|
DynamicClient dynamic.Interface
|
|
DiscoveryClient discovery.DiscoveryInterface
|
|
OpenAPISchema openapi.Resources
|
|
|
|
Namespace string
|
|
EnforceNamespace bool
|
|
|
|
genericclioptions.IOStreams
|
|
}
|
|
|
|
const (
|
|
// maxPatchRetry is the maximum number of conflicts retry for during a patch operation before returning failure
|
|
maxPatchRetry = 5
|
|
// backOffPeriod is the period to back off when apply patch results in error.
|
|
backOffPeriod = 1 * time.Second
|
|
// how many times we can retry before back off
|
|
triesBeforeBackOff = 1
|
|
)
|
|
|
|
var (
|
|
applyLong = templates.LongDesc(i18n.T(`
|
|
Apply a configuration to a resource by filename or stdin.
|
|
The resource name must be specified. This resource will be created if it doesn't exist yet.
|
|
To use 'apply', always create the resource initially with either 'apply' or 'create --save-config'.
|
|
|
|
JSON and YAML formats are accepted.
|
|
|
|
Alpha Disclaimer: the --prune functionality is not yet complete. Do not use unless you are aware of what the current state is. See https://issues.k8s.io/34274.`))
|
|
|
|
applyExample = templates.Examples(i18n.T(`
|
|
# Apply the configuration in pod.json to a pod.
|
|
kubectl apply -f ./pod.json
|
|
|
|
# Apply resources from a directory containing kustomization.yaml - e.g. dir/kustomization.yaml.
|
|
kubectl apply -k dir/
|
|
|
|
# Apply the JSON passed into stdin to a pod.
|
|
cat pod.json | kubectl apply -f -
|
|
|
|
# Note: --prune is still in Alpha
|
|
# Apply the configuration in manifest.yaml that matches label app=nginx and delete all the other resources that are not in the file and match label app=nginx.
|
|
kubectl apply --prune -f manifest.yaml -l app=nginx
|
|
|
|
# Apply the configuration in manifest.yaml and delete all the other configmaps that are not in the file.
|
|
kubectl apply --prune -f manifest.yaml --all --prune-whitelist=core/v1/ConfigMap`))
|
|
|
|
warningNoLastAppliedConfigAnnotation = "Warning: %[1]s apply should be used on resource created by either %[1]s create --save-config or %[1]s apply\n"
|
|
)
|
|
|
|
// NewApplyOptions creates new ApplyOptions for the `apply` command
|
|
func NewApplyOptions(ioStreams genericclioptions.IOStreams) *ApplyOptions {
|
|
return &ApplyOptions{
|
|
RecordFlags: genericclioptions.NewRecordFlags(),
|
|
DeleteFlags: delete.NewDeleteFlags("that contains the configuration to apply"),
|
|
PrintFlags: genericclioptions.NewPrintFlags("created").WithTypeSetter(scheme.Scheme),
|
|
|
|
Overwrite: true,
|
|
OpenAPIPatch: true,
|
|
|
|
Recorder: genericclioptions.NoopRecorder{},
|
|
|
|
IOStreams: ioStreams,
|
|
}
|
|
}
|
|
|
|
// NewCmdApply creates the `apply` command
|
|
func NewCmdApply(baseName string, f cmdutil.Factory, ioStreams genericclioptions.IOStreams) *cobra.Command {
|
|
o := NewApplyOptions(ioStreams)
|
|
|
|
// Store baseName for use in printing warnings / messages involving the base command name.
|
|
// This is useful for downstream command that wrap this one.
|
|
o.cmdBaseName = baseName
|
|
|
|
cmd := &cobra.Command{
|
|
Use: "apply (-f FILENAME | -k DIRECTORY)",
|
|
DisableFlagsInUseLine: true,
|
|
Short: i18n.T("Apply a configuration to a resource by filename or stdin"),
|
|
Long: applyLong,
|
|
Example: applyExample,
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
cmdutil.CheckErr(o.Complete(f, cmd))
|
|
cmdutil.CheckErr(validateArgs(cmd, args))
|
|
cmdutil.CheckErr(validatePruneAll(o.Prune, o.All, o.Selector))
|
|
cmdutil.CheckErr(o.Run())
|
|
},
|
|
}
|
|
|
|
// bind flag structs
|
|
o.DeleteFlags.AddFlags(cmd)
|
|
o.RecordFlags.AddFlags(cmd)
|
|
o.PrintFlags.AddFlags(cmd)
|
|
|
|
cmd.Flags().BoolVar(&o.Overwrite, "overwrite", o.Overwrite, "Automatically resolve conflicts between the modified and live configuration by using values from the modified configuration")
|
|
cmd.Flags().BoolVar(&o.Prune, "prune", o.Prune, "Automatically delete resource objects, including the uninitialized ones, that do not appear in the configs and are created by either apply or create --save-config. Should be used with either -l or --all.")
|
|
cmdutil.AddValidateFlags(cmd)
|
|
cmd.Flags().StringVarP(&o.Selector, "selector", "l", o.Selector, "Selector (label query) to filter on, supports '=', '==', and '!='.(e.g. -l key1=value1,key2=value2)")
|
|
cmd.Flags().BoolVar(&o.All, "all", o.All, "Select all resources in the namespace of the specified resource types.")
|
|
cmd.Flags().StringArrayVar(&o.PruneWhitelist, "prune-whitelist", o.PruneWhitelist, "Overwrite the default whitelist with <group/version/kind> for --prune")
|
|
cmd.Flags().BoolVar(&o.OpenAPIPatch, "openapi-patch", o.OpenAPIPatch, "If true, use openapi to calculate diff when the openapi presents and the resource can be found in the openapi spec. Otherwise, fall back to use baked-in types.")
|
|
cmd.Flags().BoolVar(&o.ServerDryRun, "server-dry-run", o.ServerDryRun, "If true, request will be sent to server with dry-run flag, which means the modifications won't be persisted. This is an alpha feature and flag.")
|
|
cmd.Flags().Bool("dry-run", false, "If true, only print the object that would be sent, without sending it. Warning: --dry-run cannot accurately output the result of merging the local manifest and the server-side data. Use --server-dry-run to get the merged result instead.")
|
|
cmdutil.AddIncludeUninitializedFlag(cmd)
|
|
cmdutil.AddServerSideApplyFlags(cmd)
|
|
|
|
// apply subcommands
|
|
cmd.AddCommand(NewCmdApplyViewLastApplied(f, ioStreams))
|
|
cmd.AddCommand(NewCmdApplySetLastApplied(f, ioStreams))
|
|
cmd.AddCommand(NewCmdApplyEditLastApplied(f, ioStreams))
|
|
|
|
return cmd
|
|
}
|
|
|
|
// Complete verifies if ApplyOptions are valid and without conflicts.
|
|
func (o *ApplyOptions) Complete(f cmdutil.Factory, cmd *cobra.Command) error {
|
|
o.ServerSideApply = cmdutil.GetServerSideApplyFlag(cmd)
|
|
o.ForceConflicts = cmdutil.GetForceConflictsFlag(cmd)
|
|
o.FieldManager = cmdutil.GetFieldManagerFlag(cmd)
|
|
o.DryRun = cmdutil.GetDryRunFlag(cmd)
|
|
|
|
if o.ForceConflicts && !o.ServerSideApply {
|
|
return fmt.Errorf("--force-conflicts only works with --server-side")
|
|
}
|
|
|
|
if o.DryRun && o.ServerSideApply {
|
|
return fmt.Errorf("--dry-run doesn't work with --server-side (did you mean --server-dry-run instead?)")
|
|
}
|
|
|
|
if o.DryRun && o.ServerDryRun {
|
|
return fmt.Errorf("--dry-run and --server-dry-run can't be used together")
|
|
}
|
|
|
|
// allow for a success message operation to be specified at print time
|
|
o.ToPrinter = func(operation string) (printers.ResourcePrinter, error) {
|
|
o.PrintFlags.NamePrintFlags.Operation = operation
|
|
if o.DryRun {
|
|
o.PrintFlags.Complete("%s (dry run)")
|
|
}
|
|
if o.ServerDryRun {
|
|
o.PrintFlags.Complete("%s (server dry run)")
|
|
}
|
|
return o.PrintFlags.ToPrinter()
|
|
}
|
|
|
|
var err error
|
|
o.RecordFlags.Complete(cmd)
|
|
o.Recorder, err = o.RecordFlags.ToRecorder()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
o.DiscoveryClient, err = f.ToDiscoveryClient()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
dynamicClient, err := f.DynamicClient()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
o.DeleteOptions = o.DeleteFlags.ToOptions(dynamicClient, o.IOStreams)
|
|
err = o.DeleteOptions.FilenameOptions.RequireFilenameOrKustomize()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
o.OpenAPISchema, _ = f.OpenAPISchema()
|
|
o.Validator, err = f.Validator(cmdutil.GetFlagBool(cmd, "validate"))
|
|
o.Builder = f.NewBuilder()
|
|
o.Mapper, err = f.ToRESTMapper()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
o.DynamicClient, err = f.DynamicClient()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
o.Namespace, o.EnforceNamespace, err = f.ToRawKubeConfigLoader().Namespace()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func validateArgs(cmd *cobra.Command, args []string) error {
|
|
if len(args) != 0 {
|
|
return cmdutil.UsageErrorf(cmd, "Unexpected args: %v", args)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func validatePruneAll(prune, all bool, selector string) error {
|
|
if all && len(selector) > 0 {
|
|
return fmt.Errorf("cannot set --all and --selector at the same time")
|
|
}
|
|
if prune && !all && selector == "" {
|
|
return fmt.Errorf("all resources selected for prune without explicitly passing --all. To prune all resources, pass the --all flag. If you did not mean to prune all resources, specify a label selector")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func parsePruneResources(mapper meta.RESTMapper, gvks []string) ([]pruneResource, error) {
|
|
pruneResources := []pruneResource{}
|
|
for _, groupVersionKind := range gvks {
|
|
gvk := strings.Split(groupVersionKind, "/")
|
|
if len(gvk) != 3 {
|
|
return nil, fmt.Errorf("invalid GroupVersionKind format: %v, please follow <group/version/kind>", groupVersionKind)
|
|
}
|
|
|
|
if gvk[0] == "core" {
|
|
gvk[0] = ""
|
|
}
|
|
mapping, err := mapper.RESTMapping(schema.GroupKind{Group: gvk[0], Kind: gvk[2]}, gvk[1])
|
|
if err != nil {
|
|
return pruneResources, err
|
|
}
|
|
var namespaced bool
|
|
namespaceScope := mapping.Scope.Name()
|
|
switch namespaceScope {
|
|
case meta.RESTScopeNameNamespace:
|
|
namespaced = true
|
|
case meta.RESTScopeNameRoot:
|
|
namespaced = false
|
|
default:
|
|
return pruneResources, fmt.Errorf("Unknown namespace scope: %q", namespaceScope)
|
|
}
|
|
|
|
pruneResources = append(pruneResources, pruneResource{gvk[0], gvk[1], gvk[2], namespaced})
|
|
}
|
|
return pruneResources, nil
|
|
}
|
|
|
|
func isIncompatibleServerError(err error) bool {
|
|
// 415: Unsupported media type means we're talking to a server which doesn't
|
|
// support server-side apply.
|
|
if _, ok := err.(*errors.StatusError); !ok {
|
|
// Non-StatusError means the error isn't because the server is incompatible.
|
|
return false
|
|
}
|
|
return err.(*errors.StatusError).Status().Code == http.StatusUnsupportedMediaType
|
|
}
|
|
|
|
// Run executes the `apply` command.
|
|
func (o *ApplyOptions) Run() error {
|
|
var openapiSchema openapi.Resources
|
|
if o.OpenAPIPatch {
|
|
openapiSchema = o.OpenAPISchema
|
|
}
|
|
|
|
dryRunVerifier := &DryRunVerifier{
|
|
Finder: cmdutil.NewCRDFinder(cmdutil.CRDFromDynamic(o.DynamicClient)),
|
|
OpenAPIGetter: o.DiscoveryClient,
|
|
}
|
|
|
|
// include the uninitialized objects by default if --prune is true
|
|
// unless explicitly set --include-uninitialized=false
|
|
r := o.Builder.
|
|
Unstructured().
|
|
Schema(o.Validator).
|
|
ContinueOnError().
|
|
NamespaceParam(o.Namespace).DefaultNamespace().
|
|
FilenameParam(o.EnforceNamespace, &o.DeleteOptions.FilenameOptions).
|
|
LabelSelectorParam(o.Selector).
|
|
Flatten().
|
|
Do()
|
|
if err := r.Err(); err != nil {
|
|
return err
|
|
}
|
|
|
|
var err error
|
|
if o.Prune {
|
|
o.PruneResources, err = parsePruneResources(o.Mapper, o.PruneWhitelist)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
output := *o.PrintFlags.OutputFormat
|
|
shortOutput := output == "name"
|
|
|
|
visitedUids := sets.NewString()
|
|
visitedNamespaces := sets.NewString()
|
|
|
|
var objs []runtime.Object
|
|
|
|
count := 0
|
|
err = r.Visit(func(info *resource.Info, err error) error {
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// If server-dry-run is requested but the type doesn't support it, fail right away.
|
|
if o.ServerDryRun {
|
|
if err := dryRunVerifier.HasSupport(info.Mapping.GroupVersionKind); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if info.Namespaced() {
|
|
visitedNamespaces.Insert(info.Namespace)
|
|
}
|
|
|
|
if err := o.Recorder.Record(info.Object); err != nil {
|
|
klog.V(4).Infof("error recording current command: %v", err)
|
|
}
|
|
|
|
if o.ServerSideApply {
|
|
// Send the full object to be applied on the server side.
|
|
data, err := runtime.Encode(unstructured.UnstructuredJSONScheme, info.Object)
|
|
if err != nil {
|
|
return cmdutil.AddSourceToErr("serverside-apply", info.Source, err)
|
|
}
|
|
|
|
options := metav1.PatchOptions{
|
|
Force: &o.ForceConflicts,
|
|
FieldManager: o.FieldManager,
|
|
}
|
|
if o.ServerDryRun {
|
|
options.DryRun = []string{metav1.DryRunAll}
|
|
}
|
|
|
|
obj, err := resource.NewHelper(info.Client, info.Mapping).Patch(
|
|
info.Namespace,
|
|
info.Name,
|
|
types.ApplyPatchType,
|
|
data,
|
|
&options,
|
|
)
|
|
if err != nil {
|
|
if isIncompatibleServerError(err) {
|
|
err = fmt.Errorf("Server-side apply not available on the server: (%v)", err)
|
|
}
|
|
if errors.IsConflict(err) {
|
|
err = fmt.Errorf(`%v
|
|
|
|
Please review the fields above--they currently have other managers. Here
|
|
are the ways you can resolve this warning:
|
|
* If you intend to manage all of these fields, please re-run the apply
|
|
command with the `+"`--force-conflicts`"+` flag.
|
|
* If you do not intend to manage all of the fields, please edit your
|
|
manifest to remove references to the fields that should keep their
|
|
current managers.
|
|
* You may co-own fields by updating your manifest to match the existing
|
|
value; in this case, you'll become the manager if the other manager(s)
|
|
stop managing the field (remove it from their configuration).
|
|
|
|
See http://k8s.io/docs/reference/using-api/api-concepts/#conflicts`, err)
|
|
}
|
|
return err
|
|
}
|
|
|
|
info.Refresh(obj, true)
|
|
metadata, err := meta.Accessor(info.Object)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
visitedUids.Insert(string(metadata.GetUID()))
|
|
count++
|
|
if len(output) > 0 && !shortOutput {
|
|
objs = append(objs, info.Object)
|
|
return nil
|
|
}
|
|
|
|
printer, err := o.ToPrinter("serverside-applied")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return printer.PrintObj(info.Object, o.Out)
|
|
}
|
|
|
|
// Get the modified configuration of the object. Embed the result
|
|
// as an annotation in the modified configuration, so that it will appear
|
|
// in the patch sent to the server.
|
|
modified, err := util.GetModifiedConfiguration(info.Object, true, unstructured.UnstructuredJSONScheme)
|
|
if err != nil {
|
|
return cmdutil.AddSourceToErr(fmt.Sprintf("retrieving modified configuration from:\n%s\nfor:", info.String()), info.Source, err)
|
|
}
|
|
|
|
// Print object only if output format other than "name" is specified
|
|
printObject := len(output) > 0 && !shortOutput
|
|
|
|
if err := info.Get(); err != nil {
|
|
if !errors.IsNotFound(err) {
|
|
return cmdutil.AddSourceToErr(fmt.Sprintf("retrieving current configuration of:\n%s\nfrom server for:", info.String()), info.Source, err)
|
|
}
|
|
|
|
// Create the resource if it doesn't exist
|
|
// First, update the annotation used by kubectl apply
|
|
if err := util.CreateApplyAnnotation(info.Object, unstructured.UnstructuredJSONScheme); err != nil {
|
|
return cmdutil.AddSourceToErr("creating", info.Source, err)
|
|
}
|
|
|
|
if !o.DryRun {
|
|
// Then create the resource and skip the three-way merge
|
|
options := metav1.CreateOptions{}
|
|
if o.ServerDryRun {
|
|
options.DryRun = []string{metav1.DryRunAll}
|
|
}
|
|
obj, err := resource.NewHelper(info.Client, info.Mapping).Create(info.Namespace, true, info.Object, &options)
|
|
if err != nil {
|
|
return cmdutil.AddSourceToErr("creating", info.Source, err)
|
|
}
|
|
info.Refresh(obj, true)
|
|
}
|
|
|
|
metadata, err := meta.Accessor(info.Object)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
visitedUids.Insert(string(metadata.GetUID()))
|
|
|
|
count++
|
|
|
|
if printObject {
|
|
objs = append(objs, info.Object)
|
|
return nil
|
|
}
|
|
|
|
printer, err := o.ToPrinter("created")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return printer.PrintObj(info.Object, o.Out)
|
|
}
|
|
|
|
metadata, err := meta.Accessor(info.Object)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
visitedUids.Insert(string(metadata.GetUID()))
|
|
|
|
if !o.DryRun {
|
|
annotationMap := metadata.GetAnnotations()
|
|
if _, ok := annotationMap[corev1.LastAppliedConfigAnnotation]; !ok {
|
|
fmt.Fprintf(o.ErrOut, warningNoLastAppliedConfigAnnotation, o.cmdBaseName)
|
|
}
|
|
|
|
helper := resource.NewHelper(info.Client, info.Mapping)
|
|
patcher := &Patcher{
|
|
Mapping: info.Mapping,
|
|
Helper: helper,
|
|
DynamicClient: o.DynamicClient,
|
|
Overwrite: o.Overwrite,
|
|
BackOff: clockwork.NewRealClock(),
|
|
Force: o.DeleteOptions.ForceDeletion,
|
|
Cascade: o.DeleteOptions.Cascade,
|
|
Timeout: o.DeleteOptions.Timeout,
|
|
GracePeriod: o.DeleteOptions.GracePeriod,
|
|
ServerDryRun: o.ServerDryRun,
|
|
OpenapiSchema: openapiSchema,
|
|
Retries: maxPatchRetry,
|
|
}
|
|
|
|
patchBytes, patchedObject, err := patcher.Patch(info.Object, modified, info.Source, info.Namespace, info.Name, o.ErrOut)
|
|
if err != nil {
|
|
return cmdutil.AddSourceToErr(fmt.Sprintf("applying patch:\n%s\nto:\n%v\nfor:", patchBytes, info), info.Source, err)
|
|
}
|
|
|
|
info.Refresh(patchedObject, true)
|
|
|
|
if string(patchBytes) == "{}" && !printObject {
|
|
count++
|
|
|
|
printer, err := o.ToPrinter("unchanged")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return printer.PrintObj(info.Object, o.Out)
|
|
}
|
|
}
|
|
count++
|
|
|
|
if printObject {
|
|
objs = append(objs, info.Object)
|
|
return nil
|
|
}
|
|
|
|
printer, err := o.ToPrinter("configured")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return printer.PrintObj(info.Object, o.Out)
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if count == 0 {
|
|
return fmt.Errorf("no objects passed to apply")
|
|
}
|
|
|
|
// print objects
|
|
if len(objs) > 0 {
|
|
printer, err := o.ToPrinter("")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
objToPrint := objs[0]
|
|
if len(objs) > 1 {
|
|
list := &corev1.List{
|
|
TypeMeta: metav1.TypeMeta{
|
|
Kind: "List",
|
|
APIVersion: "v1",
|
|
},
|
|
ListMeta: metav1.ListMeta{},
|
|
}
|
|
if err := meta.SetList(list, objs); err != nil {
|
|
return err
|
|
}
|
|
|
|
objToPrint = list
|
|
}
|
|
if err := printer.PrintObj(objToPrint, o.Out); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
if !o.Prune {
|
|
return nil
|
|
}
|
|
|
|
p := pruner{
|
|
mapper: o.Mapper,
|
|
dynamicClient: o.DynamicClient,
|
|
|
|
labelSelector: o.Selector,
|
|
visitedUids: visitedUids,
|
|
|
|
cascade: o.DeleteOptions.Cascade,
|
|
dryRun: o.DryRun,
|
|
serverDryRun: o.ServerDryRun,
|
|
gracePeriod: o.DeleteOptions.GracePeriod,
|
|
|
|
toPrinter: o.ToPrinter,
|
|
|
|
out: o.Out,
|
|
}
|
|
|
|
namespacedRESTMappings, nonNamespacedRESTMappings, err := getRESTMappings(o.Mapper, &(o.PruneResources))
|
|
if err != nil {
|
|
return fmt.Errorf("error retrieving RESTMappings to prune: %v", err)
|
|
}
|
|
|
|
for n := range visitedNamespaces {
|
|
for _, m := range namespacedRESTMappings {
|
|
if err := p.prune(n, m); err != nil {
|
|
return fmt.Errorf("error pruning namespaced object %v: %v", m.GroupVersionKind, err)
|
|
}
|
|
}
|
|
}
|
|
for _, m := range nonNamespacedRESTMappings {
|
|
if err := p.prune(metav1.NamespaceNone, m); err != nil {
|
|
return fmt.Errorf("error pruning nonNamespaced object %v: %v", m.GroupVersionKind, err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
type pruneResource struct {
|
|
group string
|
|
version string
|
|
kind string
|
|
namespaced bool
|
|
}
|
|
|
|
func (pr pruneResource) String() string {
|
|
return fmt.Sprintf("%v/%v, Kind=%v, Namespaced=%v", pr.group, pr.version, pr.kind, pr.namespaced)
|
|
}
|
|
|
|
func getRESTMappings(mapper meta.RESTMapper, pruneResources *[]pruneResource) (namespaced, nonNamespaced []*meta.RESTMapping, err error) {
|
|
if len(*pruneResources) == 0 {
|
|
// default whitelist
|
|
// TODO: need to handle the older api versions - e.g. v1beta1 jobs. Github issue: #35991
|
|
*pruneResources = []pruneResource{
|
|
{"", "v1", "ConfigMap", true},
|
|
{"", "v1", "Endpoints", true},
|
|
{"", "v1", "Namespace", false},
|
|
{"", "v1", "PersistentVolumeClaim", true},
|
|
{"", "v1", "PersistentVolume", false},
|
|
{"", "v1", "Pod", true},
|
|
{"", "v1", "ReplicationController", true},
|
|
{"", "v1", "Secret", true},
|
|
{"", "v1", "Service", true},
|
|
{"batch", "v1", "Job", true},
|
|
{"batch", "v1beta1", "CronJob", true},
|
|
{"extensions", "v1beta1", "Ingress", true},
|
|
{"apps", "v1", "DaemonSet", true},
|
|
{"apps", "v1", "Deployment", true},
|
|
{"apps", "v1", "ReplicaSet", true},
|
|
{"apps", "v1", "StatefulSet", true},
|
|
}
|
|
}
|
|
|
|
for _, resource := range *pruneResources {
|
|
addedMapping, err := mapper.RESTMapping(schema.GroupKind{Group: resource.group, Kind: resource.kind}, resource.version)
|
|
if err != nil {
|
|
return nil, nil, fmt.Errorf("invalid resource %v: %v", resource, err)
|
|
}
|
|
if resource.namespaced {
|
|
namespaced = append(namespaced, addedMapping)
|
|
} else {
|
|
nonNamespaced = append(nonNamespaced, addedMapping)
|
|
}
|
|
}
|
|
|
|
return namespaced, nonNamespaced, nil
|
|
}
|
|
|
|
type pruner struct {
|
|
mapper meta.RESTMapper
|
|
dynamicClient dynamic.Interface
|
|
|
|
visitedUids sets.String
|
|
labelSelector string
|
|
fieldSelector string
|
|
|
|
cascade bool
|
|
serverDryRun bool
|
|
dryRun bool
|
|
gracePeriod int
|
|
|
|
toPrinter func(string) (printers.ResourcePrinter, error)
|
|
|
|
out io.Writer
|
|
}
|
|
|
|
func (p *pruner) prune(namespace string, mapping *meta.RESTMapping) error {
|
|
objList, err := p.dynamicClient.Resource(mapping.Resource).
|
|
Namespace(namespace).
|
|
List(metav1.ListOptions{
|
|
LabelSelector: p.labelSelector,
|
|
FieldSelector: p.fieldSelector,
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
objs, err := meta.ExtractList(objList)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
for _, obj := range objs {
|
|
metadata, err := meta.Accessor(obj)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
annots := metadata.GetAnnotations()
|
|
if _, ok := annots[corev1.LastAppliedConfigAnnotation]; !ok {
|
|
// don't prune resources not created with apply
|
|
continue
|
|
}
|
|
uid := metadata.GetUID()
|
|
if p.visitedUids.Has(string(uid)) {
|
|
continue
|
|
}
|
|
name := metadata.GetName()
|
|
if !p.dryRun {
|
|
if err := p.delete(namespace, name, mapping); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
|
|
printer, err := p.toPrinter("pruned")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
printer.PrintObj(obj, p.out)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (p *pruner) delete(namespace, name string, mapping *meta.RESTMapping) error {
|
|
return runDelete(namespace, name, mapping, p.dynamicClient, p.cascade, p.gracePeriod, p.serverDryRun)
|
|
}
|
|
|
|
func runDelete(namespace, name string, mapping *meta.RESTMapping, c dynamic.Interface, cascade bool, gracePeriod int, serverDryRun bool) error {
|
|
options := &metav1.DeleteOptions{}
|
|
if gracePeriod >= 0 {
|
|
options = metav1.NewDeleteOptions(int64(gracePeriod))
|
|
}
|
|
if serverDryRun {
|
|
options.DryRun = []string{metav1.DryRunAll}
|
|
}
|
|
policy := metav1.DeletePropagationForeground
|
|
if !cascade {
|
|
policy = metav1.DeletePropagationOrphan
|
|
}
|
|
options.PropagationPolicy = &policy
|
|
return c.Resource(mapping.Resource).Namespace(namespace).Delete(name, options)
|
|
}
|
|
|
|
func (p *Patcher) delete(namespace, name string) error {
|
|
return runDelete(namespace, name, p.Mapping, p.DynamicClient, p.Cascade, p.GracePeriod, p.ServerDryRun)
|
|
}
|
|
|
|
// Patcher defines options to patch OpenAPI objects.
|
|
type Patcher struct {
|
|
Mapping *meta.RESTMapping
|
|
Helper *resource.Helper
|
|
DynamicClient dynamic.Interface
|
|
|
|
Overwrite bool
|
|
BackOff clockwork.Clock
|
|
|
|
Force bool
|
|
Cascade bool
|
|
Timeout time.Duration
|
|
GracePeriod int
|
|
ServerDryRun bool
|
|
|
|
// If set, forces the patch against a specific resourceVersion
|
|
ResourceVersion *string
|
|
|
|
// Number of retries to make if the patch fails with conflict
|
|
Retries int
|
|
|
|
OpenapiSchema openapi.Resources
|
|
}
|
|
|
|
// DryRunVerifier verifies if a given group-version-kind supports DryRun
|
|
// against the current server. Sending dryRun requests to apiserver that
|
|
// don't support it will result in objects being unwillingly persisted.
|
|
//
|
|
// It reads the OpenAPI to see if the given GVK supports dryRun. If the
|
|
// GVK can not be found, we assume that CRDs will have the same level of
|
|
// support as "namespaces", and non-CRDs will not be supported. We
|
|
// delay the check for CRDs as much as possible though, since it
|
|
// requires an extra round-trip to the server.
|
|
type DryRunVerifier struct {
|
|
Finder cmdutil.CRDFinder
|
|
OpenAPIGetter discovery.OpenAPISchemaInterface
|
|
}
|
|
|
|
// HasSupport verifies if the given gvk supports DryRun. An error is
|
|
// returned if it doesn't.
|
|
func (v *DryRunVerifier) HasSupport(gvk schema.GroupVersionKind) error {
|
|
oapi, err := v.OpenAPIGetter.OpenAPISchema()
|
|
if err != nil {
|
|
return fmt.Errorf("failed to download openapi: %v", err)
|
|
}
|
|
supports, err := openapi.SupportsDryRun(oapi, gvk)
|
|
if err != nil {
|
|
// We assume that we couldn't find the type, then check for namespace:
|
|
supports, _ = openapi.SupportsDryRun(oapi, schema.GroupVersionKind{Group: "", Version: "v1", Kind: "Namespace"})
|
|
// If namespace supports dryRun, then we will support dryRun for CRDs only.
|
|
if supports {
|
|
supports, err = v.Finder.HasCRD(gvk.GroupKind())
|
|
if err != nil {
|
|
return fmt.Errorf("failed to check CRD: %v", err)
|
|
}
|
|
}
|
|
}
|
|
if !supports {
|
|
return fmt.Errorf("%v doesn't support dry-run", gvk)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func addResourceVersion(patch []byte, rv string) ([]byte, error) {
|
|
var patchMap map[string]interface{}
|
|
err := json.Unmarshal(patch, &patchMap)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
u := unstructured.Unstructured{Object: patchMap}
|
|
a, err := meta.Accessor(&u)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
a.SetResourceVersion(rv)
|
|
|
|
return json.Marshal(patchMap)
|
|
}
|
|
|
|
func (p *Patcher) patchSimple(obj runtime.Object, modified []byte, source, namespace, name string, errOut io.Writer) ([]byte, runtime.Object, error) {
|
|
// Serialize the current configuration of the object from the server.
|
|
current, err := runtime.Encode(unstructured.UnstructuredJSONScheme, obj)
|
|
if err != nil {
|
|
return nil, nil, cmdutil.AddSourceToErr(fmt.Sprintf("serializing current configuration from:\n%v\nfor:", obj), source, err)
|
|
}
|
|
|
|
// Retrieve the original configuration of the object from the annotation.
|
|
original, err := util.GetOriginalConfiguration(obj)
|
|
if err != nil {
|
|
return nil, nil, cmdutil.AddSourceToErr(fmt.Sprintf("retrieving original configuration from:\n%v\nfor:", obj), source, err)
|
|
}
|
|
|
|
var patchType types.PatchType
|
|
var patch []byte
|
|
var lookupPatchMeta strategicpatch.LookupPatchMeta
|
|
var schema oapi.Schema
|
|
createPatchErrFormat := "creating patch with:\noriginal:\n%s\nmodified:\n%s\ncurrent:\n%s\nfor:"
|
|
|
|
// Create the versioned struct from the type defined in the restmapping
|
|
// (which is the API version we'll be submitting the patch to)
|
|
versionedObject, err := scheme.Scheme.New(p.Mapping.GroupVersionKind)
|
|
switch {
|
|
case runtime.IsNotRegisteredError(err):
|
|
// fall back to generic JSON merge patch
|
|
patchType = types.MergePatchType
|
|
preconditions := []mergepatch.PreconditionFunc{mergepatch.RequireKeyUnchanged("apiVersion"),
|
|
mergepatch.RequireKeyUnchanged("kind"), mergepatch.RequireMetadataKeyUnchanged("name")}
|
|
patch, err = jsonmergepatch.CreateThreeWayJSONMergePatch(original, modified, current, preconditions...)
|
|
if err != nil {
|
|
if mergepatch.IsPreconditionFailed(err) {
|
|
return nil, nil, fmt.Errorf("%s", "At least one of apiVersion, kind and name was changed")
|
|
}
|
|
return nil, nil, cmdutil.AddSourceToErr(fmt.Sprintf(createPatchErrFormat, original, modified, current), source, err)
|
|
}
|
|
case err != nil:
|
|
return nil, nil, cmdutil.AddSourceToErr(fmt.Sprintf("getting instance of versioned object for %v:", p.Mapping.GroupVersionKind), source, err)
|
|
case err == nil:
|
|
// Compute a three way strategic merge patch to send to server.
|
|
patchType = types.StrategicMergePatchType
|
|
|
|
// Try to use openapi first if the openapi spec is available and can successfully calculate the patch.
|
|
// Otherwise, fall back to baked-in types.
|
|
if p.OpenapiSchema != nil {
|
|
if schema = p.OpenapiSchema.LookupResource(p.Mapping.GroupVersionKind); schema != nil {
|
|
lookupPatchMeta = strategicpatch.PatchMetaFromOpenAPI{Schema: schema}
|
|
if openapiPatch, err := strategicpatch.CreateThreeWayMergePatch(original, modified, current, lookupPatchMeta, p.Overwrite); err != nil {
|
|
fmt.Fprintf(errOut, "warning: error calculating patch from openapi spec: %v\n", err)
|
|
} else {
|
|
patchType = types.StrategicMergePatchType
|
|
patch = openapiPatch
|
|
}
|
|
}
|
|
}
|
|
|
|
if patch == nil {
|
|
lookupPatchMeta, err = strategicpatch.NewPatchMetaFromStruct(versionedObject)
|
|
if err != nil {
|
|
return nil, nil, cmdutil.AddSourceToErr(fmt.Sprintf(createPatchErrFormat, original, modified, current), source, err)
|
|
}
|
|
patch, err = strategicpatch.CreateThreeWayMergePatch(original, modified, current, lookupPatchMeta, p.Overwrite)
|
|
if err != nil {
|
|
return nil, nil, cmdutil.AddSourceToErr(fmt.Sprintf(createPatchErrFormat, original, modified, current), source, err)
|
|
}
|
|
}
|
|
}
|
|
|
|
if string(patch) == "{}" {
|
|
return patch, obj, nil
|
|
}
|
|
|
|
if p.ResourceVersion != nil {
|
|
patch, err = addResourceVersion(patch, *p.ResourceVersion)
|
|
if err != nil {
|
|
return nil, nil, cmdutil.AddSourceToErr("Failed to insert resourceVersion in patch", source, err)
|
|
}
|
|
}
|
|
|
|
options := metav1.PatchOptions{}
|
|
if p.ServerDryRun {
|
|
options.DryRun = []string{metav1.DryRunAll}
|
|
}
|
|
|
|
patchedObj, err := p.Helper.Patch(namespace, name, patchType, patch, &options)
|
|
return patch, patchedObj, err
|
|
}
|
|
|
|
// Patch tries to patch an OpenAPI resource. On success, returns the merge patch as well
|
|
// the final patched object. On failure, returns an error.
|
|
func (p *Patcher) Patch(current runtime.Object, modified []byte, source, namespace, name string, errOut io.Writer) ([]byte, runtime.Object, error) {
|
|
var getErr error
|
|
patchBytes, patchObject, err := p.patchSimple(current, modified, source, namespace, name, errOut)
|
|
if p.Retries == 0 {
|
|
p.Retries = maxPatchRetry
|
|
}
|
|
for i := 1; i <= p.Retries && errors.IsConflict(err); i++ {
|
|
if i > triesBeforeBackOff {
|
|
p.BackOff.Sleep(backOffPeriod)
|
|
}
|
|
current, getErr = p.Helper.Get(namespace, name, false)
|
|
if getErr != nil {
|
|
return nil, nil, getErr
|
|
}
|
|
patchBytes, patchObject, err = p.patchSimple(current, modified, source, namespace, name, errOut)
|
|
}
|
|
if err != nil && (errors.IsConflict(err) || errors.IsInvalid(err)) && p.Force {
|
|
patchBytes, patchObject, err = p.deleteAndCreate(current, modified, namespace, name)
|
|
}
|
|
return patchBytes, patchObject, err
|
|
}
|
|
|
|
func (p *Patcher) deleteAndCreate(original runtime.Object, modified []byte, namespace, name string) ([]byte, runtime.Object, error) {
|
|
if err := p.delete(namespace, name); err != nil {
|
|
return modified, nil, err
|
|
}
|
|
// TODO: use wait
|
|
if err := wait.PollImmediate(1*time.Second, p.Timeout, func() (bool, error) {
|
|
if _, err := p.Helper.Get(namespace, name, false); !errors.IsNotFound(err) {
|
|
return false, err
|
|
}
|
|
return true, nil
|
|
}); err != nil {
|
|
return modified, nil, err
|
|
}
|
|
versionedObject, _, err := unstructured.UnstructuredJSONScheme.Decode(modified, nil, nil)
|
|
if err != nil {
|
|
return modified, nil, err
|
|
}
|
|
options := metav1.CreateOptions{}
|
|
if p.ServerDryRun {
|
|
options.DryRun = []string{metav1.DryRunAll}
|
|
}
|
|
createdObject, err := p.Helper.Create(namespace, true, versionedObject, &options)
|
|
if err != nil {
|
|
// restore the original object if we fail to create the new one
|
|
// but still propagate and advertise error to user
|
|
recreated, recreateErr := p.Helper.Create(namespace, true, original, &options)
|
|
if recreateErr != nil {
|
|
err = fmt.Errorf("An error occurred force-replacing the existing object with the newly provided one:\n\n%v.\n\nAdditionally, an error occurred attempting to restore the original object:\n\n%v", err, recreateErr)
|
|
} else {
|
|
createdObject = recreated
|
|
}
|
|
}
|
|
return modified, createdObject, err
|
|
}
|