Skip to content

chore: clarify template provisioning speed doc #15383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 8, 2024
Merged

chore: clarify template provisioning speed doc #15383

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7b8c27
Clarify template caching doc
dannykopping Nov 5, 2024
800ff8a
Correct links
dannykopping Nov 6, 2024
1819f78
copy edit
EdwardAngert Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
copy edit
  • Loading branch information
@EdwardAngert
EdwardAngert committed Nov 8, 2024
commit 1819f782e9c20dee0134ff2074368d59d2fe4b3a
20 changes: 10 additions & 10 deletions docs/tutorials/best-practices/speed-up-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ potentially optimize within the template.

![Screenshot of a workspace and its build timeline](../../images/best-practice/build-timeline.png)

You can retrieve this detail programmatically from the API, as well:
You can also retrieve this detail programmatically from the API:

```shell
curl -X GET https://coder.example.com/api/v2/workspacebuilds/{workspacebuild}/timings \
Expand All @@ -37,8 +37,8 @@ for more information.

Use the [Observability Helm chart](https://github.com/coder/observability) for a
pre-built set of dashboards to monitor your Coder deployments over time. It
includes pre-configured Grafana, Prometheus, Loki, and Alertmanager instances to
ingest and display key observability data.
includes pre-configured instances of Grafana, Prometheus, Loki, and Alertmanager
to ingest and display key observability data.

We recommend that all administrators deploying on Kubernetes or on an existing
Prometheus or Grafana stack set the observability bundle up with the control
Expand Down Expand Up @@ -123,12 +123,12 @@ for more information.
### Template lock file

On each workspace build, Terraform will examine the providers used by the
template and attempt to download the latest version of each provider (unless
constrained to a specific version). Terraform exposes a mechanism to build a
template and attempt to download the latest version of each provider unless it
is constrained to a specific version. Terraform exposes a mechanism to build a
static list of provider versions, which improves cacheability.

Without caching, Terraform will need to download each provider on each build,
and this can create unnecessary network and disk I/O.
Without caching, Terraform will download each provider on each build, and this
can create unnecessary network and disk I/O.

`terraform init` generates a `.terraform.lock.hcl` which instructs Coder
provisioners to cache specific versions of your providers.
Expand All @@ -153,7 +153,7 @@ To use `terraform init` to build the static provider version list:
coder templates push <template>
```

This will bundle up your template and the lock file and upload it to Coder. The
This bundles up your template and the lock file and uploads it to Coder. The
next time the template is used, Terraform will attempt to cache the specific
provider versions.

Expand All @@ -164,5 +164,5 @@ configured [`CODER_CACHE_DIRECTORY`](../../reference/cli/server.md#--cache-dir)
directory.

Ensure that this directory is set to a location on disk which will persist
across restarts of Coder (or
[External Provisioners](../../admin/provisioners.md), if you're using them).
across restarts of Coder or
[external provisioners](../../admin/provisioners.md), if you're using them.
Loading