fixup! Rename allow_login_before_ready to delay_login_until_ready

mafredri · mafredri · commit ebc4d6a05219 · 2023-01-19T12:55:56.000Z
diff --git a/docs/resources/agent.md b/docs/resources/agent.md
@@ -46,14 +46,14 @@ resource "kubernetes_pod" "dev" {
 
 ### Optional
 
-- `allow_login_before_ready` (Boolean) Allow users to login to the workspace before the agent is ready. Note that, when enabled, the agent could still be executing the startup script and the workspace in an incomplete state when logging in.
 - `auth` (String) The authentication type the agent will use. Must be one of: "token", "google-instance-identity", "aws-instance-identity", "azure-instance-identity".
 - `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.
+- `delay_login_until_ready` (Boolean) This option defines whether or not user logins to the workspace agent are delayed until the agent is ready. When disabled, users may see an incomplete workspace upon logging in.
 - `dir` (String) The starting directory when a user creates a shell session. Defaults to $HOME.
 - `env` (Map of String) A mapping of environment variables to set inside the workspace.
 - `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.
 - `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.
-- `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 to accept connections.
+- `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.
 - `startup_script_timeout` (Number) Time in seconds until the agent ready status is marked as timed out, this happens when the startup script has not completed (exited) in the given time.
 - `troubleshooting_url` (String) A URL to a document with instructions for troubleshooting problems with the agent.
 
diff --git a/provider/agent_test.go b/provider/agent_test.go
@@ -35,7 +35,7 @@ func TestAgent(t *testing.T) {
 					troubleshooting_url = "https://example.com/troubleshoot"
 					motd_file = "/etc/motd"
 					shutdown_script = "echo bye bye"
-					allow_login_before_ready = false
+					delay_login_until_ready = false
 				}
 				`,
 			Check: func(state *terraform.State) error {
@@ -56,7 +56,7 @@ func TestAgent(t *testing.T) {
 					"troubleshooting_url",
 					"motd_file",
 					"shutdown_script",
-					"allow_login_before_ready",
+					"delay_login_until_ready",
 				} {
 					value := resource.Primary.Attributes[key]
 					t.Logf("%q = %q", key, value)
