mirror of
https://github.com/coder/coder.git
synced 2025-07-18 14:17:22 +00:00
feat: allow templates to specify max_ttl or autostop_requirement (#10920)
This commit is contained in:
Dean Sheather
GitHub
25
docs/api/schemas.md
generated
25
docs/api/schemas.md
generated
@ -1607,7 +1607,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `allow_user_autostop` | boolean | false | | Allow user autostop allows users to set a custom workspace TTL to use in place of the template's DefaultTTL field. By default this is true. If false, the DefaultTTL will always be used. This can only be disabled when using an enterprise license. |
|
||||
| `allow_user_cancel_workspace_jobs` | boolean | false | | Allow users to cancel in-progress workspace jobs. \*bool as the default value is "true". |
|
||||
| `autostart_requirement` | [codersdk.TemplateAutostartRequirement](#codersdktemplateautostartrequirement) | false | | Autostart requirement allows optionally specifying the autostart allowed days for workspaces created from this template. This is an enterprise feature. |
|
||||
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement](#codersdktemplateautostoprequirement) | false | | Autostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature. |
|
||||
| `autostop_requirement` | [codersdk.TemplateAutostopRequirement](#codersdktemplateautostoprequirement) | false | | Autostop requirement allows optionally specifying the autostop requirement for workspaces created from this template. This is an enterprise feature. Only one of MaxTTLMillis or AutostopRequirement can be specified. |
|
||||
| `default_ttl_ms` | integer | false | | Default ttl ms allows optionally specifying the default TTL for all workspaces created from this template. |
|
||||
| `delete_ttl_ms` | integer | false | | Delete ttl ms allows optionally specifying the max lifetime before Coder permanently deletes dormant workspaces created from this template. |
|
||||
| `description` | string | false | | Description is a description of what the template contains. It must be less than 128 bytes. |
|
||||
@ -1616,7 +1616,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `dormant_ttl_ms` | integer | false | | Dormant ttl ms allows optionally specifying the max lifetime before Coder locks inactive workspaces created from this template. |
|
||||
| `failure_ttl_ms` | integer | false | | Failure ttl ms allows optionally specifying the max lifetime before Coder stops all resources for failed workspaces created from this template. |
|
||||
| `icon` | string | false | | Icon is a relative path or external URL that specifies an icon to be displayed in the dashboard. |
|
||||
| `max_ttl_ms` | integer | false | | Max ttl ms remove max_ttl once autostop_requirement is matured |
|
||||
| `max_ttl_ms` | integer | false | | Max ttl ms remove max_ttl once autostop_requirement is matured Only one of MaxTTLMillis or AutostopRequirement can be specified. |
|
||||
| `name` | string | true | | Name is the name of the template. |
|
||||
| `require_active_version` | boolean | false | | Require active version mandates that workspaces are built with the active template version. |
|
||||
| `template_version_id` | string | true | | Template version ID is an in-progress or completed job to use as an initial version of the template. |
|
||||
@ -2867,15 +2867,14 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
| Value |
|
||||
| ------------------------------- |
|
||||
| `moons` |
|
||||
| `workspace_actions` |
|
||||
| `tailnet_pg_coordinator` |
|
||||
| `single_tailnet` |
|
||||
| `template_autostop_requirement` |
|
||||
| `deployment_health_page` |
|
||||
| `template_update_policies` |
|
||||
| Value |
|
||||
| -------------------------- |
|
||||
| `moons` |
|
||||
| `workspace_actions` |
|
||||
| `tailnet_pg_coordinator` |
|
||||
| `single_tailnet` |
|
||||
| `deployment_health_page` |
|
||||
| `template_update_policies` |
|
||||
|
||||
## codersdk.ExternalAuth
|
||||
|
||||
@ -4501,7 +4500,8 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
"require_active_version": true,
|
||||
"time_til_dormant_autodelete_ms": 0,
|
||||
"time_til_dormant_ms": 0,
|
||||
"updated_at": "2019-08-24T14:15:22Z"
|
||||
"updated_at": "2019-08-24T14:15:22Z",
|
||||
"use_max_ttl": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -4536,6 +4536,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
|
||||
| `time_til_dormant_autodelete_ms` | integer | false | | |
|
||||
| `time_til_dormant_ms` | integer | false | | |
|
||||
| `updated_at` | string | false | | |
|
||||
| `use_max_ttl` | boolean | false | | Use max ttl picks whether to use the deprecated max TTL for the template or the new autostop requirement. |
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
|
||||
16
docs/api/templates.md
generated
16
docs/api/templates.md
generated
@ -66,7 +66,8 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
|
||||
"require_active_version": true,
|
||||
"time_til_dormant_autodelete_ms": 0,
|
||||
"time_til_dormant_ms": 0,
|
||||
"updated_at": "2019-08-24T14:15:22Z"
|
||||
"updated_at": "2019-08-24T14:15:22Z",
|
||||
"use_max_ttl": true
|
||||
}
|
||||
]
|
||||
```
|
||||
@ -118,6 +119,7 @@ Status Code **200**
|
||||
| `» time_til_dormant_autodelete_ms` | integer | false | | |
|
||||
| `» time_til_dormant_ms` | integer | false | | |
|
||||
| `» updated_at` | string(date-time) | false | | |
|
||||
| `» use_max_ttl` | boolean | false | | Use max ttl picks whether to use the deprecated max TTL for the template or the new autostop requirement. |
|
||||
|
||||
#### Enumerated Values
|
||||
|
||||
@ -223,7 +225,8 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/templa
|
||||
"require_active_version": true,
|
||||
"time_til_dormant_autodelete_ms": 0,
|
||||
"time_til_dormant_ms": 0,
|
||||
"updated_at": "2019-08-24T14:15:22Z"
|
||||
"updated_at": "2019-08-24T14:15:22Z",
|
||||
"use_max_ttl": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -361,7 +364,8 @@ curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/templat
|
||||
"require_active_version": true,
|
||||
"time_til_dormant_autodelete_ms": 0,
|
||||
"time_til_dormant_ms": 0,
|
||||
"updated_at": "2019-08-24T14:15:22Z"
|
||||
"updated_at": "2019-08-24T14:15:22Z",
|
||||
"use_max_ttl": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -675,7 +679,8 @@ curl -X GET http://coder-server:8080/api/v2/templates/{template} \
|
||||
"require_active_version": true,
|
||||
"time_til_dormant_autodelete_ms": 0,
|
||||
"time_til_dormant_ms": 0,
|
||||
"updated_at": "2019-08-24T14:15:22Z"
|
||||
"updated_at": "2019-08-24T14:15:22Z",
|
||||
"use_max_ttl": true
|
||||
}
|
||||
```
|
||||
|
||||
@ -796,7 +801,8 @@ curl -X PATCH http://coder-server:8080/api/v2/templates/{template} \
|
||||
"require_active_version": true,
|
||||
"time_til_dormant_autodelete_ms": 0,
|
||||
"time_til_dormant_ms": 0,
|
||||
"updated_at": "2019-08-24T14:15:22Z"
|
||||
"updated_at": "2019-08-24T14:15:22Z",
|
||||
"use_max_ttl": true
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user