*: upgrade to ignition spec 3

This is the commit that aims to upgrade the spec version used in the MCO from ignition spec 2 to spec 3. With this change in place: - New clusters will have all machineconfigs in spec 3, minus those created by the installer. - Existing clusters will re-render templates into spec 3 upon an upgrade, and render all rendered-machineconfigs into spec 3 with translation from spec 2. Existing rendered-configs and user-created configs will not be translated in-place, but rather re-translated anytime rendering happens. All clusters from this point on will support new MCs with ignition on spec 2 or spec 3. Other key points of this PR: - A de-duplication function is added, so spec 2 -> spec 3 translation can happen. This should not change existing behaviour. A unit test is added to show the expected outcome. - The FCCT usage is slightly modified to account for duplication. Eventually we should use TranslateBytes() from FCCT to get verification. - Validation of on-disk state will still be parsed in the ignition spec version the rendered-config was created in. All other locations translate the config from spec 2 to spec 3 (e.g. Reconcilable). Signed-off-by: Yu Qi Zhang <[email protected]>
openshift · Jul 10, 2020 · 12668c0 · 12668c0
1 parent f8ff1d1
commit 12668c0
Show file tree

Hide file tree

Showing 27 changed files with 721 additions and 430 deletions.
diff --git a/go.sum b/go.sum
@@ -131,6 +131,7 @@ github.com/coreos/vcontext v0.0.0-20190529201340-22b159166068 h1:y2aHj7QqyAJ6YBB
 github.com/coreos/vcontext v0.0.0-20190529201340-22b159166068/go.mod h1:E+6hug9bFSe0KZ2ZAzr8M9F5JlArJjv5D1JS7KSkPKE=
 github.com/coreos/vcontext v0.0.0-20191017033345-260217907eb5 h1:DjoHHi6+9J7DGYPvBdmszKZLY+ucx2bnA77jf8KIk9M=
 github.com/coreos/vcontext v0.0.0-20191017033345-260217907eb5/go.mod h1:E+6hug9bFSe0KZ2ZAzr8M9F5JlArJjv5D1JS7KSkPKE=
+github.com/coreos/vcontext v0.0.0-20200225161404-ee043618d38d h1:Nu473BdYOxcnhFfPrl1ihpCtxI/VZr2IfhVIHDGP43Y=
 github.com/cpuguy83/go-md2man v1.0.10/go.mod h1:SmD6nW6nTyfqj6ABTjUi3V3JVMnlJmwcJI5acqYI6dE=
 github.com/creack/pty v1.1.7/go.mod h1:lj5s0c3V2DBrqTV7llrYr5NG6My20zk30Fl46Y7DoTY=
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

diff --git a/lib/resourceapply/machineconfig_test.go b/lib/resourceapply/machineconfig_test.go
@@ -4,7 +4,7 @@ import (
 	"fmt"
 	"testing"
 
-	igntypes "github.com/coreos/ignition/config/v2_2/types"
+	ign3types "github.com/coreos/ignition/v2/config/v3_1/types"
 	"github.com/davecgh/go-spew/spew"
 	mcfgv1 "github.com/openshift/machine-config-operator/pkg/apis/machineconfiguration.openshift.io/v1"
 	"github.com/openshift/machine-config-operator/pkg/generated/clientset/versioned/fake"
@@ -177,10 +177,10 @@ func TestApplyMachineConfig(t *testing.T) {
 			ObjectMeta: metav1.ObjectMeta{Name: "foo"},
 			Spec: mcfgv1.MachineConfigSpec{
 				Config: runtime.RawExtension{
-					Raw: helpers.MarshalOrDie(&igntypes.Config{
-						Passwd: igntypes.Passwd{
-							Users: []igntypes.PasswdUser{{
-								HomeDir: "/home/dummy",
+					Raw: helpers.MarshalOrDie(&ign3types.Config{
+						Passwd: ign3types.Passwd{
+							Users: []ign3types.PasswdUser{{
+								HomeDir: helpers.StrToPtr("/home/dummy"),
 							}},
 						},
 					}),
@@ -203,10 +203,10 @@ func TestApplyMachineConfig(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{Name: "foo", Labels: map[string]string{"extra": "leave-alone"}},
 				Spec: mcfgv1.MachineConfigSpec{
 					Config: runtime.RawExtension{
-						Raw: helpers.MarshalOrDie(&igntypes.Config{
-							Passwd: igntypes.Passwd{
-								Users: []igntypes.PasswdUser{{
-									HomeDir: "/home/dummy",
+						Raw: helpers.MarshalOrDie(&ign3types.Config{
+							Passwd: ign3types.Passwd{
+								Users: []ign3types.PasswdUser{{
+									HomeDir: helpers.StrToPtr("/home/dummy"),
 								}},
 							},
 						}),
@@ -224,10 +224,10 @@ func TestApplyMachineConfig(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{Name: "foo", Labels: map[string]string{"extra": "leave-alone"}},
 				Spec: mcfgv1.MachineConfigSpec{
 					Config: runtime.RawExtension{
-						Raw: helpers.MarshalOrDie(&igntypes.Config{
-							Passwd: igntypes.Passwd{
-								Users: []igntypes.PasswdUser{{
-									HomeDir: "/home/dummy-prev",
+						Raw: helpers.MarshalOrDie(&ign3types.Config{
+							Passwd: ign3types.Passwd{
+								Users: []ign3types.PasswdUser{{
+									HomeDir: helpers.StrToPtr("/home/dummy-prev"),
 								}},
 							},
 						}),
@@ -239,10 +239,10 @@ func TestApplyMachineConfig(t *testing.T) {
 			ObjectMeta: metav1.ObjectMeta{Name: "foo"},
 			Spec: mcfgv1.MachineConfigSpec{
 				Config: runtime.RawExtension{
-					Raw: helpers.MarshalOrDie(&igntypes.Config{
-						Passwd: igntypes.Passwd{
-							Users: []igntypes.PasswdUser{{
-								HomeDir: "/home/dummy",
+					Raw: helpers.MarshalOrDie(&ign3types.Config{
+						Passwd: ign3types.Passwd{
+							Users: []ign3types.PasswdUser{{
+								HomeDir: helpers.StrToPtr("/home/dummy"),
 							}},
 						},
 					}),
@@ -265,10 +265,10 @@ func TestApplyMachineConfig(t *testing.T) {
 				ObjectMeta: metav1.ObjectMeta{Name: "foo", Labels: map[string]string{"extra": "leave-alone"}},
 				Spec: mcfgv1.MachineConfigSpec{
 					Config: runtime.RawExtension{
-						Raw: helpers.MarshalOrDie(&igntypes.Config{
-							Passwd: igntypes.Passwd{
-								Users: []igntypes.PasswdUser{{
-									HomeDir: "/home/dummy",
+						Raw: helpers.MarshalOrDie(&ign3types.Config{
+							Passwd: ign3types.Passwd{
+								Users: []ign3types.PasswdUser{{
+									HomeDir: helpers.StrToPtr("/home/dummy"),
 								}},
 							},
 						}),

diff --git a/pkg/controller/bootstrap/bootstrap_test.go b/pkg/controller/bootstrap/bootstrap_test.go
@@ -9,7 +9,7 @@ import (
 	"strings"
 	"testing"
 
-	igntypes "github.com/coreos/ignition/config/v2_2/types"
+	ign3types "github.com/coreos/ignition/v2/config/v3_1/types"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"github.com/vincent-petithory/dataurl"
@@ -149,8 +149,8 @@ func TestBootstrapRun(t *testing.T) {
 			require.NoError(t, err)
 
 			// Ensure that generated registries.conf corresponds to the testdata ImageContentSourcePolicy
-			var registriesConfig *igntypes.File
-			ignCfg, err := ctrlcommon.IgnParseWrapper(mc.Spec.Config.Raw)
+			var registriesConfig *ign3types.File
+			ignCfg, err := ctrlcommon.ParseAndConvertConfig(mc.Spec.Config.Raw)
 			require.NoError(t, err)
 			for i := range ignCfg.Storage.Files {
 				f := &ignCfg.Storage.Files[i]
@@ -159,7 +159,7 @@ func TestBootstrapRun(t *testing.T) {
 				}
 			}
 			require.NotNil(t, registriesConfig)
-			dataURL, err := dataurl.DecodeString(registriesConfig.Contents.Source)
+			dataURL, err := dataurl.DecodeString(*registriesConfig.Contents.Source)
 			require.NoError(t, err)
 			// Only a minimal presence check; more comprehensive tests that the contents correspond to the ICSP semantics are
 			// maintained in pkg/controller/continer-runtime-config.

diff --git a/pkg/controller/bootstrap/testdata/bootstrap/99_openshift-machineconfig_master.yaml b/pkg/controller/bootstrap/testdata/bootstrap/99_openshift-machineconfig_master.yaml
@@ -13,8 +13,7 @@ spec:
       security:
         tls: {}
       timeouts: {}
-      version: 2.2.0
-    networkd: {}
+      version: 3.1.0
     passwd:
       users:
       - name: core

diff --git a/pkg/controller/bootstrap/testdata/bootstrap/99_openshift-machineconfig_worker.yaml b/pkg/controller/bootstrap/testdata/bootstrap/99_openshift-machineconfig_worker.yaml
@@ -13,8 +13,7 @@ spec:
       security:
         tls: {}
       timeouts: {}
-      version: 2.2.0
-    networkd: {}
+      version: 3.1.0
     passwd:
       users:
       - name: core