- Notifications
You must be signed in to change notification settings - Fork928
feat: Add examples/templates/do-linux for Digital Ocean Droplets#1749
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes from8 commits
Commits
Show all changes
13 commits Select commitHold shift + click to select a range
8d73582 feat: Add examples/do-droplet-linux for Digital Ocean Droplets
mafredri0b2c8d4 feat: Add support for coder user username
mafredri2e98e1d chore: Rename do-droplet-linux => do-linux
mafredrif595f16 Merge branch 'main' into mafredri/example-digital-ocean-droplet
mafredrib599799 feat: Add regions, images, sizes and variable for home volume size
mafredri08483d8 feat: Set default values to skip in admin, docs, Fedora fix
mafredria075df3 chore: Improve SSH key message
mafredri0e8e338 chore: Remove unneeded concat
mafredri4fd4f7a Update examples/do-linux/main.tf
mafredri9bddba8 chore: Update readme
mafredribc96c59 chore: Add note about bug
mafredri9489f87 chore: Move example to examples/tempaltes/
mafredrie0bef81 Update README.md
mafredriFile filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
15 changes: 15 additions & 0 deletionsexamples/do-linux/README.md
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,15 @@ | ||
| --- | ||
| name: Develop in Linux on a Digital Ocean Droplet | ||
| description: Get started with Linux development on a Digital Ocean Droplet. | ||
| tags: [cloud, digitalocean] | ||
| --- | ||
| # do-droplet-linux | ||
| This is an example for deploying workspaces on Digital Ocean Droplets. | ||
| ## Requirements | ||
| - Digital Ocean Personal Access Token (PAT) | ||
| - Digital Ocean Project ID (e.g. `doctl projects list`) | ||
| - Remove `variable "step2_do_project_id"` and `resource "digitalocean_project_resources" "project"` if you don't want project association. |
46 changes: 46 additions & 0 deletionsexamples/do-linux/cloud-config.yaml.tftpl
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,46 @@ | ||
| #cloud-config | ||
| users: | ||
| - name: ${username} | ||
| sudo: ["ALL=(ALL) NOPASSWD:ALL"] | ||
| groups: sudo | ||
| shell: /bin/bash | ||
| packages: | ||
| - git | ||
| mounts: | ||
| - [ | ||
| "LABEL=${home_volume_label}", | ||
| "/home/${username}", | ||
| auto, | ||
| "defaults,uid=1000,gid=1000", | ||
| ] | ||
| write_files: | ||
| - path: /opt/coder/init | ||
| permissions: "0755" | ||
| encoding: b64 | ||
| content: ${init_script} | ||
| - path: /etc/systemd/system/coder-agent.service | ||
| permissions: "0644" | ||
| content: | | ||
| [Unit] | ||
| Description=Coder Agent | ||
| After=network-online.target | ||
| Wants=network-online.target | ||
| [Service] | ||
| User=${username} | ||
| ExecStart=/opt/coder/init | ||
| Environment=CODER_AGENT_TOKEN=${coder_agent_token} | ||
| Restart=always | ||
| RestartSec=10 | ||
| TimeoutStopSec=90 | ||
| KillMode=process | ||
| OOMScoreAdjust=-900 | ||
| SyslogIdentifier=coder-agent | ||
| [Install] | ||
| WantedBy=multi-user.target | ||
| runcmd: | ||
| - chown ${username}:${username} /home/${username} | ||
| - systemctl enable coder-agent | ||
| - systemctl start coder-agent |
145 changes: 145 additions & 0 deletionsexamples/do-linux/main.tf
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,145 @@ | ||
| terraform { | ||
| required_providers { | ||
| coder = { | ||
| source = "coder/coder" | ||
| version = "0.4.1" | ||
| } | ||
| digitalocean = { | ||
| source = "digitalocean/digitalocean" | ||
| version = "~> 2.0" | ||
| } | ||
| } | ||
| } | ||
| variable "step1_do_token" { | ||
| type = string | ||
| description = "Enter token (see documentation at https://docs.digitalocean.com/reference/api/create-personal-access-token/)" | ||
| sensitive = true | ||
| validation { | ||
| condition = length(var.step1_do_token) == 71 && substr(var.step1_do_token, 0, 4) == "dop_" | ||
| error_message = "Invalid Digital Ocean Personal Access Token." | ||
| } | ||
| } | ||
| variable "step2_do_project_id" { | ||
| type = string | ||
| description = <<-EOF | ||
| Enter project ID | ||
| $ doctl projects list | ||
| EOF | ||
| sensitive = true | ||
| validation { | ||
| condition = length(var.step2_do_project_id) == 36 | ||
| error_message = "Invalid Digital Ocean Project ID." | ||
| } | ||
| } | ||
| variable "step3_do_admin_ssh_key" { | ||
| type = number | ||
| description = <<-EOF | ||
| Enter admin SSH key ID (some Droplet images require an SSH key to be set): | ||
| Can be set to zero. | ||
| Note: Setting this to zero will break Fedora images and notify root passwords via email. | ||
| $ doctl compute ssh-key list | ||
| EOF | ||
| sensitive = true | ||
| validation { | ||
| condition = var.step3_do_admin_ssh_key >= 0 | ||
| error_message = "Invalid Digital Ocean SSH key ID, a number is required." | ||
| } | ||
| } | ||
| variable "droplet_image" { | ||
| type = string | ||
| description = "Which Droplet image would you like to use for your workspace?" | ||
| default = "ubuntu-22-04-x64" | ||
| validation { | ||
| condition = contains(["ubuntu-22-04-x64", "ubuntu-20-04-x64", "fedora-36-x64", "fedora-35-x64", "debian-11-x64", "debian-10-x64", "centos-stream-9-x64", "centos-stream-8-x64", "rockylinux-8-x64", "rockylinux-8-4-x64"], var.droplet_image) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. I wanted to conditionally include Fedora images based on if SSH key is set, but it's not possible, unfortunately :/hashicorp/terraform#25609 | ||
| error_message = "Value must be ubuntu-22-04-x64, ubuntu-20-04-x64, fedora-36-x64, fedora-35-x64, debian-11-x64, debian-10-x64, centos-stream-9-x64, centos-stream-8-x64, rockylinux-8-x64 or rockylinux-8-4-x64." | ||
| } | ||
| } | ||
| variable "droplet_size" { | ||
| type = string | ||
| description = "Which Droplet configuration would you like to use?" | ||
| default = "s-1vcpu-1gb" | ||
| validation { | ||
| condition = contains(["s-1vcpu-1gb", "s-1vcpu-2gb", "s-2vcpu-2gb", "s-2vcpu-4gb", "s-4vcpu-8gb", "s-8vcpu-16gb"], var.droplet_size) | ||
| error_message = "Value must be s-1vcpu-1gb, s-1vcpu-2gb, s-2vcpu-2gb, s-2vcpu-4gb, s-4vcpu-8gb or s-8vcpu-16gb." | ||
| } | ||
| } | ||
| variable "home_volume_size" { | ||
| type = number | ||
| description = "How large would you like your home volume to be (in GB)?" | ||
| default = 20 | ||
| validation { | ||
| condition = var.home_volume_size >= 1 | ||
| error_message = "Value must be greather than or equal to 1." | ||
mafredri marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
| } | ||
| } | ||
| variable "region" { | ||
| type = string | ||
| description = "Which region would you like to use?" | ||
| default = "ams3" | ||
| validation { | ||
| condition = contains(["nyc1", "nyc2", "nyc3", "sfo1", "sfo2", "sfo3", "ams2", "ams3", "sgp1", "lon1", "fra1", "tor1", "blr1"], var.region) | ||
| error_message = "Value must be nyc1, nyc2, nyc3, sfo1, sfo2, sfo3, ams2, ams3, sgp1, lon1, fra1, tor1 or blr1." | ||
| } | ||
| } | ||
| # Configure the DigitalOcean Provider | ||
| provider "digitalocean" { | ||
| token = var.step1_do_token | ||
| } | ||
| data "coder_workspace" "me" {} | ||
| resource "coder_agent" "dev" { | ||
| os = "linux" | ||
| arch = "amd64" | ||
| } | ||
| resource "digitalocean_volume" "home_volume" { | ||
| region = var.region | ||
| name = "coder-${data.coder_workspace.me.owner}-${data.coder_workspace.me.name}-home" | ||
| size = var.home_volume_size | ||
| initial_filesystem_type = "ext4" | ||
| initial_filesystem_label = "coder-home" | ||
| } | ||
| resource "digitalocean_droplet" "workspace" { | ||
| region = var.region | ||
| count = data.coder_workspace.me.start_count | ||
| name = "coder-${data.coder_workspace.me.owner}-${data.coder_workspace.me.name}" | ||
| image = var.droplet_image | ||
| size = var.droplet_size | ||
| volume_ids = [digitalocean_volume.home_volume.id] | ||
| user_data = templatefile("cloud-config.yaml.tftpl", { | ||
| username = data.coder_workspace.me.owner | ||
| home_volume_label = digitalocean_volume.home_volume.initial_filesystem_label | ||
| init_script = base64encode(coder_agent.dev.init_script) | ||
| coder_agent_token = coder_agent.dev.token | ||
| }) | ||
| # Required to provision Fedora. | ||
| ssh_keys = var.step3_do_admin_ssh_key > 0 ? [var.step3_do_admin_ssh_key] : [] | ||
| } | ||
| # resource "digitalocean_project_resources" "project" { | ||
| # project = var.step2_do_project_id | ||
| # # Workaround for terraform plan when using count. | ||
| # resources = length(digitalocean_droplet.workspace) > 0 ? [ | ||
| # digitalocean_volume.home_volume.urn, | ||
| # digitalocean_droplet.workspace[0].urn | ||
| # ] : [ | ||
| # digitalocean_volume.home_volume.urn | ||
| # ] | ||
| # } | ||
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.