opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-09-24 15:04:27 +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
cli/testdata/coder_templates_create_--help.golden
Vendored
+11 -4
View File
@@ -4,14 +4,18 @@ Create a template from the current directory or as specified by flag
Options
--default-ttl duration (default: 24h)
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 string (default: .)
Specify the directory to create from, use '-' to read tar from stdin.
--failure-ttl duration (default: 0h)
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 bool (default: false)
Ignore warnings about not having a .terraform.lock.hcl file present in
@@ -19,7 +23,10 @@ Create a template from the current directory or as specified by flag
--inactivity-ttl duration (default: 0h)
Specify an inactivity TTL for workspaces created from this template.
This licensed feature's default is 0h (off).
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 duration
Edit the template maximum time before shutdown - workspaces created
cli/testdata/coder_templates_edit_--help.golden
Vendored
+12 -5
View File
@@ -16,7 +16,8 @@ Edit the metadata of a template by name.
--default-ttl duration
Edit the template default time before shutdown - workspaces created
from this template default to this value.
from this template default to this value. Maps to "Default autostop"
in the UI.
--description string
Edit the template description.
@@ -25,20 +26,26 @@ Edit the metadata of a template by name.
Edit the template display name.
--failure-ttl duration (default: 0h)
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 string
Edit the template icon path.
--inactivity-ttl duration (default: 0h)
Specify an inactivity TTL for workspaces created from this template.
This licensed feature's default is 0h (off).
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 duration
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.
starting, regardless of user activity. This is an enterprise-only
feature. Maps to "Max lifetime" in the UI.
--name string
Edit the template name.