add runtime object asset interface

Author: patrickdillon

pkg/asset/asset.go

@@ -8,6 +8,7 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
+	"sigs.k8s.io/controller-runtime/pkg/client"
 )
 
 const (
@@ -42,6 +43,16 @@ type WritableAsset interface {
 	Load(FileFetcher) (found bool, err error)
 }
 
+// WritableRuntimeAsset is a WriteableAsset that has files that can be written to disk,
+// in addition to a manifest file that contains the runtime object.
+type WritableRuntimeAsset interface {
+	WritableAsset
+
+	// RuntimeFiles returns the manifest files along with their
+	// instantiated runtime object.
+	RuntimeFiles() []*RuntimeFile
+}
+
 // File is a file for an Asset.
 type File struct {
 	// Filename is the name of the file.
@@ -50,6 +61,13 @@ type File struct {
 	Data []byte
 }
 
+// RuntimeFile is a file that contains a manifest file and a runtime object.
+type RuntimeFile struct {
+	File
+
+	Object client.Object `json:"-"`
+}
+
 // PersistToFile writes all of the files of the specified asset into the specified
 // directory.
 func PersistToFile(asset WritableAsset, directory string) error {
@@ -107,3 +125,8 @@ func isDirEmpty(name string) (bool, error) {
 func SortFiles(files []*File) {
 	sort.Slice(files, func(i, j int) bool { return files[i].Filename < files[j].Filename })
 }
+
+// SortManifestFiles sorts the specified files by file name.
+func SortManifestFiles(files []*RuntimeFile) {
+	sort.Slice(files, func(i, j int) bool { return files[i].Filename < files[j].Filename })
+}

pkg/asset/manifests/aws/cluster.go

@@ -11,13 +11,14 @@ import (
 	"k8s.io/utils/ptr"
 	capa "sigs.k8s.io/cluster-api-provider-aws/v2/api/v1beta2"
 
+	"github.com/openshift/installer/pkg/asset"
 	"github.com/openshift/installer/pkg/asset/installconfig"
 	"github.com/openshift/installer/pkg/asset/manifests/capiutils"
 )
 
 // GenerateClusterAssets generates the manifests for the cluster-api.
 func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID *installconfig.ClusterID) (*capiutils.GenerateClusterAssetsOutput, error) {
-	manifests := capiutils.Manifests{}
+	manifests := []*asset.RuntimeFile{}
 	mainCIDR := capiutils.CIDRFromInstallConfig(installConfig)
 
 	zones, err := installConfig.AWS.AvailabilityZones(context.TODO())
@@ -200,7 +201,10 @@ func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID
 		}
 	}
 
-	manifests = append(manifests, &capiutils.Manifest{Object: awsCluster, Filename: "02_infra-cluster.yaml"})
+	manifests = append(manifests, &asset.RuntimeFile{
+		Object: awsCluster,
+		File:   asset.File{Filename: "02_infra-cluster.yaml"},
+	})
 
 	id := &capa.AWSClusterControllerIdentity{
 		ObjectMeta: metav1.ObjectMeta{
@@ -213,7 +217,10 @@ func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID
 			},
 		},
 	}
-	manifests = append(manifests, &capiutils.Manifest{Object: id, Filename: "01_aws-cluster-controller-identity-default.yaml"})
+	manifests = append(manifests, &asset.RuntimeFile{
+		Object: id,
+		File:   asset.File{Filename: "01_aws-cluster-controller-identity-default.yaml"},
+	})
 
 	return &capiutils.GenerateClusterAssetsOutput{
 		Manifests: manifests,

pkg/asset/manifests/azure/cluster.go

@@ -6,14 +6,15 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	capz "sigs.k8s.io/cluster-api-provider-azure/api/v1beta1"
 
+	"github.com/openshift/installer/pkg/asset"
 	"github.com/openshift/installer/pkg/asset/installconfig"
 	"github.com/openshift/installer/pkg/asset/manifests/capiutils"
 	"github.com/openshift/installer/pkg/asset/manifests/capiutils/cidr"
 )
 
 // GenerateClusterAssets generates the manifests for the cluster-api.
 func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID *installconfig.ClusterID) (*capiutils.GenerateClusterAssetsOutput, error) {
-	manifests := capiutils.Manifests{}
+	manifests := []*asset.RuntimeFile{}
 	mainCIDR := capiutils.CIDRFromInstallConfig(installConfig)
 
 	session, err := installConfig.Azure.Session()
@@ -28,7 +29,10 @@ func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID
 
 	// CAPZ expects the capz-system to be created.
 	azureNamespace := &corev1.Namespace{ObjectMeta: metav1.ObjectMeta{Name: "capz-system"}}
-	manifests = append(manifests, &capiutils.Manifest{Object: azureNamespace, Filename: "00_azure-namespace.yaml"})
+	manifests = append(manifests, &asset.RuntimeFile{
+		Object: azureNamespace,
+		File:   asset.File{Filename: "00_azure-namespace.yaml"},
+	})
 
 	azureCluster := &capz.AzureCluster{
 		ObjectMeta: metav1.ObjectMeta{
@@ -79,7 +83,10 @@ func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID
 			},
 		},
 	}
-	manifests = append(manifests, &capiutils.Manifest{Object: azureCluster, Filename: "02_azure-cluster.yaml"})
+	manifests = append(manifests, &asset.RuntimeFile{
+		Object: azureCluster,
+		File:   asset.File{Filename: "02_azure-cluster.yaml"},
+	})
 
 	azureClientSecret := &corev1.Secret{
 		ObjectMeta: metav1.ObjectMeta{
@@ -90,7 +97,10 @@ func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID
 			"clientSecret": session.Credentials.ClientSecret,
 		},
 	}
-	manifests = append(manifests, &capiutils.Manifest{Object: azureClientSecret, Filename: "01_azure-client-secret.yaml"})
+	manifests = append(manifests, &asset.RuntimeFile{
+		Object: azureClientSecret,
+		File:   asset.File{Filename: "01_azure-client-secret.yaml"},
+	})
 
 	id := &capz.AzureClusterIdentity{
 		ObjectMeta: metav1.ObjectMeta{
@@ -108,7 +118,10 @@ func GenerateClusterAssets(installConfig *installconfig.InstallConfig, clusterID
 			TenantID: session.Credentials.TenantID,
 		},
 	}
-	manifests = append(manifests, &capiutils.Manifest{Object: id, Filename: "01_aws-cluster-controller-identity-default.yaml"})
+	manifests = append(manifests, &asset.RuntimeFile{
+		Object: id,
+		File:   asset.File{Filename: "01_aws-cluster-controller-identity-default.yaml"},
+	})
 
 	return &capiutils.GenerateClusterAssetsOutput{
 		Manifests: manifests,

pkg/asset/manifests/capiutils/manifest.go

@@ -2,32 +2,12 @@ package capiutils
 
 import (
 	corev1 "k8s.io/api/core/v1"
-	"sigs.k8s.io/controller-runtime/pkg/client"
-)
-
-// Manifests is a list of Manifests sortable by filename.
-type Manifests []*Manifest
-
-func (m Manifests) Len() int {
-	return len(m)
-}
-
-func (m Manifests) Less(i, j int) bool {
-	return m[i].Filename < m[j].Filename
-}
-
-func (m Manifests) Swap(i, j int) {
-	m[i], m[j] = m[j], m[i]
-}
 
-// Manifest is a wrapper for a CAPI manifest.
-type Manifest struct {
-	Object   client.Object
-	Filename string
-}
+	"github.com/openshift/installer/pkg/asset"
+)
 
 // GenerateClusterAssetsOutput is the output of GenerateClusterAssets.
 type GenerateClusterAssetsOutput struct {
-	Manifests         Manifests
+	Manifests         []*asset.RuntimeFile
 	InfrastructureRef *corev1.ObjectReference
 }

pkg/asset/manifests/clusterapi/cluster.go

@@ -2,8 +2,8 @@ package clusterapi
 
 import (
 	"fmt"
+	"os"
 	"path/filepath"
-	"sort"
 
 	"github.com/pkg/errors"
 	corev1 "k8s.io/api/core/v1"
@@ -30,13 +30,12 @@ const (
 	manifestDir = "cluster-api"
 )
 
-var _ asset.WritableAsset = (*Cluster)(nil)
+var _ asset.WritableRuntimeAsset = (*Cluster)(nil)
 
 // Cluster generates manifests for target cluster
 // creation using CAPI.
 type Cluster struct {
-	FileList  []*asset.File
-	Manifests capiutils.Manifests `json:"-"`
+	FileList []*asset.RuntimeFile
 }
 
 // Name returns a human friendly name for the operator.
@@ -74,15 +73,18 @@ func (c *Cluster) Generate(dependencies asset.Parents) error {
 		return nil
 	}
 
-	c.FileList = []*asset.File{}
-	c.Manifests = capiutils.Manifests{}
+	if err := os.MkdirAll(filepath.Dir(manifestDir), 0755); err != nil {
+		return err
+	}
+
+	c.FileList = []*asset.RuntimeFile{}
 
 	namespace := &corev1.Namespace{
 		ObjectMeta: metav1.ObjectMeta{
 			Name: capiutils.Namespace,
 		},
 	}
-	c.Manifests = append(c.Manifests, &capiutils.Manifest{Object: namespace, Filename: "00_capi-namespace.yaml"})
+	c.FileList = append(c.FileList, &asset.RuntimeFile{Object: namespace, File: asset.File{Filename: "00_capi-namespace.yaml"}})
 
 	cluster := &clusterv1.Cluster{
 		ObjectMeta: metav1.ObjectMeta{
@@ -91,7 +93,7 @@ func (c *Cluster) Generate(dependencies asset.Parents) error {
 		},
 		Spec: clusterv1.ClusterSpec{},
 	}
-	c.Manifests = append(c.Manifests, &capiutils.Manifest{Object: cluster, Filename: "01_capi-cluster.yaml"})
+	c.FileList = append(c.FileList, &asset.RuntimeFile{Object: cluster, File: asset.File{Filename: "01_capi-cluster.yaml"}})
 
 	// Gather the ignition files, and store them in a secret.
 	{
@@ -100,9 +102,9 @@ func (c *Cluster) Generate(dependencies asset.Parents) error {
 		if err != nil {
 			return errors.Wrap(err, "unable to inject installation info")
 		}
-		c.Manifests = append(c.Manifests,
-			&capiutils.Manifest{
-				Filename: "01_ignition-secret-master.yaml",
+		c.FileList = append(c.FileList,
+			&asset.RuntimeFile{
+				File: asset.File{Filename: "01_ignition-secret-master.yaml"},
 				Object: &corev1.Secret{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      fmt.Sprintf("%s-%s", clusterID.InfraID, "master"),
@@ -117,8 +119,8 @@ func (c *Cluster) Generate(dependencies asset.Parents) error {
 					},
 				},
 			},
-			&capiutils.Manifest{
-				Filename: "01_ignition-secret-bootstrap.yaml",
+			&asset.RuntimeFile{
+				File: asset.File{Filename: "01_ignition-secret-bootstrap.yaml"},
 				Object: &corev1.Secret{
 					ObjectMeta: metav1.ObjectMeta{
 						Name:      fmt.Sprintf("%s-%s", clusterID.InfraID, "bootstrap"),
@@ -164,26 +166,39 @@ func (c *Cluster) Generate(dependencies asset.Parents) error {
 		return fmt.Errorf("failed to generate manifests: cluster.Spec.InfrastructureRef was never set")
 	}
 
+	// Append the infrastructure manifests.
+	c.FileList = append(c.FileList, out.Manifests...)
+
 	// Create the infrastructure manifests.
-	sort.Sort(c.Manifests)
-	for _, m := range c.Manifests {
+	for _, m := range c.FileList {
 		objData, err := yaml.Marshal(m.Object)
 		if err != nil {
 			return errors.Wrapf(err, "failed to marshal infrastructure manifest %s", m.Filename)
 		}
+		m.Data = objData
 
-		c.FileList = append(c.FileList, &asset.File{
-			Filename: filepath.Join(manifestDir, m.Filename),
-			Data:     objData,
-		})
+		// If the filename is already a path, do not append the manifestDir.
+		if filepath.Dir(m.Filename) == manifestDir {
+			continue
+		}
+		m.Filename = filepath.Join(manifestDir, m.Filename)
 	}
-	asset.SortFiles(c.FileList)
 
+	asset.SortManifestFiles(c.FileList)
 	return nil
 }
 
 // Files returns the files generated by the asset.
 func (c *Cluster) Files() []*asset.File {
+	files := []*asset.File{}
+	for _, f := range c.FileList {
+		files = append(files, &f.File)
+	}
+	return files
+}
+
+// RuntimeFiles returns the files generated by the asset.
+func (c *Cluster) RuntimeFiles() []*asset.RuntimeFile {
 	return c.FileList
 }
 
@@ -204,10 +219,7 @@ func (c *Cluster) Load(f asset.FileFetcher) (bool, error) {
 	fileList := append(yamlFileList, ymlFileList...) //nolint:gocritic
 	fileList = append(fileList, jsonFileList...)
 
-	c.FileList = append(c.FileList, fileList...)
-	asset.SortFiles(c.FileList)
-
-	for _, file := range c.FileList {
+	for _, file := range fileList {
 		u := &unstructured.Unstructured{}
 		if err := yaml.Unmarshal(file.Data, u); err != nil {
 			return false, errors.Wrap(err, "failed to unmarshal file")
@@ -219,12 +231,14 @@ func (c *Cluster) Load(f asset.FileFetcher) (bool, error) {
 		if err := clusterapi.Scheme.Convert(u, obj, nil); err != nil {
 			return false, errors.Wrap(err, "failed to convert object")
 		}
-		c.Manifests = append(c.Manifests, &capiutils.Manifest{
-			Filename: file.Filename,
-			Object:   obj.(client.Object),
+		c.FileList = append(c.FileList, &asset.RuntimeFile{
+			File: asset.File{
+				Filename: file.Filename,
+				Data:     file.Data},
+			Object: obj.(client.Object),
 		})
 	}
 
-	sort.Sort(c.Manifests)
+	asset.SortManifestFiles(c.FileList)
 	return len(c.FileList) > 0, nil
 }