Merge pull request #257 from seans3/server-side-apply

Implements server-side apply

Author: k8s-ci-robot

cmd/apply/cmdapply.go

@@ -35,9 +35,15 @@ func GetApplyRunner(provider provider.Provider, ioStreams genericclioptions.IOSt
 		RunE:                  r.RunE,
 	}
 
+	cmd.Flags().BoolVar(&r.serverSideOptions.ServerSideApply, "server-side", false,
+		"If true, apply merge patch is calculated on API server instead of client.")
+	cmd.Flags().BoolVar(&r.serverSideOptions.ForceConflicts, "force-conflicts", false,
+		"If true, overwrite applied fields on server if field manager conflict.")
+	cmd.Flags().StringVar(&r.serverSideOptions.FieldManager, "field-manager", common.DefaultFieldManager,
+		"The client owner of the fields being applied on the server-side.")
+
 	cmd.Flags().StringVar(&r.output, "output", printers.DefaultPrinter(),
 		fmt.Sprintf("Output format, must be one of %s", strings.Join(printers.SupportedPrinters(), ",")))
-
 	cmd.Flags().DurationVar(&r.period, "poll-period", 2*time.Second,
 		"Polling period for resource statuses.")
 	cmd.Flags().DurationVar(&r.reconcileTimeout, "reconcile-timeout", time.Duration(0),
@@ -64,6 +70,7 @@ type ApplyRunner struct {
 	Applier   *apply.Applier
 	provider  provider.Provider
 
+	serverSideOptions      common.ServerSideOptions
 	output                 string
 	period                 time.Duration
 	reconcileTimeout       time.Duration
@@ -111,8 +118,9 @@ func (r *ApplyRunner) RunE(cmd *cobra.Command, args []string) error {
 		return err
 	}
 	ch := r.Applier.Run(context.Background(), object.InfosToUnstructureds(infos), apply.Options{
-		PollInterval:     r.period,
-		ReconcileTimeout: r.reconcileTimeout,
+		ServerSideOptions: r.serverSideOptions,
+		PollInterval:      r.period,
+		ReconcileTimeout:  r.reconcileTimeout,
 		// If we are not waiting for status, tell the applier to not
 		// emit the events.
 		EmitStatusEvents:       emitStatusEvents,

cmd/preview/cmdpreview.go

@@ -113,10 +113,16 @@ func (r *PreviewRunner) RunE(cmd *cobra.Command, args []string) error {
 
 		// Run the applier. It will return a channel where we can receive updates
 		// to keep track of progress and any issues.
+		serverSideOptions := common.ServerSideOptions{
+			ServerSideApply: false,
+			ForceConflicts:  false,
+			FieldManager:    common.DefaultFieldManager,
+		}
 		ch = r.Applier.Run(ctx, object.InfosToUnstructureds(infos), apply.Options{
-			EmitStatusEvents: false,
-			NoPrune:          noPrune,
-			DryRunStrategy:   drs,
+			EmitStatusEvents:  false,
+			NoPrune:           noPrune,
+			DryRunStrategy:    drs,
+			ServerSideOptions: serverSideOptions,
 		})
 	} else {
 		inv, _, err := inventory.SplitUnstructureds(object.InfosToUnstructureds(infos))

examples/alphaTestExamples/serverSideApply.md

@@ -0,0 +1,128 @@
+[kind]: https://github.com/kubernetes-sigs/kind
+
+# Demo: Server Side Apply
+
+This demo shows how to invoke server-side apply,
+instead of the default client-side apply.
+
+First define a place to work:
+
+<!-- @makeWorkplace @testE2EAgainstLatestRelease -->
+```
+DEMO_HOME=$(mktemp -d)
+```
+
+Alternatively, use
+
+> ```
+> DEMO_HOME=~/hello
+> ```
+
+## Establish the base
+
+<!-- @createBase @testE2EAgainstLatestRelease -->
+```
+BASE=$DEMO_HOME/base
+mkdir -p $BASE
+OUTPUT=$DEMO_HOME/output
+mkdir -p $OUTPUT
+
+function expectedOutputLine() {
+  test 1 == \
+  $(grep "$@" $OUTPUT/status | wc -l); \
+  echo $?
+}
+```
+
+## Create the first "app"
+
+Create the config yaml for two config maps: (cm-a, cm-b).
+
+<!-- @createFirstConfigMaps @testE2EAgainstLatestRelease-->
+```
+cat <<EOF >$BASE/config-map-a.yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm-a
+  labels:
+    name: test-config-map-label
+EOF
+
+cat <<EOF >$BASE/config-map-b.yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm-b
+  labels:
+    name: test-config-map-label
+data:
+  foo: sean
+EOF
+```
+
+## Run end-to-end tests
+
+The following requires installation of [kind].
+
+Delete any existing kind cluster and create a new one. By default the name of the cluster is "kind".
+
+<!-- @deleteAndCreateKindCluster @testE2EAgainstLatestRelease -->
+```
+kind delete cluster
+kind create cluster
+```
+
+Use the kapply init command to generate the inventory template. This contains
+the namespace and inventory id used by apply to create inventory objects. 
+<!-- @createInventoryTemplate @testE2EAgainstLatestRelease-->
+```
+kapply init $BASE > $OUTPUT/status
+expectedOutputLine "namespace: default is used for inventory object"
+```
+
+Apply the "app" to the cluster. All the config maps should be created, and
+no resources should be pruned.
+<!-- @runServerSideApply @testE2EAgainstLatestRelease -->
+```
+kapply apply $BASE --server-side --reconcile-timeout=1m > $OUTPUT/status
+expectedOutputLine "configmap/cm-a serversideapplied"
+expectedOutputLine "configmap/cm-b serversideapplied"
+expectedOutputLine "2 serverside applied"
+
+# There should be only one inventory object
+kubectl get cm --selector='cli-utils.sigs.k8s.io/inventory-id' --no-headers | wc -l > $OUTPUT/status
+expectedOutputLine "1"
+# Capture the inventory object name for later testing
+kubectl get cm --selector='!cli-utils.sigs.k8s.io/inventory-id' --no-headers | wc -l > $OUTPUT/status
+expectedOutputLine "2"
+# ConfigMap cm-a had been created in the cluster
+kubectl get configmap/cm-a --no-headers | wc -l > $OUTPUT/status
+expectedOutputLine "1"
+# ConfigMap cm-b had been created in the cluster
+kubectl get configmap/cm-b --no-headers | wc -l > $OUTPUT/status
+expectedOutputLine "1"
+```
+
+Update a config map to update a field owned by the default field manager.
+Update both config maps, using a different field-manager to create a
+conflict, but the the --force-conflicts flag to overwrite successfully.
+The conflicting field is "data.foo".
+<!-- @runServerSideApplyWithForceConflicts @testE2EAgainstLatestRelease -->
+```
+cat <<EOF >$BASE/config-map-b.yaml
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm-b
+  labels:
+    name: test-config-map-label
+data:
+  foo: baz
+EOF
+
+kapply apply $BASE --server-side --field-manager=sean --force-conflicts --reconcile-timeout=1m > $OUTPUT/status
+expectedOutputLine "configmap/cm-a serversideapplied"
+expectedOutputLine "configmap/cm-b serversideapplied"
+expectedOutputLine "2 serverside applied"
+```

pkg/apply/applier.go

@@ -197,6 +197,7 @@ func (a *Applier) Run(ctx context.Context, objects []*unstructured.Unstructured,
 			InfoHelper:   a.infoHelper,
 			Mapper:       mapper,
 		}).BuildTaskQueue(resourceObjects, solver.Options{
+			ServerSideOptions:      options.ServerSideOptions,
 			ReconcileTimeout:       options.ReconcileTimeout,
 			Prune:                  !options.NoPrune,
 			DryRunStrategy:         options.DryRunStrategy,
@@ -237,6 +238,9 @@ func (a *Applier) Run(ctx context.Context, objects []*unstructured.Unstructured,
 }
 
 type Options struct {
+	// Encapsulates the fields for server-side apply.
+	ServerSideOptions common.ServerSideOptions
+
 	// ReconcileTimeout defines whether the applier should wait
 	// until all applied resources have been reconciled, and if so,
 	// how long to wait.