opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-22 05:05:20 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: expand on TTL flags (#9286)

Browse Source 
* docs: expand on TTL flags

* make: gen

* Discard changes to site/src/api/api.ts

* Discard changes to site/src/xServices/templateVersion/templateVersionXService.ts

---------

Co-authored-by: Muhammad Atif Ali <matifali@live.com>
Co-authored-by: Muhammad Atif Ali <atif@coder.com>
This commit is contained in:
Eric Paulsen
2023-08-25 13:39:12 -04:00
committed by GitHub
co-authored by Muhammad Atif Ali Muhammad Atif Ali
parent f149db6ca6
commit 91f900ec64
6 changed files with 37 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/cli/templates_create.md
Generated
+3 -3
View File
@@ -19,7 +19,7 @@ coder templates create [flags] [name]
| Type | <code>duration</code> |
| Default | <code>24h</code> |
Specify a default TTL for workspaces created from this template.
Specify a default TTL for workspaces created from this template. It is the default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### -d, --directory
@@ -37,7 +37,7 @@ Specify the directory to create from, use '-' to read tar from stdin.
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a failure TTL for workspaces created from this template. This licensed feature's default is 0h (off).
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup"in the UI.
### --ignore-lockfile
@@ -55,7 +55,7 @@ Ignore warnings about not having a .terraform.lock.hcl file present in the templ
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).
Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --max-ttl
docs/cli/templates_edit.md
Generated
+4 -4
View File
@@ -45,7 +45,7 @@ Allow users to cancel in-progress workspace jobs.
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template default time before shutdown - workspaces created from this template default to this value.
Edit the template default time before shutdown - workspaces created from this template default to this value. Maps to "Default autostop" in the UI.
### --description
@@ -70,7 +70,7 @@ Edit the template display name.
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify a failure TTL for workspaces created from this template. This licensed feature's default is 0h (off).
Specify a failure TTL for workspaces created from this template. It is the amount of time after a failed "start" build before coder automatically schedules a "stop" build to cleanup.This licensed feature's default is 0h (off). Maps to "Failure cleanup" in the UI.
### --icon
@@ -87,7 +87,7 @@ Edit the template icon path.
| Type | <code>duration</code> |
| Default | <code>0h</code> |
Specify an inactivity TTL for workspaces created from this template. This licensed feature's default is 0h (off).
Specify an inactivity TTL for workspaces created from this template. It is the amount of time the workspace is not used before it is be stopped and auto-locked. This includes across multiple builds (e.g. auto-starts and stops). This licensed feature's default is 0h (off). Maps to "Dormancy threshold" in the UI.
### --max-ttl
@@ -95,7 +95,7 @@ Specify an inactivity TTL for workspaces created from this template. This licens
| ---- | --------------------- |
| Type | <code>duration</code> |
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting. This is an enterprise-only feature.
Edit the template maximum time before shutdown - workspaces created from this template must shutdown within the given duration after starting, regardless of user activity. This is an enterprise-only feature. Maps to "Max lifetime" in the UI.
### --name