- Notifications
You must be signed in to change notification settings - Fork928
docs: add template to provision docker image based workspaces on fly.io#6526
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 fromall commits
Commits
Show all changes
13 commits Select commitHold shift + click to select a range
7e9b7fb add fly.io example
matifalie151d77 fix: `fly_volume` does not allow using - in name.
matifalie6b5489 fix: provider versions and settings
matifalife925aa fix: valid `fly_app` name
matifalia35e75a chore: ipv6 is not used
matifalid44aa2d fix: names
matifalieb1caa3 chore: update max RAM
matifalid8cf437 add fly-auth-api managed variables
matifali03a28b2 Update README.md
matifali5fad6d0 Merge branch 'coder:main' into fly-docker-image-example
matifaliba99899 improve setup flow
bpmct26ce35f add metadata
bpmct834acc9 add to starter templates
bpmctFile 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
1 change: 1 addition & 0 deletionsexamples/examples.go
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
39 changes: 39 additions & 0 deletionsexamples/templates/fly-docker-image/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,39 @@ | ||
| --- | ||
| name: Develop on a Fly.io container | ||
| description: Run workspaces as Firecracker VMs on Fly.io | ||
| tags: [docker, fly.io] | ||
| icon: /icon/fly.io.svg | ||
| --- | ||
| # Coder Fly.io Template | ||
| This template provisions a [code-server](https://github.com/coder/code-server) instance on [fly.io](https://fly.io) using the [codercom/code-server](https://hub.docker.com/r/codercom/code-server) image. | ||
| ## Prerequisites | ||
| - [flyctl](https://fly.io/docs/getting-started/installing-flyctl/) installed. | ||
| - [Coder](https://coder.com/) already setup and running with coder-cli installed locally. | ||
| ## Getting started | ||
| 1. Run `coder templates init` and select this template. Follow the instructions that appear. | ||
| 2. cd into the directory that was created. (e.g. `cd fly-docker-image`) | ||
| 3. Create the new template by running the following command from the `fly-docker-image` directory: | ||
| ```bash | ||
| coder templates create fly-docker-image \ | ||
| --variable fly_api_token=$(flyctl auth token) \ | ||
| --variable fly_org=personal | ||
| ``` | ||
| > If the Coder server is also running as a fly.io app, then instead of setting variable `fly_api_token` you can also set a fly.io secret with the name `FLY_API_TOKEN` | ||
| > | ||
| > ```bash | ||
| > flyctl secrets set FLY_API_TOKEN=$(flyctl auth token) --app <your-coder-app-name> | ||
| > ``` | ||
| > Read our blog [post](coder.com/blog/deploying-coder-on-fly-io) to learn more about how to deploy Coder on fly.io. | ||
| 4. Navigate to the Coder dashboard and create a new workspace using the template. | ||
| This is all. You should now have a code-server instance running on fly.io. |
271 changes: 271 additions & 0 deletionsexamples/templates/fly-docker-image/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,271 @@ | ||
| terraform { | ||
| required_providers { | ||
| fly = { | ||
| source = "fly-apps/fly" | ||
| version = "~>0.0.21" | ||
| } | ||
| coder = { | ||
| source = "coder/coder" | ||
| version = "~>0.6.17" | ||
| } | ||
| } | ||
| } | ||
| provider "fly" { | ||
| useinternaltunnel = true | ||
| internaltunnelorg = var.fly_org | ||
| internaltunnelregion = data.coder_parameter.region.value | ||
| fly_api_token = var.fly_api_token == "" ? null : var.fly_api_token | ||
| } | ||
| provider "coder" { | ||
| feature_use_managed_variables = true | ||
| } | ||
| resource "fly_app" "workspace" { | ||
| name = "coder-${data.coder_workspace.me.owner}-${lower(data.coder_workspace.me.name)}" | ||
| org = var.fly_org | ||
| } | ||
| resource "fly_ip" "workspace-ip4" { | ||
| app = fly_app.workspace.name | ||
| type = "v4" | ||
| } | ||
| resource "fly_volume" "home-volume" { | ||
| app = fly_app.workspace.name | ||
| name = "coder_${data.coder_workspace.me.owner}_${lower(replace(data.coder_workspace.me.name, "-", "_"))}_home" | ||
| size = data.coder_parameter.volume-size.value | ||
| region = data.coder_parameter.region.value | ||
| } | ||
| resource "fly_machine" "workspace" { | ||
| count = data.coder_workspace.me.start_count | ||
| app = fly_app.workspace.name | ||
| region = data.coder_parameter.region.value | ||
| name = data.coder_workspace.me.name | ||
| image = data.coder_parameter.docker-image.value | ||
| cpus = data.coder_parameter.cpu.value | ||
| memorymb = data.coder_parameter.memory.value * 1024 | ||
| env = { | ||
| CODER_AGENT_TOKEN = "${coder_agent.main.token}" | ||
| } | ||
| entrypoint = ["sh", "-c", replace(coder_agent.main.init_script, "/localhost|127\\.0\\.0\\.1/", "${fly_ip.workspace-ip4.address}")] # replace localhost with the IP of the workspace | ||
| services = [ | ||
| { | ||
| ports = [ | ||
| { | ||
| port = 443 | ||
| handlers = ["tls", "http"] | ||
| }, | ||
| { | ||
| port = 80 | ||
| handlers = ["http"] | ||
| } | ||
| ] | ||
| protocol = "tcp", | ||
| "internal_port" = 80 | ||
| }, | ||
| { | ||
| ports = [ | ||
| { | ||
| port = 8080 | ||
| handlers = ["tls", "http"] | ||
| } | ||
| ] | ||
| protocol = "tcp", | ||
| "internal_port" = 8080 | ||
| } | ||
| ] | ||
| mounts = [ | ||
| { | ||
| volume = fly_volume.home-volume.id | ||
| path = "/home/coder" | ||
| } | ||
| ] | ||
| } | ||
| variable "fly_api_token" { | ||
| type = string | ||
| description = <<-EOF | ||
| The Fly.io API token to use for deploying the workspace. You can generate one by running: | ||
| $ flyctl auth token | ||
| EOF | ||
| sensitive = true | ||
| } | ||
| variable "fly_org" { | ||
| type = string | ||
| description = <<-EOF | ||
| The Fly.io organization slug to deploy the workspace in. List organizations by running: | ||
| $ flyctl orgs list | ||
| EOF | ||
| } | ||
| data "coder_parameter" "docker-image" { | ||
| name = "Docker Image" | ||
| description = "The docker image to use for the workspace" | ||
| default = "codercom/code-server:latest" | ||
| icon = "https://raw.githubusercontent.com/matifali/logos/main/docker.svg" | ||
| } | ||
| data "coder_parameter" "cpu" { | ||
| name = "CPU" | ||
| description = "The number of CPUs to allocate to the workspace (1-8)" | ||
| type = "number" | ||
| default = "1" | ||
| icon = "https://raw.githubusercontent.com/matifali/logos/main/cpu-3.svg" | ||
| mutable = true | ||
| validation { | ||
| min = 1 | ||
| max = 8 | ||
| } | ||
| } | ||
| data "coder_parameter" "memory" { | ||
| name = "Memory (GB)" | ||
| description = "The amount of memory to allocate to the workspace in GB (1-16)" | ||
| type = "number" | ||
| default = "1" | ||
| icon = "/icon/memory.svg" | ||
| mutable = true | ||
| validation { | ||
| min = 1 | ||
| max = 16 | ||
| } | ||
| } | ||
| data "coder_parameter" "volume-size" { | ||
| name = "Volume Size" | ||
| description = "The size of the volume to create for the workspace in GB (1-20)" | ||
| type = "number" | ||
| default = "3" | ||
| icon = "https://raw.githubusercontent.com/matifali/logos/main/database.svg" | ||
| validation { | ||
| min = 1 | ||
| max = 20 | ||
| } | ||
| } | ||
| # You can see all available regions here: https://fly.io/docs/reference/regions/ | ||
| data "coder_parameter" "region" { | ||
| name = "Region" | ||
| description = "The region to deploy the workspace in" | ||
| default = "ams" | ||
| icon = "/emojis/1f30e.png" | ||
| option { | ||
| name = "Amsterdam, Netherlands" | ||
| value = "ams" | ||
| icon = "/emojis/1f1f3-1f1f1.png" | ||
| } | ||
| option { | ||
| name = "Frankfurt, Germany" | ||
| value = "fra" | ||
| icon = "/emojis/1f1e9-1f1ea.png" | ||
| } | ||
| option { | ||
| name = "Paris, France" | ||
| value = "cdg" | ||
| icon = "/emojis/1f1eb-1f1f7.png" | ||
| } | ||
| option { | ||
| name = "Denver, Colorado (US)" | ||
| value = "den" | ||
| icon = "/emojis/1f1fa-1f1f8.png" | ||
| } | ||
| option { | ||
| name = "Dallas, Texas (US)" | ||
| value = "dal" | ||
| icon = "/emojis/1f1fa-1f1f8.png" | ||
| } | ||
| option { | ||
| name = "Hong Kong" | ||
| value = "hkg" | ||
| icon = "/emojis/1f1ed-1f1f0.png" | ||
| } | ||
| option { | ||
| name = "Los Angeles, California (US)" | ||
| value = "lax" | ||
| icon = "/emojis/1f1fa-1f1f8.png" | ||
| } | ||
| option { | ||
| name = "London, United Kingdom" | ||
| value = "lhr" | ||
| icon = "/emojis/1f1ec-1f1e7.png" | ||
| } | ||
| option { | ||
| name = "Chennai, India" | ||
| value = "maa" | ||
| icon = "/emojis/1f1ee-1f1f3.png" | ||
| } | ||
| option { | ||
| name = "Tokyo, Japan" | ||
| value = "nrt" | ||
| icon = "/emojis/1f1ef-1f1f5.png" | ||
| } | ||
| option { | ||
| name = "Chicago, Illinois (US)" | ||
| value = "ord" | ||
| icon = "/emojis/1f1fa-1f1f8.png" | ||
| } | ||
| option { | ||
| name = "Seattle, Washington (US)" | ||
| value = "sea" | ||
| icon = "/emojis/1f1fa-1f1f8.png" | ||
| } | ||
| option { | ||
| name = "Singapore" | ||
| value = "sin" | ||
| icon = "/emojis/1f1f8-1f1ec.png" | ||
| } | ||
| option { | ||
| name = "Sydney, Australia" | ||
| value = "syd" | ||
| icon = "/emojis/1f1e6-1f1fa.png" | ||
| } | ||
| option { | ||
| name = "Toronto, Canada" | ||
| value = "yyz" | ||
| icon = "/emojis/1f1e8-1f1e6.png" | ||
| } | ||
| } | ||
| resource "coder_app" "code-server" { | ||
| count = 1 | ||
| agent_id = coder_agent.main.id | ||
| display_name = "Code Server" | ||
| slug = "code-server" | ||
| url = "http://localhost:8080?folder=/home/coder/" | ||
| icon = "/icon/code.svg" | ||
| subdomain = false | ||
| share = "owner" | ||
| healthcheck { | ||
| url = "http://localhost:8080/healthz" | ||
| interval = 3 | ||
| threshold = 10 | ||
| } | ||
| } | ||
| resource "coder_agent" "main" { | ||
| arch = data.coder_provisioner.me.arch | ||
| os = "linux" | ||
| login_before_ready = false | ||
| startup_script_timeout = 180 | ||
| startup_script = <<-EOT | ||
| set -e | ||
| # Start code-server | ||
| code-server --auth none >/tmp/code-server.log 2>&1 & | ||
| # Set the hostname to the workspace name | ||
| sudo hostname -b "${data.coder_workspace.me.name}-fly" | ||
| EOT | ||
| } | ||
| data "coder_provisioner" "me" { | ||
| } | ||
| data "coder_workspace" "me" { | ||
| } |
1 change: 1 addition & 0 deletionssite/static/icon/fly.io.svg
Loading
Sorry, something went wrong.Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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.