Skip to content

Commit e9d67f9

Browse files
authored
docs: deprecate startup_script_timeout & shutdown_script_timeout (#188)
* docs: deprecate startup_script_timeout & shutdown_script_timeout * make: gen
1 parent ec80a8a commit e9d67f9

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

Diff for: docs/resources/agent.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ resource "kubernetes_pod" "dev" {
7878
- `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))
7979
- `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.
8080
- `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.
81-
- `shutdown_script_timeout` (Number) 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.
81+
- `shutdown_script_timeout` (Number, Deprecated) 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.
8282
- `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.
8383
- `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.
84-
- `startup_script_timeout` (Number) 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.
84+
- `startup_script_timeout` (Number, Deprecated) 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.
8585
- `troubleshooting_url` (String) A URL to a document with instructions for troubleshooting problems with the agent.
8686

8787
### Read-Only

Diff for: provider/agent.go

+2
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ func agentResource() *schema.Resource {
131131
ForceNew: true,
132132
Optional: true,
133133
Description: "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.",
134+
Deprecated: "This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.",
134135
ValidateFunc: validation.IntAtLeast(1),
135136
},
136137
"shutdown_script": {
@@ -145,6 +146,7 @@ func agentResource() *schema.Resource {
145146
ForceNew: true,
146147
Optional: true,
147148
Description: "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.",
149+
Deprecated: "This feature is deprecated and has no effect. This attribute will be removed in a future version of the provider.",
148150
ValidateFunc: validation.IntAtLeast(1),
149151
},
150152
"token": {

0 commit comments

Comments
 (0)