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
-`owner_name` (String, Deprecated: Use `coder_workspace_owner.full_name` instead.) Name of the workspace owner.
38
38
-`owner_oidc_access_token` (String, Deprecated: Use `coder_workspace_owner.oidc_access_token` instead.) A valid OpenID Connect access token of the workspace owner. This is only available if the workspace owner authenticated with OpenID Connect. If a valid token cannot be obtained, this value will be an empty string.
39
39
-`owner_session_token` (String, Deprecated: Use `coder_workspace_owner.session_token` instead.) Session token for authenticating with a Coder deployment. It is regenerated everytime a workspace is started.
40
-
-`start_count` (Number) A computed count based on "transition" state. If "start", count will equal 1.
40
+
-`start_count` (Number) A computed count based on `transition` state. If `start`, count will equal 1.
41
41
-`template_id` (String) ID of the workspace's template.
42
42
-`template_name` (String) Name of the workspace's template.
43
43
-`template_version` (String) Version of the workspace's template.
44
-
-`transition` (String) Either "start" or "stop". Use this to start/stop resources with "count".
44
+
-`transition` (String) Either `start` or `stop`. Use this to start/stop resources with `count`.
-`arch` (String) The architecture the agent will run on. Must be one of: "amd64", "armv7", "arm64".
70
-
-`os` (String) The operating system the agent will run on. Must be one of: "linux", "darwin", or "windows".
69
+
-`arch` (String) The architecture the agent will run on. Must be one of: `amd64`, `armv7`, `arm64`.
70
+
-`os` (String) The operating system the agent will run on. Must be one of: `linux`, `darwin`, or `windows`.
71
71
72
72
### Optional
73
73
74
-
-`auth` (String) The authentication type the agent will use. Must be one of: "token", "google-instance-identity", "aws-instance-identity", "azure-instance-identity".
74
+
-`auth` (String) The authentication type the agent will use. Must be one of: `token`, `google-instance-identity`, `aws-instance-identity`, `azure-instance-identity`.
75
75
-`connection_timeout` (Number) Time in seconds until the agent is marked as timed out when a connection with the server cannot be established. A value of zero never marks the agent as timed out.
76
-
-`dir` (String) The starting directory when a user creates a shell session. Defaults to $HOME.
76
+
-`dir` (String) The starting directory when a user creates a shell session. Defaults to `$HOME`.
77
77
-`display_apps` (Block Set, Max: 1) The list of built-in apps to display in the agent bar. (see [below for nested schema](#nestedblock--display_apps))
78
78
-`env` (Map of String) A mapping of environment variables to set inside the workspace.
79
-
-`login_before_ready` (Boolean, Deprecated: Configure startup_script_behavior instead. This attribute will be removed in a future version of the provider.) This option defines whether or not the user can (by default) login to the workspace before it is ready. Ready means that e.g. the startup_script is done and has exited. When enabled, users may see an incomplete workspace when logging in.
80
-
-`metadata` (Block List) Each "metadata" block defines a single item consisting of a key/value pair. This feature is in alpha and may break in future releases. (see [below for nested schema](#nestedblock--metadata))
81
-
-`motd_file` (String) The path to a file within the workspace containing a message to display to users when they login via SSH. A typical value would be /etc/motd.
79
+
-`login_before_ready` (Boolean, Deprecated: Configure startup_script_behavior instead. This attribute will be removed in a future version of the provider.) This option defines whether or not the user can (by default) login to the workspace before it is ready. Ready means that e.g. the `startup_script` is done and has exited. When enabled, users may see an incomplete workspace when logging in.
80
+
-`metadata` (Block List) Each `metadata` block defines a single item consisting of a key/value pair. This feature is in alpha and may break in future releases. (see [below for nested schema](#nestedblock--metadata))
81
+
-`motd_file` (String) The path to a file within the workspace containing a message to display to users when they login via SSH. A typical value would be `/etc/motd`.
82
82
-`order` (Number) The order determines the position of agents in the UI presentation. The lowest order is shown first and agents with equal order are sorted by name (ascending order).
83
-
-`shutdown_script` (String) A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped. This option is an alias for defining a "coder_script" resource with "run_on_stop" set to true.
83
+
-`shutdown_script` (String) A script to run before the agent is stopped. The script should exit when it is done to signal that the workspace can be stopped. This option is an alias for defining a `coder_script` resource with `run_on_stop` set to `true`.
84
84
-`shutdown_script_timeout` (Number, Deprecated: This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.) Time in seconds until the agent lifecycle status is marked as timed out during shutdown, this happens when the shutdown script has not completed (exited) in the given time.
85
-
-`startup_script` (String) A script to run after the agent starts. The script should exit when it is done to signal that the agent is ready. This option is an alias for defining a "coder_script" resource with "run_on_start" set to true.
86
-
-`startup_script_behavior` (String) This option sets the behavior of the "startup_script". When set to "blocking", the startup_script must exit before the workspace is ready. When set to "non-blocking", the startup_script may run in the background and the workspace will be ready immediately. Default is "non-blocking", although "blocking" is recommended. This option is an alias for defining a "coder_script" resource with "start_blocks_login" set to true (blocking).
85
+
-`startup_script` (String) A script to run after the agent starts. The script should exit when it is done to signal that the agent is ready. This option is an alias for defining a `coder_script` resource with `run_on_start` set to `true`.
86
+
-`startup_script_behavior` (String) This option sets the behavior of the `startup_script`. When set to `blocking`, the `startup_script` must exit before the workspace is ready. When set to `non-blocking`, the `startup_script` may run in the background and the workspace will be ready immediately. Default is `non-blocking`, although `blocking` is recommended. This option is an alias for defining a `coder_script` resource with `start_blocks_login` set to rue (blocking).
87
87
-`startup_script_timeout` (Number, Deprecated: This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.) Time in seconds until the agent lifecycle status is marked as timed out during start, this happens when the startup script has not completed (exited) in the given time.
88
88
-`troubleshooting_url` (String) A URL to a document with instructions for troubleshooting problems with the agent.
89
89
90
90
### Read-Only
91
91
92
92
-`id` (String) The ID of this resource.
93
93
-`init_script` (String) Run this script on startup of an instance to initialize the agent.
94
-
-`token` (String, Sensitive) Set the environment variable "CODER_AGENT_TOKEN" with this token to authenticate an agent.
94
+
-`token` (String, Sensitive) Set the environment variable `CODER_AGENT_TOKEN` with this token to authenticate an agent.
Use this resource to associate an instance ID with an agent for zero-trust authentication. This association is done automatically for "google_compute_instance", "aws_instance", "azurerm_linux_virtual_machine", and "azurerm_windows_virtual_machine" resources.
6
+
Use this resource to associate an instance ID with an agent for zero-trust authentication. This association is done automatically for google_compute_instance, aws_instance, azurerm_linux_virtual_machine, and azurerm_windows_virtual_machine resources.
7
7
---
8
8
9
9
# coder_agent_instance (Resource)
10
10
11
-
Use this resource to associate an instance ID with an agent for zero-trust authentication. This association is done automatically for "google_compute_instance", "aws_instance", "azurerm_linux_virtual_machine", and "azurerm_windows_virtual_machine" resources.
11
+
Use this resource to associate an instance ID with an agent for zero-trust authentication. This association is done automatically for `google_compute_instance`, `aws_instance`, `azurerm_linux_virtual_machine`, and `azurerm_windows_virtual_machine` resources.
Copy file name to clipboardExpand all lines: docs/resources/app.md
+9-9
Original file line number
Diff line number
Diff line change
@@ -54,22 +54,22 @@ resource "coder_app" "vim" {
54
54
55
55
### Required
56
56
57
-
-`agent_id` (String) The "id" property of a "coder_agent" resource to associate with.
57
+
-`agent_id` (String) The `id` property of a `coder_agent` resource to associate with.
58
58
-`slug` (String) A hostname-friendly name for the app. This is used in URLs to access the app. May contain alphanumerics and hyphens. Cannot start/end with a hyphen or contain two consecutive hyphens.
59
59
60
60
### Optional
61
61
62
-
-`command` (String) A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either "command" or "url" may be specified, but not both.
62
+
-`command` (String) A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. Either `command` or `url` may be specified, but not both.
63
63
-`display_name` (String) A display name to identify the app. Defaults to the slug.
64
-
-`external` (Boolean) Specifies whether "url" is opened on the client machine instead of proxied through the workspace.
64
+
-`external` (Boolean) Specifies whether `url` is opened on the client machine instead of proxied through the workspace.
65
65
-`healthcheck` (Block Set, Max: 1) HTTP health checking to determine the application readiness. (see [below for nested schema](#nestedblock--healthcheck))
66
-
-`icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
66
+
-`icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + /icon/<path>`.
67
67
-`name` (String, Deprecated: `name` on apps is deprecated, use `display_name` instead) A display name to identify the app.
68
68
-`order` (Number) The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order).
69
-
-`relative_path` (Boolean, Deprecated: `relative_path` on apps is deprecated, use `subdomain` instead.) Specifies whether the URL will be accessed via a relative path or wildcard. Use if wildcard routing is unavailable. Defaults to true.
70
-
-`share` (String) Determines the "level" which the application is shared at. Valid levels are "owner" (default), "authenticated" and "public". Level "owner" disables sharing on the app, so only the workspace owner can access it. Level "authenticated" shares the app with all authenticated users. Level "public" shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on `coder server` (Enterprise only).
71
-
-`subdomain` (Boolean) Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with "subdomain" set to true will not be accessible. Defaults to false.
72
-
-`url` (String) An external url if "external=true" or a URL to be proxied to from inside the workspace. This should be of the form "http://localhost:PORT[/SUBPATH]". Either "command" or "url" may be specified, but not both.
69
+
-`relative_path` (Boolean, Deprecated: `relative_path` on apps is deprecated, use `subdomain` instead.) Specifies whether the URL will be accessed via a relative path or wildcard. Use if wildcard routing is unavailable. Defaults to `true`.
70
+
-`share` (String) Determines the level which the application is shared at. Valid levels are `owner` (default), `authenticated` and `public`. Level `owner` disables sharing on the app, so only the workspace owner can access it. Level `authenticated` shares the app with all authenticated users. Level `public` shares it with any user, including unauthenticated users. Permitted application sharing levels can be configured site-wide via a flag on `coder server` (Enterprise only).
71
+
-`subdomain` (Boolean) Determines whether the app will be accessed via it's own subdomain or whether it will be accessed via a path on Coder. If wildcards have not been setup by the administrator then apps with `subdomain` set to true will not be accessible. Defaults to false.
72
+
-`url` (String) An external url if `external=true` or a URL to be proxied to from inside the workspace. This should be of the form `http://localhost:PORT[/SUBPATH]`. Either `command` or `url` may be specified, but not both.
73
73
74
74
### Read-Only
75
75
@@ -82,4 +82,4 @@ Required:
82
82
83
83
-`interval` (Number) Duration in seconds to wait between healthcheck requests.
84
84
-`threshold` (Number) Number of consecutive heathcheck failures before returning an unhealthy status.
85
-
-`url` (String) HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before healthcheck.interval seconds.
85
+
-`url` (String) HTTP address used determine the application readiness. A successful health check is a HTTP response code less than 500 returned before `healthcheck.interval` seconds.
Use this resource to set an environment variable in a workspace. Note that this resource cannot be used to overwrite existing environment variables set on the "coder_agent" resource.
6
+
Use this resource to set an environment variable in a workspace. Note that this resource cannot be used to overwrite existing environment variables set on the coder_agent resource.
7
7
---
8
8
9
9
# coder_env (Resource)
10
10
11
-
Use this resource to set an environment variable in a workspace. Note that this resource cannot be used to overwrite existing environment variables set on the "coder_agent" resource.
11
+
Use this resource to set an environment variable in a workspace. Note that this resource cannot be used to overwrite existing environment variables set on the `coder_agent` resource.
-`resource_id` (String) The "id" property of another resource that metadata should be attached to.
62
+
-`resource_id` (String) The `id` property of another resource that metadata should be attached to.
63
63
64
64
### Optional
65
65
66
66
-`daily_cost` (Number) (Enterprise) The cost of this resource every 24 hours. Use the smallest denomination of your preferred currency. For example, if you work in USD, use cents.
67
67
-`hide` (Boolean) Hide the resource from the UI.
68
68
-`icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icon. Use a built-in icon with `data.coder_workspace.me.access_url + "/icon/<path>"`.
69
-
-`item` (Block List) Each "item" block defines a single metadata item consisting of a key/value pair. (see [below for nested schema](#nestedblock--item))
69
+
-`item` (Block List) Each `item` block defines a single metadata item consisting of a key/value pair. (see [below for nested schema](#nestedblock--item))
70
70
71
71
### Read-Only
72
72
@@ -81,7 +81,7 @@ Required:
81
81
82
82
Optional:
83
83
84
-
-`sensitive` (Boolean) Set to "true" to for items such as API keys whose values should be hidden from view by default. Note that this does not prevent metadata from being retrieved using the API, so it is not suitable for secrets that should not be exposed to workspace users.
84
+
-`sensitive` (Boolean) Set to `true` to for items such as API keys whose values should be hidden from view by default. Note that this does not prevent metadata from being retrieved using the API, so it is not suitable for secrets that should not be exposed to workspace users.
85
85
-`value` (String) The value of this metadata item.
0 commit comments