You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
-`builder_image` (String) The builder image URL to use if the cache does not exist.
36
+
-`builder_image` (String) The builder image to use if the cache does not exist.
37
37
-`cache_repo` (String) The name of the container registry to fetch the cache image from.
38
38
-`git_url` (String) The URL of a Git repository containing a Devcontainer or Docker image to clone.
39
39
40
40
### Optional
41
41
42
-
-`base_image_cache_dir` (String) TODO
43
-
-`build_context_path` (String) TODO
42
+
-`base_image_cache_dir` (String) The path to a directory where the base image can be found. This should be a read-only directory solely mounted for the purpose of caching the base image.
43
+
-`build_context_path` (String) Can be specified when a DockerfilePath is specified outside the base WorkspaceFolder. This path MUST be relative to the WorkspaceFolder path into which the repo is cloned.
44
44
-`cache_ttl_days` (Number) The number of days to use cached layers before expiring them. Defaults to 7 days.
45
-
-`devcontainer_dir` (String) TODO
46
-
-`devcontainer_json_path` (String) TODO
47
-
-`docker_config_base64` (String) TODO
48
-
-`dockerfile_path` (String) TODO
49
-
-`exit_on_build_failure` (Boolean) TODO
45
+
-`devcontainer_dir` (String) The path to the folder containing the devcontainer.json file that will be used to build the workspace and can either be an absolute path or a path relative to the workspace folder. If not provided, defaults to `.devcontainer`.
46
+
-`devcontainer_json_path` (String) The path to a devcontainer.json file that is either an absolute path or a path relative to DevcontainerDir. This can be used in cases where one wants to substitute an edited devcontainer.json file for the one that exists in the repo.
47
+
-`docker_config_base64` (String) The base64 encoded Docker config file that will be used to pull images from private container registries.
48
+
-`dockerfile_path` (String) The relative path to the Dockerfile that will be used to build the workspace. This is an alternative to using a devcontainer that some might find simpler.
49
+
-`exit_on_build_failure` (Boolean) Terminates upon a build failure. This is handy when preferring the FALLBACK_IMAGE in cases where no devcontainer.json or image is provided. However, it ensures that the container stops if the build process encounters an error.
50
50
-`extra_env` (Map of String) Extra environment variables to set for the container. This may include evbuilder options.
51
-
-`fallback_image` (String) TODO
52
-
-`git_clone_depth` (Number) TODO
53
-
-`git_clone_single_branch` (Boolean) TODO
54
-
-`git_http_proxy_url` (String) TODO
51
+
-`fallback_image` (String) Specifies an alternative image to use when neither an image is declared in the devcontainer.json file nor a Dockerfile is present. If there's a build failure (from a faulty Dockerfile) or a misconfiguration, this image will be the substitute. Set ExitOnBuildFailure to true to halt the container if the build faces an issue.
52
+
-`git_clone_depth` (Number) The depth to use when cloning the Git repository.
53
+
-`git_clone_single_branch` (Boolean) Clone only a single branch of the Git repository.
54
+
-`git_http_proxy_url` (String) The URL for the HTTP proxy. This is optional.
55
55
-`git_password` (String, Sensitive) The password to use for Git authentication. This is optional.
56
-
-`git_ssh_private_key_path` (String) TODO
56
+
-`git_ssh_private_key_path` (String) Path to an SSH private key to be used for Git authentication.
57
57
-`git_username` (String) The username to use for Git authentication. This is optional.
58
-
-`ignore_paths` (List of String) TODO
59
-
-`insecure` (Boolean) TODO
60
-
-`ssl_cert_base64` (String) TODO
58
+
-`ignore_paths` (List of String) The comma separated list of paths to ignore when building the workspace.
59
+
-`insecure` (Boolean) Bypass TLS verification when cloning and pulling from container registries.
60
+
-`ssl_cert_base64` (String) The content of an SSL cert file. This is useful for self-signed certificates.
61
61
-`verbose` (Boolean) Enable verbose output.
62
62
63
63
### Read-Only
64
64
65
65
-`env` (List of String) Computed envbuilder configuration to be set for the container.
66
66
-`exists` (Boolean) Whether the cached image was exists or not for the given config.
67
-
-`id` (String) Cached image identifier
67
+
-`id` (String) Cached image identifier. This will generally be the image's SHA256 digest.
68
68
-`image` (String) Outputs the cached image URL if it exists, otherwise the builder image URL is output instead.
MarkdownDescription: "The path to a directory where the base image can be found. This should be a read-only directory solely mounted for the purpose of caching the base image.",
80
80
Optional: true,
81
81
},
82
82
"build_context_path": schema.StringAttribute{
83
-
MarkdownDescription: "TODO",
83
+
MarkdownDescription: "Can be specified when a DockerfilePath is specified outside the base WorkspaceFolder. This path MUST be relative to the WorkspaceFolder path into which the repo is cloned.",
84
84
Optional: true,
85
85
},
86
86
"builder_image": schema.StringAttribute{
87
-
MarkdownDescription: "The builder image URL to use if the cache does not exist.",
87
+
MarkdownDescription: "The builder image to use if the cache does not exist.",
MarkdownDescription: "The path to the folder containing the devcontainer.json file that will be used to build the workspace and can either be an absolute path or a path relative to the workspace folder. If not provided, defaults to `.devcontainer`.",
100
100
Optional: true,
101
101
},
102
102
"devcontainer_json_path": schema.StringAttribute{
103
-
MarkdownDescription: "TODO",
103
+
MarkdownDescription: "The path to a devcontainer.json file that is either an absolute path or a path relative to DevcontainerDir. This can be used in cases where one wants to substitute an edited devcontainer.json file for the one that exists in the repo.",
104
104
Optional: true,
105
105
},
106
106
"dockerfile_path": schema.StringAttribute{
107
-
MarkdownDescription: "TODO",
107
+
MarkdownDescription: "The relative path to the Dockerfile that will be used to build the workspace. This is an alternative to using a devcontainer that some might find simpler.",
108
108
Optional: true,
109
109
},
110
110
"docker_config_base64": schema.StringAttribute{
111
-
MarkdownDescription: "TODO",
111
+
MarkdownDescription: "The base64 encoded Docker config file that will be used to pull images from private container registries.",
MarkdownDescription: "Terminates upon a build failure. This is handy when preferring the FALLBACK_IMAGE in cases where no devcontainer.json or image is provided. However, it ensures that the container stops if the build process encounters an error.",
MarkdownDescription: "Specifies an alternative image to use when neither an image is declared in the devcontainer.json file nor a Dockerfile is present. If there's a build failure (from a faulty Dockerfile) or a misconfiguration, this image will be the substitute. Set ExitOnBuildFailure to true to halt the container if the build faces an issue.",
136
136
Optional: true,
137
137
},
138
138
"git_clone_depth": schema.Int64Attribute{
139
-
MarkdownDescription: "TODO",
139
+
MarkdownDescription: "The depth to use when cloning the Git repository.",
140
140
Optional: true,
141
141
},
142
142
"git_clone_single_branch": schema.BoolAttribute{
143
-
MarkdownDescription: "TODO",
143
+
MarkdownDescription: "Clone only a single branch of the Git repository.",
144
144
Optional: true,
145
145
},
146
146
"git_http_proxy_url": schema.StringAttribute{
147
-
MarkdownDescription: "TODO",
147
+
MarkdownDescription: "The URL for the HTTP proxy. This is optional.",
0 commit comments