diff --git a/docs/admin/templates/extending-templates/workspace-tags.md b/docs/admin/templates/extending-templates/workspace-tags.md index 96691fe162540..04bf64ad511c5 100644 --- a/docs/admin/templates/extending-templates/workspace-tags.md +++ b/docs/admin/templates/extending-templates/workspace-tags.md @@ -71,7 +71,7 @@ added that can handle its combination of tags. Before releasing the template version with configurable workspace tags, ensure that every tag set is associated with at least one healthy provisioner. -> [!NOTE] It may be useful to run at least one provisioner with no additional +> **Note:** It may be useful to run at least one provisioner with no additional > tag restrictions that is able to take on any job. ### Parameters types diff --git a/docs/admin/templates/troubleshooting.md b/docs/admin/templates/troubleshooting.md index e08a422938e2f..992811175f804 100644 --- a/docs/admin/templates/troubleshooting.md +++ b/docs/admin/templates/troubleshooting.md @@ -2,7 +2,7 @@ Occasionally, you may run into scenarios where a workspace is created, but the agent is either not connected or the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) has failed or timed out. ## Agent connection issues @@ -36,18 +36,18 @@ practices: ## Startup script issues Depending on the contents of the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script), +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1), and whether or not the -[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior) +[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1) is set to blocking or non-blocking, you may notice issues related to the startup script. In this section we will cover common scenarios and how to resolve them. ### Unable to access workspace, startup script is still running If you're trying to access your workspace and are unable to because the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) is still running, it means the -[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior) +[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1) option is set to blocking or you have enabled the `--wait=yes` option (for e.g. `coder ssh` or `coder config-ssh`). In such an event, you can always access the workspace by using the web terminal, or via SSH using the `--wait=no` option. If @@ -58,13 +58,13 @@ terminating processes started by it or terminating the startup script itself (on Linux, `ps` and `kill` are useful tools). For tips on how to write a startup script that doesn't run forever, see the -[`startup_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[`startup_script`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) section. For more ways to override the startup script behavior, see the -[`startup_script_behavior`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior) +[`startup_script_behavior`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1) section. Template authors can also set the -[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior) +[startup script behavior](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script_behavior-1) option to non-blocking, which will allow users to access the workspace while the startup script is still running. Note that the workspace must be updated after changing this option. @@ -74,7 +74,7 @@ changing this option. If you see a warning that your workspace may be incomplete, it means you should be aware that programs, files, or settings may be missing from your workspace. This can happen if the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) is still running or has exited with a non-zero status (see [startup script error](#startup-script-exited-with-an-error)). No action is necessary, but you may want to @@ -86,7 +86,7 @@ issues. ### Session was started before the startup script finished The web terminal may show this message if it was started before the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) finished, but the startup script has since finished. This message can safely be dismissed, however, be aware that your preferred shell or dotfiles may not yet be activated for this shell session. You can either start a new session or @@ -102,7 +102,7 @@ Examples for activating your preferred shell or sourcing your dotfiles: ### Startup script exited with an error When the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) exits with an error, it means the last command run by the script failed. When `set -e` is used, this means that any failing command will immediately exit the script and the remaining commands will not be executed. This also means that @@ -120,7 +120,7 @@ Common causes for startup script errors: ### Debugging the startup script The simplest way to debug the -[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script) +[startup script](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent#startup_script-1) is to open the workspace in the Coder dashboard and click "Show startup log" (if not already visible). This will show all the output from the script. Another option is to view the log file inside the workspace (usually