image: Change SourceURL to Download

This better reflect the meaning. Also remove the union as there is
currently only one option and we may never implement a second one. We
retain the ability to add a second one if required.

Author: mdbooth

internal/controllers/image/upload.go

@@ -83,27 +83,21 @@ func (r *orcImageReconciler) uploadImageContent(ctx context.Context, orcImage *o
 		return err
 	}
 
-	if content.SourceType != orcv1alpha1.ImageSourceTypeURL {
-		// Should have been caught by validation
-		return capoerrors.Terminal(orcv1alpha1.OpenStackConditionReasonInvalidConfiguration, "invalid image source type: "+string(content.SourceType))
-	}
-
-	urlSource := content.SourceURL
-
-	if urlSource == nil {
+	download := content.Download
+	if download == nil {
 		// Should have been caught by validation
 		return capoerrors.Terminal(orcv1alpha1.OpenStackConditionReasonInvalidConfiguration, "image source type URL has no url entry")
 	}
 
-	req, err := http.NewRequestWithContext(ctx, http.MethodGet, urlSource.URL, http.NoBody)
+	req, err := http.NewRequestWithContext(ctx, http.MethodGet, download.URL, http.NoBody)
 	if err != nil {
-		return fmt.Errorf("error creating request for %s: %w", urlSource.URL, err)
+		return fmt.Errorf("error creating request for %s: %w", download.URL, err)
 	}
 
 	client := http.Client{}
 	resp, err := client.Do(req)
 	if err != nil {
-		return fmt.Errorf("error requesting %s: %w", urlSource.URL, err)
+		return fmt.Errorf("error requesting %s: %w", download.URL, err)
 	}
 	defer func() {
 		err = errors.Join(err, resp.Body.Close())
@@ -114,9 +108,9 @@ func (r *orcImageReconciler) uploadImageContent(ctx context.Context, orcImage *o
 	reader := newReaderWithProgress(resp.Body, r.downloadProgressReporter(ctx, orcImage, glanceImage, resp.ContentLength))
 
 	// If the content defines a hash, calculate the hash while downloading and verify it before returning a successful read to glance
-	if urlSource.DownloadHash != nil {
-		log.V(4).Info("will verify download hash", "algorithm", urlSource.DownloadHash.Algorithm, "value", urlSource.DownloadHash.Value)
-		reader, err = newReaderWithHash(reader, urlSource.DownloadHash.Algorithm, r.hashVerifier(ctx, orcImage, urlSource.DownloadHash.Value))
+	if download.Hash != nil {
+		log.V(4).Info("will verify download hash", "algorithm", download.Hash.Algorithm, "value", download.Hash.Value)
+		reader, err = newReaderWithHash(reader, download.Hash.Algorithm, r.hashVerifier(ctx, orcImage, download.Hash.Value))
 		if err != nil {
 			return err
 		}
@@ -127,11 +121,11 @@ func (r *orcImageReconciler) uploadImageContent(ctx context.Context, orcImage *o
 	reader = bufio.NewReaderSize(reader, transferBufferSizeBytes)
 
 	// If the content requires decompression, decompress before sending to glance
-	if urlSource.Decompress != nil {
-		log.V(4).Info("will decompress downladed content", "algorithm", *urlSource.Decompress)
-		reader, err = newReaderWithDecompression(reader, *urlSource.Decompress)
+	if download.Decompress != nil {
+		log.V(4).Info("will decompress downladed content", "algorithm", *download.Decompress)
+		reader, err = newReaderWithDecompression(reader, *download.Decompress)
 		if err != nil {
-			return fmt.Errorf("opening %s: %w", urlSource.URL, err)
+			return fmt.Errorf("opening %s: %w", download.URL, err)
 		}
 	}
 

internal/controllers/image/upload_test.go

@@ -192,11 +192,10 @@ var _ = Describe("Upload tests", Ordered, func() {
 				Content: &orcv1alpha1.ImageContent{
 					ContainerFormat: orcv1alpha1.ImageContainerFormatBare,
 					DiskFormat:      orcv1alpha1.ImageDiskFormatRaw,
-					SourceType:      orcv1alpha1.ImageSourceTypeURL,
-					SourceURL: &orcv1alpha1.ImageContentSourceURL{
-						URL:          "http://" + fileServeAddr + "/" + imageName,
-						Decompress:   opts.compression,
-						DownloadHash: opts.downloadHash,
+					Download: &orcv1alpha1.ImageContentSourceDownload{
+						URL:        "http://" + fileServeAddr + "/" + imageName,
+						Decompress: opts.compression,
+						Hash:       opts.downloadHash,
 					},
 				},
 			},

internal/controllers/image/webdownload.go

@@ -63,8 +63,8 @@ func (r *orcImageReconciler) canWebDownload(ctx context.Context, orcImage *orcv1
 		return false, err
 	}
 
-	urlSource := content.SourceURL
-	if urlSource == nil {
+	download := content.Download
+	if download == nil {
 		debugLog("not type URL")
 		return false, nil
 	}
@@ -73,7 +73,7 @@ func (r *orcImageReconciler) canWebDownload(ctx context.Context, orcImage *orcv1
 	// Glance can be configured to do automatic decompression of imported
 	// images, but there's no way to determine if it is enabled so it can't
 	// be safely used.
-	if urlSource.Decompress != nil {
+	if download.Decompress != nil {
 		debugLog("web-download does not support decompression")
 		return false, nil
 	}
@@ -89,7 +89,7 @@ func (r *orcImageReconciler) canWebDownload(ctx context.Context, orcImage *orcv1
 	//   determine, if the hash we have doesn't match the algorithm configured
 	//   server-side in glance, which is also not exposed via the API, we
 	//   can't verify it anyway.
-	if urlSource.DownloadHash != nil {
+	if download.Hash != nil {
 		debugLog("web-download does not support hash verification")
 		return false, nil
 	}
@@ -125,6 +125,6 @@ func (r *orcImageReconciler) webDownload(ctx context.Context, orcImage *orcv1alp
 
 	return imageClient.CreateImport(ctx, glanceImage.ID, &imageimport.CreateOpts{
 		Name: imageimport.WebDownloadMethod,
-		URI:  content.SourceURL.URL,
+		URI:  content.Download.URL,
 	})
 }

orc/api/v1alpha1/image_types.go

@@ -214,16 +214,6 @@ const (
 	ImageCompressionBZ2 ImageCompression = "bz2"
 )
 
-// +kubebuilder:validation:Enum:=URL
-type ImageContentSourceType string
-
-const (
-	ImageSourceTypeURL ImageContentSourceType = "URL"
-)
-
-// ImageContent specifies the source of image data
-// +kubebuilder:validation:XValidation:rule="has(self.sourceType) && self.sourceType == 'URL' ?  has(self.sourceURL) : !has(self.sourceURL)",message="sourceURL is required when sourceType is URL, and forbidden otherwise"
-// +union
 type ImageContent struct {
 	// ContainerFormat is the format of the image container.
 	// qcow2 and raw images do not usually have a container. This is specified as "bare", which is also the default.
@@ -239,19 +229,14 @@ type ImageContent struct {
 	// +kubebuilder:validation:Required
 	DiskFormat ImageDiskFormat `json:"diskFormat"`
 
-	// SourceType is the type of the image content source
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="sourceType is immutable"
-	// +kubebuilder:validation:Required
-	// +unionDiscriminator
-	SourceType ImageContentSourceType `json:"sourceType"`
-
-	// SourceURL describes how to obtain image data by downloading it from a SourceURL. Must be set if Type is 'url'
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="sourceURL is immutable"
+	// Download describes how to obtain image data by downloading it from a URL.
+	// Must be set when creating a managed image.
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="download is immutable"
 	// +unionMember
-	SourceURL *ImageContentSourceURL `json:"sourceURL,omitempty"`
+	Download *ImageContentSourceDownload `json:"download,omitempty"`
 }
 
-type ImageContentSourceURL struct {
+type ImageContentSourceDownload struct {
 	// URL containing image data
 	// +kubebuilder:validation:Format=uri
 	// +kubebuilder:validation:Required
@@ -264,14 +249,14 @@ type ImageContentSourceURL struct {
 	// +optional
 	Decompress *ImageCompression `json:"decompress,omitempty"`
 
-	// DownloadHash is a hash which will be used to verify downloaded data, i.e.
+	// Hash is a hash which will be used to verify downloaded data, i.e.
 	// before any decompression. If not specified, no hash verification will be
-	// performed. Specifying a DownloadHash will disable the use of glance's
+	// performed. Specifying a Hash will disable the use of glance's
 	// web-download, as web-download cannot currently deterministically verify
 	// the hash of downloaded content.
-	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="downloadHash is immutable"
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="hash is immutable"
 	// +optional
-	DownloadHash *ImageHash `json:"downloadHash,omitempty"`
+	Hash *ImageHash `json:"hash,omitempty"`
 }
 
 type ImageHash struct {

orc/api/v1alpha1/zz_generated.deepcopy.go

@@ -186,18 +186,10 @@ spec:
                         x-kubernetes-validations:
                         - message: diskFormat is immutable
                           rule: self == oldSelf
-                      sourceType:
-                        description: SourceType is the type of the image content source
-                        enum:
-                        - URL
-                        type: string
-                        x-kubernetes-validations:
-                        - message: sourceType is immutable
-                          rule: self == oldSelf
-                      sourceURL:
-                        description: SourceURL describes how to obtain image data
-                          by downloading it from a SourceURL. Must be set if Type
-                          is 'url'
+                      download:
+                        description: |-
+                          Download describes how to obtain image data by downloading it from a URL.
+                          Must be set when creating a managed image.
                         properties:
                           decompress:
                             description: |-
@@ -210,11 +202,11 @@ spec:
                             - gz
                             - bz2
                             type: string
-                          downloadHash:
+                          hash:
                             description: |-
-                              DownloadHash is a hash which will be used to verify downloaded data, i.e.
+                              Hash is a hash which will be used to verify downloaded data, i.e.
                               before any decompression. If not specified, no hash verification will be
-                              performed. Specifying a DownloadHash will disable the use of glance's
+                              performed. Specifying a Hash will disable the use of glance's
                               web-download, as web-download cannot currently deterministically verify
                               the hash of downloaded content.
                             properties:
@@ -240,7 +232,7 @@ spec:
                             - value
                             type: object
                             x-kubernetes-validations:
-                            - message: downloadHash is immutable
+                            - message: hash is immutable
                               rule: self == oldSelf
                           url:
                             description: URL containing image data
@@ -250,19 +242,14 @@ spec:
                         - url
                         type: object
                         x-kubernetes-validations:
-                        - message: sourceURL is immutable
+                        - message: download is immutable
                           rule: self == oldSelf
                     required:
                     - diskFormat
-                    - sourceType
                     type: object
                     x-kubernetes-validations:
                     - message: content is immutable
                       rule: self == oldSelf
-                    - message: sourceURL is required when sourceType is URL, and forbidden
-                        otherwise
-                      rule: 'has(self.sourceType) && self.sourceType == ''URL'' ?  has(self.sourceURL)
-                        : !has(self.sourceURL)'
                   name:
                     description: |-
                       Name will be the name of the created glance image. If not specified, the