-
Notifications
You must be signed in to change notification settings - Fork 22
feat: Add app support #17
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
Changes from all commits
Commits
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "coder_app Resource - terraform-provider-coder" | ||
subcategory: "" | ||
description: |- | ||
Use this resource to define shortcuts to access applications in a workspace. | ||
--- | ||
|
||
# coder_app (Resource) | ||
|
||
Use this resource to define shortcuts to access applications in a workspace. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "coder_workspace" "me" {} | ||
|
||
resource "coder_agent" "dev" { | ||
os = "linux" | ||
arch = "amd64" | ||
dir = "/workspace" | ||
startup_script = <<EOF | ||
curl -fsSL https://code-server.dev/install.sh | sh | ||
code-server --auth none --port 13337 | ||
EOF | ||
} | ||
|
||
resource "coder_app" "code-server" { | ||
agent_id = coder_agent.dev.id | ||
name = "VS Code" | ||
icon = data.coder_workspace.me.access_url + "/icons/vscode.svg" | ||
target = "http://localhost:13337" | ||
} | ||
|
||
resource "coder_app" "vim" { | ||
agent_id = coder_agent.dev.id | ||
name = "Vim" | ||
icon = data.coder_workspace.me.access_url + "/icons/vim.svg" | ||
command = "vim" | ||
} | ||
|
||
resource "coder_app" "intellij" { | ||
agent_id = coder_agent.dev.id | ||
icon = data.coder_workspace.me.access_url + "/icons/intellij.svg" | ||
name = "JetBrains IntelliJ" | ||
command = "projector run" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `agent_id` (String) The "id" property of a "coder_agent" resource to associate with. | ||
|
||
### Optional | ||
|
||
- `command` (String) A command to run in a terminal opening this app. In the web, this will open in a new tab. In the CLI, this will SSH and execute the command. | ||
- `icon` (String) A URL to an icon that will display in the dashboard. View built-in icons here: https://github.com/coder/coder/tree/main/site/static/icons. Use a built-in icon with `data.coder_workspace.me.access_url + "/icons/<path>"`. | ||
- `id` (String) The ID of this resource. | ||
- `name` (String) A display name to identify the app. | ||
- `target` (String) A URL to be proxied to from inside the workspace. | ||
|
||
|
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,32 @@ | ||
data "coder_workspace" "me" {} | ||
|
||
resource "coder_agent" "dev" { | ||
os = "linux" | ||
arch = "amd64" | ||
dir = "/workspace" | ||
startup_script = <<EOF | ||
curl -fsSL https://code-server.dev/install.sh | sh | ||
code-server --auth none --port 13337 | ||
EOF | ||
} | ||
|
||
resource "coder_app" "code-server" { | ||
agent_id = coder_agent.dev.id | ||
name = "VS Code" | ||
icon = data.coder_workspace.me.access_url + "/icons/vscode.svg" | ||
target = "http://localhost:13337" | ||
} | ||
|
||
resource "coder_app" "vim" { | ||
agent_id = coder_agent.dev.id | ||
name = "Vim" | ||
icon = data.coder_workspace.me.access_url + "/icons/vim.svg" | ||
command = "vim" | ||
} | ||
|
||
resource "coder_app" "intellij" { | ||
agent_id = coder_agent.dev.id | ||
icon = data.coder_workspace.me.access_url + "/icons/intellij.svg" | ||
name = "JetBrains IntelliJ" | ||
command = "projector run" | ||
} |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We don't seem to document the
ConflictsWith
requirements at all.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
True. I shall fix!