refactor: deprecate login_before_ready in favor of startup_script_behavior (#7837)

Fixes #7758
This commit is contained in:
Mathias Fredriksson
2023-06-06 11:58:07 +03:00
committed by GitHub
parent 93378daeb3
commit 660bbb8d38
37 changed files with 1238 additions and 857 deletions

16
coderd/apidoc/docs.go generated
View File

@ -9216,7 +9216,7 @@ const docTemplate = `{
"$ref": "#/definitions/codersdk.WorkspaceAgentLifecycle"
},
"login_before_ready": {
"description": "LoginBeforeReady if true, the agent will delay logins until it is ready (e.g. executing startup script has ended).",
"description": "Deprecated: Use StartupScriptBehavior instead.",
"type": "boolean"
},
"name": {
@ -9244,6 +9244,9 @@ const docTemplate = `{
"startup_script": {
"type": "string"
},
"startup_script_behavior": {
"$ref": "#/definitions/codersdk.WorkspaceAgentStartupScriptBehavior"
},
"startup_script_timeout_seconds": {
"description": "StartupScriptTimeoutSeconds is the number of seconds to wait for the startup script to complete. If the script does not complete within this time, the agent lifecycle will be marked as start_timeout.",
"type": "integer"
@ -9365,6 +9368,17 @@ const docTemplate = `{
}
}
},
"codersdk.WorkspaceAgentStartupScriptBehavior": {
"type": "string",
"enum": [
"blocking",
"non-blocking"
],
"x-enum-varnames": [
"WorkspaceAgentStartupScriptBehaviorBlocking",
"WorkspaceAgentStartupScriptBehaviorNonBlocking"
]
},
"codersdk.WorkspaceAgentStatus": {
"type": "string",
"enum": [