Skip to content

Commit ea545e0

Browse files
dependabot[bot]ammario
authored andcommitted
chore: bump github.com/nhatthm/otelsql from 0.3.0 to 0.3.3 (#2415)
Bumps [github.com/nhatthm/otelsql](https://github.com/nhatthm/otelsql) from 0.3.0 to 0.3.3. - [Release notes](https://github.com/nhatthm/otelsql/releases) - [Commits](nhatthm/otelsql@v0.3.0...v0.3.3) --- updated-dependencies: - dependency-name: github.com/nhatthm/otelsql dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
1 parent c9691ea commit ea545e0

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

docs/quickstart.md

-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Quickstart
22

3-
This guide will walk you through creating your first template and workspace.
4-
53
## Prerequisites
64

75
Please [install Coder](./install.md) before proceeding with the steps outlined in this article.

docs/templates.md

+13-8
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,11 @@ coder templates <create/update> <template-name>
2525

2626
## Parameters
2727

28-
Templates often contain *parameters*. In Coder, there are two types of parameters:
28+
Templates often contain _parameters_. In Coder, there are two types of parameters:
2929

3030
- **Admin parameters** are set when a template is created/updated. These values
3131
are often cloud secrets, such as a `ServiceAccount` token, and are annotated
32-
with `sensitive = true` in the template code.
33-
32+
with `sensitive = true` in the template code.
3433
- **User parameters** are set when a user creates a workspace. They are unique
3534
to each workspace, often personalization settings such as "preferred region"
3635
or "workspace image".
@@ -41,14 +40,20 @@ Templates often contain *parameters*. In Coder, there are two types of parameter
4140

4241
We recommend source controlling your templates.
4342

44-
### Authenticating with Cloud Providers
43+
### Authentication & Secrets
44+
45+
<blockquote class="danger">
46+
<p>
47+
Do not store secrets in templates. Assume every user has cleartext access
48+
to every template.
49+
</p>
50+
</blockquote>
4551

4652
Coder's provisioner process needs to authenticate with cloud provider APIs to provision
47-
workspaces. We strongly advise against including credentials directly in your templates. You
48-
can either pass credentials to the provisioner as parameters, or execute Coder
53+
workspaces. You can either pass credentials to the provisioner as parameters or execute Coder
4954
in an environment that is authenticated with the cloud provider.
5055

51-
We encourage the latter where supported. This approach simplifies the template, keeps cloud
56+
We encourage the latter where supported. This approach simplifies the template, keeps cloud
5257
provider credentials out of Coder's database (making it a less valuable target for attackers),
5358
and is compatible with agent-based authentication schemes (that handle credential rotation
5459
and/or ensure the credentials are not written to disk).
@@ -66,7 +71,7 @@ details.
6671

6772
The way these generally work is via the credentials being available to Coder either in some
6873
well-known location on disk (e.g. `~/.aws/credentials` for AWS on posix systems), or via
69-
environment variables. It is usually sufficient to authenticate using the CLI or SDK for the
74+
environment variables. It is usually sufficient to authenticate using the CLI or SDK for the
7075
cloud provider before running Coder for this to work, but check the Terraform provider
7176
documentation for details.
7277

0 commit comments

Comments
 (0)