Deprecate extraOptions and env (#468)

* Remove `env` from schema

The `env` field was used to pass along a buildkit option.
This functionality has been replaced by `builderVersion`.
Additionally, an `ENV` field is common to use in Dockerfiles, and to
pass to containers as runtime flags, so using this name is confusing as
well. ENV vars do not get passed at build time.

* Remove handling of deprecated `env` field from Image implementation

* Generate SDKs for removal of `env` type

* Remove `extraOptions` field

This field was used to pass arbitrary values to the invocation of the
Docker CLI. Using the go docker SDK, we will over time add these as
fully typed features.

* Remove extraOptions implementation and tests

* Regenerate SDKs

* Remove `env` from examples and replace with `args` for build time fun

examples/dockerfile-go/main.go

@@ -11,8 +11,8 @@ func main() {
 			ImageName: pulumi.String("pulumi-user/example:v1.0.0"),
 			Build: docker.DockerBuildArgs{
 				Target: pulumi.String("dependencies"),
-				Env: pulumi.StringMap{
-					"TEST_ENV": pulumi.String("42"),
+				Args: pulumi.StringMap{
+					"TEST_ARG": pulumi.String("42"),
 				},
 			},
 			SkipPush: pulumi.Bool(true),

examples/dockerfile-py/__main__.py

@@ -6,7 +6,7 @@
     image_name="pulumi-user/example:v1.0.0",
     build=DockerBuildArgs(
         target="dependencies",
-        env={'TEST_ENV': '42'},
+        args={'TEST_ARG': '42'},
     ),
     skip_push=True,
 )

examples/dockerfile-with-targets/index.ts

@@ -4,7 +4,7 @@ const myDependenciesImage = new docker.Image("my-image", {
     imageName: "pulumi-user/example:v1.0.0",
     build: {
         target: "dependencies",
-        env: { "TEST_ENV": "42" },
+        args: { "TEST_ARG": "42" },
     },
     skipPush: true,
 });

examples/dotnet/Program.cs

@@ -15,9 +15,9 @@ static Task<int> Main()
                 ImageName = "pulumi-user/example:v1.0.0",
                 Build = new DockerBuildArgs
                 {
-                    Env = new Dictionary<string, string>
+                    Args = new Dictionary<string, string>
                     { 
-                        {"TEST_ENV", "42"}, 
+                        {"TEST_ARG", "42"},
                     },
                     Target = "dependencies",
                 },

provider/cmd/pulumi-resource-docker/schema.json

@@ -3074,20 +3074,6 @@
                     "description": "The path to the Dockerfile to use.",
                     "default": "Dockerfile"
                 },
-                "env": {
-                    "type": "object",
-                    "additionalProperties": {
-                        "type": "string"
-                    },
-                    "description": "Environment variables to set on the invocation of docker build, for example to support DOCKER_BUILDKIT=1 docker build."
-                },
-                "extraOptions": {
-                    "type": "array",
-                    "items": {
-                        "type": "string"
-                    },
-                    "description": "A bag of extra options to pass on to the docker SDK."
-                },
                 "target": {
                     "type": "string",
                     "description": "The target of the Dockerfile to build"

provider/image.go

@@ -45,9 +45,7 @@ type Build struct {
 	Context        string
 	Dockerfile     string
 	CachedImages   []string
-	Env            map[string]string
 	Args           map[string]*string
-	ExtraOptions   []string
 	Target         string
 	BuilderVersion types.BuilderVersion
 }
@@ -301,20 +299,9 @@ func marshalBuildAndApplyDefaults(b resource.PropertyValue) (Build, error) {
 	}
 	build.BuilderVersion = version
 
-	// Envs
-	build.Env = marshalEnvs(buildObject["env"])
-
 	// Args
 	build.Args = marshalArgs(buildObject["args"])
 
-	// ExtraOptions
-	if !buildObject["extraOptions"].IsNull() {
-		opts := buildObject["extraOptions"].ArrayValue()
-		for _, v := range opts {
-			build.ExtraOptions = append(build.ExtraOptions, v.StringValue())
-		}
-	}
-
 	// Target
 	if !buildObject["target"].IsNull() {
 		build.Target = buildObject["target"].StringValue()
@@ -375,20 +362,6 @@ func marshalArgs(a resource.PropertyValue) map[string]*string {
 	return args
 }
 
-func marshalEnvs(e resource.PropertyValue) map[string]string {
-	envs := make(map[string]string)
-	if !e.IsNull() {
-		for k, v := range e.ObjectValue() {
-			key := fmt.Sprintf("%v", k)
-			envs[key] = v.StringValue()
-		}
-	}
-	if len(envs) == 0 {
-		return nil
-	}
-	return envs
-}
-
 func marshalBuilder(builder resource.PropertyValue) (types.BuilderVersion, error) {
 	var version types.BuilderVersion
 

provider/image_test.go

@@ -125,64 +125,6 @@ func TestMarshalBuildAndApplyDefaults(t *testing.T) {
 		assert.NoError(t, err)
 	})
 
-	t.Run("Setting Env", func(t *testing.T) {
-
-		expected := Build{
-			Context:    ".",
-			Dockerfile: "Dockerfile",
-			Env: map[string]string{
-				"Strawberry": "fruit",
-			},
-			BuilderVersion: "2",
-		}
-
-		input := resource.NewObjectProperty(resource.PropertyMap{
-			"env": resource.NewObjectProperty(resource.PropertyMap{
-				"Strawberry": resource.NewStringProperty("fruit"),
-			}),
-		})
-
-		actual, err := marshalBuildAndApplyDefaults(input)
-		assert.Equal(t, expected, actual)
-		assert.NoError(t, err)
-	})
-
-	t.Run("Sets Extra Options", func(t *testing.T) {
-		expected := Build{
-			Context:        ".",
-			Dockerfile:     "Dockerfile",
-			ExtraOptions:   []string{"cat", "dog", "pot-bellied pig"},
-			BuilderVersion: "2",
-		}
-
-		input := resource.NewObjectProperty(resource.PropertyMap{
-			"extraOptions": resource.NewArrayProperty([]resource.PropertyValue{
-				resource.NewStringProperty("cat"),
-				resource.NewStringProperty("dog"),
-				resource.NewStringProperty("pot-bellied pig"),
-			}),
-		})
-
-		actual, err := marshalBuildAndApplyDefaults(input)
-		assert.Equal(t, expected, actual)
-		assert.NoError(t, err)
-	})
-
-	t.Run("Does Not Set Extra Options on Empty Input", func(t *testing.T) {
-		expected := Build{
-			Context:        ".",
-			Dockerfile:     "Dockerfile",
-			BuilderVersion: "2",
-		}
-
-		input := resource.NewObjectProperty(resource.PropertyMap{
-			"extraOptions": resource.NewArrayProperty([]resource.PropertyValue{}),
-		})
-
-		actual, err := marshalBuildAndApplyDefaults(input)
-		assert.Equal(t, expected, actual)
-		assert.NoError(t, err)
-	})
 	t.Run("Sets Target", func(t *testing.T) {
 		expected := Build{
 			Context:        ".",
@@ -256,29 +198,6 @@ func TestMarshalArgs(t *testing.T) {
 	})
 }
 
-func TestMarshalEnvs(t *testing.T) {
-	t.Run("Set any environment variables", func(t *testing.T) {
-		expected := map[string]string{
-			"Strawberry": "fruit",
-			"Carrot":     "veggie",
-			"Docker":     "a bit of a mess tbh",
-		}
-		input := resource.NewObjectProperty(resource.PropertyMap{
-			"Strawberry": resource.NewStringProperty("fruit"),
-			"Carrot":     resource.NewStringProperty("veggie"),
-			"Docker":     resource.NewStringProperty("a bit of a mess tbh"),
-		})
-		actual := marshalEnvs(input)
-		assert.Equal(t, expected, actual)
-	})
-	t.Run("Returns nil when no environment variables set", func(t *testing.T) {
-		expected := map[string]string(nil)
-		input := resource.NewObjectProperty(resource.PropertyMap{})
-		actual := marshalEnvs(input)
-		assert.Equal(t, expected, actual)
-	})
-}
-
 func TestMarshalCachedImages(t *testing.T) {
 	t.Run("Test Cached Images", func(t *testing.T) {
 		expected := []string{"apple", "banana", "cherry"}

provider/resources.go

@@ -157,16 +157,6 @@ func Provider() tfbridge.ProviderInfo {
 								Ref: "#/types/docker:index/cacheFrom:CacheFrom",
 							},
 						},
-						"env": {
-							Description: "Environment variables to set on the invocation of docker build, " +
-								"for example to support DOCKER_BUILDKIT=1 docker build.",
-							TypeSpec: schema.TypeSpec{
-								Type: "object",
-								AdditionalProperties: &schema.TypeSpec{
-									Type: "string",
-								},
-							},
-						},
 						"args": {
 							Description: "An optional map of named build-time argument variables to set " +
 								"during the Docker build. This flag allows you to pass built-time variables" +
@@ -178,15 +168,6 @@ func Provider() tfbridge.ProviderInfo {
 								},
 							},
 						},
-						"extraOptions": {
-							Description: "A bag of extra options to pass on to the docker SDK.",
-							TypeSpec: schema.TypeSpec{
-								Type: "array",
-								Items: &schema.TypeSpec{
-									Type: "string",
-								},
-							},
-						},
 						"target": {
 							Description: "The target of the Dockerfile to build",
 							TypeSpec:    schema.TypeSpec{Type: "string"},

sdk/dotnet/Inputs/DockerBuildArgs.cs

@@ -51,30 +51,6 @@ public InputMap<string> Args
         [Input("dockerfile")]
         public Input<string>? Dockerfile { get; set; }
 
-        [Input("env")]
-        private InputMap<string>? _env;
-
-        /// <summary>
-        /// Environment variables to set on the invocation of docker build, for example to support DOCKER_BUILDKIT=1 docker build.
-        /// </summary>
-        public InputMap<string> Env
-        {
-            get => _env ?? (_env = new InputMap<string>());
-            set => _env = value;
-        }
-
-        [Input("extraOptions")]
-        private InputList<string>? _extraOptions;
-
-        /// <summary>
-        /// A bag of extra options to pass on to the docker SDK.
-        /// </summary>
-        public InputList<string> ExtraOptions
-        {
-            get => _extraOptions ?? (_extraOptions = new InputList<string>());
-            set => _extraOptions = value;
-        }
-
         /// <summary>
         /// The target of the Dockerfile to build
         /// </summary>