-
Notifications
You must be signed in to change notification settings - Fork 894
docs: explain Template inheritance with Terraform modules #8328
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.
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
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,89 @@ | ||
# Template inheritance | ||
|
||
In instances where you want to reuse code across different Coder templates, such as common scripts or resource definitions, we suggest using [Terraform Modules](https://developer.hashicorp.com/terraform/language/modules). | ||
|
||
These modules can be stored externally from Coder, like in a Git repository or a Terraform registry. Below is an example of how to reference a module in your template: | ||
|
||
```hcl | ||
data "coder_workspace" "me" {} | ||
|
||
module "coder-base" { | ||
source = "github.com/my-organization/coder-base" | ||
|
||
# Modules take in variables and can provision infrastructure | ||
vpc_name = "devex-3" | ||
subnet_tags = { "name": data.coder_workspace.me.name } | ||
code_server_version = 4.14.1 | ||
} | ||
|
||
resource "coder_agent" "dev" { | ||
# Modules can provide outputs, such as helper scripts | ||
startup_script=<<EOF | ||
#!/bin/sh | ||
${module.coder-base.code_server_install_command} | ||
EOF | ||
} | ||
``` | ||
|
||
> Learn more about [creating modules](https://developer.hashicorp.com/terraform/language/modules) and [module sources](https://developer.hashicorp.com/terraform/language/modules/sources) in the Terraform documentation. | ||
|
||
## Git authentication | ||
|
||
If you are importing a module from a private git repository, the Coder server [or provisioner](../admin/provisioners.md) needs git credentials. Since this token will only be used for cloning your repositories with modules, it is best to create a token with limited access to repositories and no extra permissions. In GitHub, you can generate a [fine-grained token](https://docs.github.com/en/rest/overview/permissions-required-for-fine-grained-personal-access-tokens?apiVersion=2022-11-28) with read only access to repos. | ||
|
||
If you are running Coder on a VM, make sure you have `git` installed and the `coder` user has access to the following files | ||
|
||
```sh | ||
# /home/coder/.gitconfig | ||
[credential] | ||
helper = store | ||
``` | ||
|
||
```sh | ||
# /home/coder/.gitconfig | ||
|
||
# GitHub example: | ||
https://your-github-username:[email protected] | ||
``` | ||
|
||
If you are running Coder on Docker or Kubernetes, `git` is pre-installed in the Coder image. However, you still need to mount credentials. This can be done via a Docker volume mount or Kubernetes secrets. | ||
|
||
### Passing git credentials in Kubernetes | ||
|
||
First, create a `.gitconfig` and `.git-credentials` file on your local machine. You may want to do this in a temporary directory to avoid conflicting with your own git credentials. | ||
|
||
Next, create the secret in Kubernetes. Be sure to do this in the same namespace that Coder is installed in. | ||
|
||
```sh | ||
export NAMESPACE=coder | ||
kubectl apply -f - <<EOF | ||
apiVersion: v1 | ||
kind: Secret | ||
metadata: | ||
name: git-secrets | ||
namespace: $NAMESPACE | ||
type: Opaque | ||
data: | ||
.gitconfig: $(cat .gitconfig | base64 | tr -d '\n') | ||
.git-credentials: $(cat .git-credentials | base64 | tr -d '\n') | ||
EOF | ||
``` | ||
|
||
Then, modify Coder's Helm values to mount the secret. | ||
|
||
```yaml | ||
coder: | ||
volumes: | ||
- name: git-secrets | ||
secret: | ||
secretName: git-secrets | ||
volumeMounts: | ||
- name: git-secrets | ||
mountPath: "/home/coder/.gitconfig" | ||
subPath: .gitconfig | ||
readOnly: true | ||
- name: git-secrets | ||
mountPath: "/home/coder/.git-credentials" | ||
subPath: .git-credentials | ||
readOnly: true | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.