mirror of
https://github.com/coder/registry.git
synced 2026-06-02 20:48:14 +00:00
Michael Smith
376664ca04
Addresses part of https://github.com/coder/internal/issues/532 (but doesn't fully close it out). This is a huge PR, but chunking it up seemed pointless, since we're largely copying over existing files. I'm going to try commenting on the main areas I think are worth paying attention to ## Changes made - Migrated over all Coder modules from coder/modules, and put them in their correct user namespaces. - Added README.md files to all newly-created user namespaces - Updated all image paths for every image used, to make sure they don't break (I switched the paths programmatically, and then manually verified every README to guarantee this). - Added README.md files for each contributor who previously made a module - Updated our `tsconfig.json` file to use modern libraries when run from the server, and made a custom `tsconfig.json` just for the `windows-rdp` module (which has more restrictive browser concerns) - Added CI step to run all the module tests we currently have ## Notes - There were a lot of Bash script files that weren't carried over in this PR, partly because I don't know Bash well enough to know (1) whether they're still needed, or (2) modify them to account for the new file structure. Those can be brought over later. - We had a `lint.ts` file that provided some light validation of some of the modules. After going through it, there were so many bugs and issues with the code that I legitimately think that it barely provided a safety net at all. I got rid of it entirely, with the intention of adding the functionality that was originally intended to the current validation logic (to be handled in a separate PR). - I changed how we set up the `.images` directory, because it felt like it would be chaos if a bunch of users try to throw all their images in one giant directory, with no guidelines on how to do it. I instead made it so that images should be scoped by namespace, which felt a lot more manageable. The `.icons` directory is still at the top level, because realistically, there are only going to be so many types of icons referenced, so it's fine for those to be shared. - I don't think the `maintainer_github` and `contributor_github` fields make sense anymore, but those can be stripped out once we've updated the Registry site build step to use the new Registry repo - My gut instinct is to use the user namespace to determine the main owner of the module, and then add a `contributors` string list to indicate which other users have contributed meaningfully to it. We can then add validation to make sure that every value in that list exists as another namespace in the repo ## What still needs to be migrated (in separate PRs) These are the main files of interest that still probably need to be copied over from the `/modules` repo: - `new.sh` - `terraform_validate.sh` - `update-version.sh` They're probably going to require enough changes that it's worth handling them in a separate PR.
109 lines
2.5 KiB
Terraform
109 lines
2.5 KiB
Terraform
terraform {
|
|
required_version = ">= 1.0"
|
|
|
|
required_providers {
|
|
coder = {
|
|
source = "coder/coder"
|
|
version = ">= 0.17"
|
|
}
|
|
}
|
|
}
|
|
|
|
locals {
|
|
# A built-in icon like "/icon/code.svg" or a full URL of icon
|
|
icon_url = "https://raw.githubusercontent.com/coder/coder/main/site/static/icon/code.svg"
|
|
# a map of all possible values
|
|
options = {
|
|
"Option 1" = {
|
|
"name" = "Option 1",
|
|
"value" = "1"
|
|
"icon" = "/emojis/1.png"
|
|
}
|
|
"Option 2" = {
|
|
"name" = "Option 2",
|
|
"value" = "2"
|
|
"icon" = "/emojis/2.png"
|
|
}
|
|
}
|
|
}
|
|
|
|
# Add required variables for your modules and remove any unneeded variables
|
|
variable "agent_id" {
|
|
type = string
|
|
description = "The ID of a Coder agent."
|
|
}
|
|
|
|
variable "log_path" {
|
|
type = string
|
|
description = "The path to log MODULE_NAME to."
|
|
default = "/tmp/MODULE_NAME.log"
|
|
}
|
|
|
|
variable "port" {
|
|
type = number
|
|
description = "The port to run MODULE_NAME on."
|
|
default = 19999
|
|
}
|
|
|
|
variable "mutable" {
|
|
type = bool
|
|
description = "Whether the parameter is mutable."
|
|
default = true
|
|
}
|
|
|
|
variable "order" {
|
|
type = number
|
|
description = "The order determines the position of app in the UI presentation. The lowest order is shown first and apps with equal order are sorted by name (ascending order)."
|
|
default = null
|
|
}
|
|
# Add other variables here
|
|
|
|
|
|
resource "coder_script" "MODULE_NAME" {
|
|
agent_id = var.agent_id
|
|
display_name = "MODULE_NAME"
|
|
icon = local.icon_url
|
|
script = templatefile("${path.module}/run.sh", {
|
|
LOG_PATH : var.log_path,
|
|
})
|
|
run_on_start = true
|
|
run_on_stop = false
|
|
}
|
|
|
|
resource "coder_app" "MODULE_NAME" {
|
|
agent_id = var.agent_id
|
|
slug = "MODULE_NAME"
|
|
display_name = "MODULE_NAME"
|
|
url = "http://localhost:${var.port}"
|
|
icon = local.icon_url
|
|
subdomain = false
|
|
share = "owner"
|
|
order = var.order
|
|
|
|
# Remove if the app does not have a healthcheck endpoint
|
|
healthcheck {
|
|
url = "http://localhost:${var.port}/healthz"
|
|
interval = 5
|
|
threshold = 6
|
|
}
|
|
}
|
|
|
|
data "coder_parameter" "MODULE_NAME" {
|
|
type = "list(string)"
|
|
name = "MODULE_NAME"
|
|
display_name = "MODULE_NAME"
|
|
icon = local.icon_url
|
|
mutable = var.mutable
|
|
default = local.options["Option 1"]["value"]
|
|
|
|
dynamic "option" {
|
|
for_each = local.options
|
|
content {
|
|
icon = option.value.icon
|
|
name = option.value.name
|
|
value = option.value.value
|
|
}
|
|
}
|
|
}
|
|
|