apps: support specifying images by digest (#1295)

* apps: support specifying images by digest * Update digitalocean/app/app_spec.go Co-authored-by: Anna Lushnikova <[email protected]> --------- Co-authored-by: Anna Lushnikova <[email protected]>
digitalocean · Jan 6, 2025 · dcdeef2 · dcdeef2
1 parent 6f15115
commit dcdeef2
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 1 deletion.
diff --git a/digitalocean/app/app_spec.go b/digitalocean/app/app_spec.go
@@ -258,7 +258,12 @@ func appSpecImageSourceSchema() map[string]*schema.Schema {
 		"tag": {
 			Type:        schema.TypeString,
 			Optional:    true,
-			Description: "The repository tag. Defaults to latest if not provided.",
+			Description: "The repository tag. Defaults to latest if not provided. Cannot be specified if digest is provided.",
+		},
+		"digest": {
+			Type:        schema.TypeString,
+			Optional:    true,
+			Description: "The image digest. Cannot be specified if tag is provided.",
 		},
 		"deploy_on_push": {
 			Type:        schema.TypeList,
@@ -1603,6 +1608,7 @@ func expandAppImageSourceSpec(config []interface{}) *godo.ImageSourceSpec {
 		Registry:            imageSourceConfig["registry"].(string),
 		Repository:          imageSourceConfig["repository"].(string),
 		Tag:                 imageSourceConfig["tag"].(string),
+		Digest:              imageSourceConfig["digest"].(string),
 		RegistryCredentials: imageSourceConfig["registry_credentials"].(string),
 	}
 
@@ -1626,6 +1632,7 @@ func flattenAppImageSourceSpec(i *godo.ImageSourceSpec) []interface{} {
 		r["registry"] = (*i).Registry
 		r["repository"] = (*i).Repository
 		r["tag"] = (*i).Tag
+		r["digest"] = (*i).Digest
 		r["registry_credentials"] = (*i).RegistryCredentials
 
 		if i.DeployOnPush != nil {

diff --git a/digitalocean/app/resource_app_test.go b/digitalocean/app/resource_app_test.go
@@ -1050,6 +1050,35 @@ func TestAccDigitalOceanApp_autoScale(t *testing.T) {
 	})
 }
 
+func TestAccDigitalOceanApp_ImageDigest(t *testing.T) {
+	var app godo.App
+	appName := acceptance.RandomTestName()
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:     func() { acceptance.TestAccPreCheck(t) },
+		Providers:    acceptance.TestAccProviders,
+		CheckDestroy: testAccCheckDigitalOceanAppDestroy,
+		Steps: []resource.TestStep{
+			{
+				Config: fmt.Sprintf(testAccCheckDigitalOceanAppConfig_imageDigest, appName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckDigitalOceanAppExists("digitalocean_app.foobar", &app),
+					resource.TestCheckResourceAttrSet("digitalocean_app.foobar", "live_url"),
+					resource.TestCheckResourceAttrSet("digitalocean_app.foobar", "live_domain"),
+					resource.TestCheckResourceAttr(
+						"digitalocean_app.foobar", "spec.0.service.0.image.0.registry_type", "DOCKER_HUB"),
+					resource.TestCheckResourceAttr(
+						"digitalocean_app.foobar", "spec.0.service.0.image.0.registry", "ubuntu"),
+					resource.TestCheckResourceAttr(
+						"digitalocean_app.foobar", "spec.0.service.0.image.0.repository", "nginx"),
+					resource.TestCheckResourceAttr(
+						"digitalocean_app.foobar", "spec.0.service.0.image.0.digest", "sha256:909169d4de5b750071dc2cbe286e18763f8ed23dd0f267b5db59ea33bdbf8853"),
+				),
+			},
+		},
+	})
+}
+
 var testAccCheckDigitalOceanAppConfig_basic = `
 resource "digitalocean_app" "foobar" {
   spec {
@@ -1233,6 +1262,29 @@ resource "digitalocean_app" "foobar" {
   }
 }`
 
+var testAccCheckDigitalOceanAppConfig_imageDigest = `
+resource "digitalocean_app" "foobar" {
+  spec {
+    name   = "%s"
+    region = "nyc"
+
+    service {
+      name               = "image-service"
+      instance_count     = 1
+      instance_size_slug = "apps-s-1vcpu-1gb"
+
+      image {
+        registry_type = "DOCKER_HUB"
+        registry      = "ubuntu"
+        repository    = "nginx"
+        digest        = "sha256:909169d4de5b750071dc2cbe286e18763f8ed23dd0f267b5db59ea33bdbf8853"
+      }
+
+      http_port = 80
+    }
+  }
+}`
+
 var testAccCheckDigitalOceanAppConfig_addInternalPort = `
 resource "digitalocean_app" "foobar" {
   spec {

diff --git a/docs/data-sources/app.md b/docs/data-sources/app.md
@@ -73,6 +73,7 @@ A `service` can contain:
   - `registry` - The registry name. Must be left empty for the `DOCR` registry type. Required for the `DOCKER_HUB` registry type.
   - `repository` - The repository name.
   - `tag` - The repository tag. Defaults to `latest` if not provided.
+  - `digest` - The image digest. Cannot be specified if `tag` is provided.
   - `deploy_on_push` - Configures automatically deploying images pushed to DOCR.
       - `enabled` - Whether to automatically deploy images pushed to DOCR.
 * `env` - Describes an environment variable made available to an app competent.
@@ -170,6 +171,7 @@ A `worker` can contain:
   - `registry` - The registry name. Must be left empty for the `DOCR` registry type. Required for the `DOCKER_HUB` registry type.
   - `repository` - The repository name.
   - `tag` - The repository tag. Defaults to `latest` if not provided.
+  - `digest` - The image digest. Cannot be specified if `tag` is provided.
   - `deploy_on_push` - Configures automatically deploying images pushed to DOCR.
       - `enabled` - Whether to automatically deploy images pushed to DOCR.
 * `env` - Describes an environment variable made available to an app competent.
@@ -225,6 +227,7 @@ A `job` can contain:
   - `registry` - The registry name. Must be left empty for the `DOCR` registry type. Required for the `DOCKER_HUB` registry type.
   - `repository` - The repository name.
   - `tag` - The repository tag. Defaults to `latest` if not provided.
+  - `digest` - The image digest. Cannot be specified if `tag` is provided.
   - `deploy_on_push` - Configures automatically deploying images pushed to DOCR.
       - `enabled` - Whether to automatically deploy images pushed to DOCR.
 * `env` - Describes an environment variable made available to an app competent.

diff --git a/docs/resources/app.md b/docs/resources/app.md
@@ -269,6 +269,7 @@ A `service` can contain:
   - `repository` - The repository name.
   - `registry_credentials` - The credentials required to access a private Docker Hub or GitHub registry, in the following syntax `<username>:<token>`.
   - `tag` - The repository tag. Defaults to `latest` if not provided.
+  - `digest` - The image digest. Cannot be specified if `tag` is provided.
   - `deploy_on_push` - Configures automatically deploying images pushed to DOCR.
     - `enabled` - Whether to automatically deploy images pushed to DOCR.
 - `env` - Describes an environment variable made available to an app competent.
@@ -376,6 +377,7 @@ A `worker` can contain:
   - `repository` - The repository name.
   - `registry_credentials` - The credentials required to access a private Docker Hub or GitHub registry, in the following syntax `<username>:<token>`.
   - `tag` - The repository tag. Defaults to `latest` if not provided.
+  - `digest` - The image digest. Cannot be specified if `tag` is provided.
   - `deploy_on_push` - Configures automatically deploying images pushed to DOCR.
     - `enabled` - Whether to automatically deploy images pushed to DOCR.
 - `env` - Describes an environment variable made available to an app competent.
@@ -438,6 +440,7 @@ A `job` can contain:
   - `repository` - The repository name.
   - `registry_credentials` - The credentials required to access a private Docker Hub or GitHub registry, in the following syntax `<username>:<token>`.
   - `tag` - The repository tag. Defaults to `latest` if not provided.
+  - `digest` - The image digest. Cannot be specified if `tag` is provided.
   - `deploy_on_push` - Configures automatically deploying images pushed to DOCR.
     - `enabled` - Whether to automatically deploy images pushed to DOCR.
 - `env` - Describes an environment variable made available to an app competent.