Skip to content

Commit 3073ab7

Browse files
committed
make fmt
1 parent 4a42588 commit 3073ab7

File tree

1 file changed

+47
-16
lines changed

1 file changed

+47
-16
lines changed

docs/tutorials/best-practices/speed-up-templates.md

Lines changed: 47 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,22 @@ October 31, 2024
44

55
---
66

7-
If it takes your workspace a long time to start, find out why and make some changes to your Coder templates to help speed things up.
7+
If it takes your workspace a long time to start, find out why and make some
8+
changes to your Coder templates to help speed things up.
89

910
## Monitoring
1011

11-
You can monitor [Coder logs](../../admin/monitoring/logs.md) through the system-native tools on your deployment platform, or stream logs to tools like Splunk, Datadog, Grafana Loki, and others.
12+
You can monitor [Coder logs](../../admin/monitoring/logs.md) through the
13+
system-native tools on your deployment platform, or stream logs to tools like
14+
Splunk, Datadog, Grafana Loki, and others.
1215

1316
### Coder Observability Chart
1417

15-
Use the [Observability Helm chart](https://github.com/coder/observability) for a pre-built set of monitoring integrations.
18+
Use the [Observability Helm chart](https://github.com/coder/observability) for a
19+
pre-built set of monitoring integrations.
1620

17-
With the Observability Helm chart, you can monitor [which specific startup metrics are a part of the Helm chart?]
21+
With the Observability Helm chart, you can monitor [which specific startup
22+
metrics are a part of the Helm chart?]
1823

1924
To install it with Helm:
2025

@@ -25,15 +30,23 @@ helm upgrade --install coder-observability coder-observability/coder-observabili
2530

2631
### Enable Prometheus metrics for Coder
2732

28-
Our observability bundle gives you this for free which is nice and has instructions on how to do it with Coder
33+
Our observability bundle gives you this for free which is nice and has
34+
instructions on how to do it with Coder
2935

30-
[Prometheus.io](https://prometheus.io/docs/introduction/overview/#what-is-prometheus) is included as part of the [observability chart](#coder-observability-chart).It offers a variety of [available metrics](../../admin/integrations/prometheus.md#available-metrics).
36+
[Prometheus.io](https://prometheus.io/docs/introduction/overview/#what-is-prometheus)
37+
is included as part of the [observability chart](#coder-observability-chart).It
38+
offers a variety of
39+
[available metrics](../../admin/integrations/prometheus.md#available-metrics).
3140

32-
You can [install it separately](https://prometheus.io/docs/prometheus/latest/getting_started/) if you prefer.
41+
You can
42+
[install it separately](https://prometheus.io/docs/prometheus/latest/getting_started/)
43+
if you prefer.
3344

3445
### Workspace build timeline
3546

36-
Use the **Build timeline** to monitor the time it takes to start specific workspaces. Identify long scripts, resources, and other things you can potentially optimize within the template.
47+
Use the **Build timeline** to monitor the time it takes to start specific
48+
workspaces. Identify long scripts, resources, and other things you can
49+
potentially optimize within the template.
3750

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

@@ -45,29 +58,45 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/tim
4558
-H 'Coder-Session-Token: API_KEY'
4659
```
4760

48-
Visit the [API documentation](../../reference/api/builds.md#get-workspace-build-timings-by-id) for more information.
61+
Visit the
62+
[API documentation](../../reference/api/builds.md#get-workspace-build-timings-by-id)
63+
for more information.
4964

5065
## Provisioners
5166

52-
`coder server` defaults to three provisioner daemons. Each provisioner daemon can handle one single job, such as start, stop, or delete at a time and can be resource intensive. When all provisioners are busy, workspaces enter a "pending" state until a provisioner becomes available.
67+
`coder server` defaults to three provisioner daemons. Each provisioner daemon
68+
can handle one single job, such as start, stop, or delete at a time and can be
69+
resource intensive. When all provisioners are busy, workspaces enter a "pending"
70+
state until a provisioner becomes available.
5371

5472
### Increase provisioner daemons
5573

56-
Provisioners are queue-based to reduce unpredictable load to the Coder server. However, they can be scaled up to allow more concurrent provisioners. You risk overloading the central Coder server if you use too many local provisioners, so we recommend a maximum of five provisioners. For more than five provisioners, we recommend that you move to [external provisioners](../../admin/provisioners.md).
74+
Provisioners are queue-based to reduce unpredictable load to the Coder server.
75+
However, they can be scaled up to allow more concurrent provisioners. You risk
76+
overloading the central Coder server if you use too many local provisioners, so
77+
we recommend a maximum of five provisioners. For more than five provisioners, we
78+
recommend that you move to [external provisioners](../../admin/provisioners.md).
5779

58-
If you can’t move to external provisioners, use the `provisioner-daemons` flag to increase the number of provisioner daemons to five:
80+
If you can’t move to external provisioners, use the `provisioner-daemons` flag
81+
to increase the number of provisioner daemons to five:
5982

6083
```shell
6184
coder server --provisioner-daemons=5
6285
```
6386

64-
Visit the [CLI documentation](../../reference/cli/server.md#--provisioner-daemons) for more information about increasing provisioner daemons and other options.
87+
Visit the
88+
[CLI documentation](../../reference/cli/server.md#--provisioner-daemons) for
89+
more information about increasing provisioner daemons and other options.
6590

6691
### Adjust provisioner CPU/memory
6792

68-
We recommend that you deploy Coder to its own respective Kubernetes cluster, separate from production applications. Keep in mind that Coder runs development workloads, so the cluster should be deployed as such, without production-level configurations.
93+
We recommend that you deploy Coder to its own respective Kubernetes cluster,
94+
separate from production applications. Keep in mind that Coder runs development
95+
workloads, so the cluster should be deployed as such, without production-level
96+
configurations.
6997

70-
Adjust the CPU and memory values as shown in [Helm provisioner values.yaml](https://github.com/coder/coder/blob/main/helm/provisioner/values.yaml#L134-L141):
98+
Adjust the CPU and memory values as shown in
99+
[Helm provisioner values.yaml](https://github.com/coder/coder/blob/main/helm/provisioner/values.yaml#L134-L141):
71100

72101
```yaml
73102
@@ -82,7 +111,9 @@ Adjust the CPU and memory values as shown in [Helm provisioner values.yaml](http
82111
83112
```
84113

85-
Visit the [validated architecture documentation](../../admin/infrastructure/validated-architectures/index.md#workspace-nodes) for more information.
114+
Visit the
115+
[validated architecture documentation](../../admin/infrastructure/validated-architectures/index.md#workspace-nodes)
116+
for more information.
86117

87118
## Set up Terraform Provider Caching
88119

0 commit comments

Comments
 (0)