synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-15 22:20:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(admin/templates/): fix terraform provider links (#16338)

Browse Source
This commit is contained in:
Guspan Tanadi
2025-01-30 16:08:59 +07:00
committed by GitHub
parent 3a179e9e97
commit 1aee589095
2 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/admin/templates/extending-templates/workspace-tags.md
View File

@ -71,7 +71,7 @@ added that can handle its combination of tags.
Before releasing the template version with configurable workspace tags, ensure Before releasing the template version with configurable workspace tags, ensure
that every tag set is associated with at least one healthy provisioner. 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. > tag restrictions that is able to take on any job.
### Parameters types ### Parameters types

24
docs/admin/templates/troubleshooting.md
View File

@ -2,7 +2,7 @@
Occasionally, you may run into scenarios where a workspace is created, but the Occasionally, you may run into scenarios where a workspace is created, but the
agent is either not connected or 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. has failed or timed out.
## Agent connection issues ## Agent connection issues
@ -36,18 +36,18 @@ practices:
## Startup script issues ## Startup script issues
Depending on the contents of the 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 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 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. script. In this section we will cover common scenarios and how to resolve them.
### Unable to access workspace, startup script is still running ### Unable to access workspace, startup script is still running
If you're trying to access your workspace and are unable to because the 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 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. 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 `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 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). Linux, `ps` and `kill` are useful tools).
For tips on how to write a startup script that doesn't run forever, see the 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 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. section.
Template authors can also set the 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 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 startup script is still running. Note that the workspace must be updated after
changing this option. 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 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. be aware that programs, files, or settings may be missing from your workspace.
This can happen if the 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 is still running or has exited with a non-zero status (see
[startup script error](#startup-script-exited-with-an-error)). No action is [startup script error](#startup-script-exited-with-an-error)). No action is
necessary, but you may want to necessary, but you may want to
@ -86,7 +86,7 @@ issues.
### Session was started before the startup script finished ### Session was started before the startup script finished
The web terminal may show this message if it was started before the 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 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 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 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 ### Startup script exited with an error
When the 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 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 `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 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 ### Debugging the startup script
The simplest way to debug the 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 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 not already visible). This will show all the output from the script. Another
option is to view the log file inside the workspace (usually option is to view the log file inside the workspace (usually