mirror of
https://github.com/coder/coder.git
synced 2026-09-24 15:04:27 +08:00
feat: support devcontainer agents in ui and unify backend (#18332)
This commit consolidates two container endpoints on the backend and improves the frontend devcontainer support by showing names and displaying apps as appropriate. With this change, the frontend now has knowledge of the subagent and we can also display things like port forwards. The frontend was updated to show dev container labels on the border as well as subagent connection status. The recreation flow was also adjusted a bit to show placeholder app icons when relevant. Support for apps was also added, although these are still WIP on the backend. And the port forwarding utility was added in since the sub agents now provide the necessary info. Fixes coder/internal#666
This commit is contained in:
Mathias Fredriksson
Generated
+39
-2
@@ -777,8 +777,6 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con
|
||||
"containers": [
|
||||
{
|
||||
"created_at": "2019-08-24T14:15:22Z",
|
||||
"devcontainer_dirty": true,
|
||||
"devcontainer_status": "running",
|
||||
"id": "string",
|
||||
"image": "string",
|
||||
"labels": {
|
||||
@@ -802,6 +800,45 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent}/con
|
||||
}
|
||||
}
|
||||
],
|
||||
"devcontainers": [
|
||||
{
|
||||
"agent": {
|
||||
"directory": "string",
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string"
|
||||
},
|
||||
"config_path": "string",
|
||||
"container": {
|
||||
"created_at": "2019-08-24T14:15:22Z",
|
||||
"id": "string",
|
||||
"image": "string",
|
||||
"labels": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"name": "string",
|
||||
"ports": [
|
||||
{
|
||||
"host_ip": "string",
|
||||
"host_port": 0,
|
||||
"network": "string",
|
||||
"port": 0
|
||||
}
|
||||
],
|
||||
"running": true,
|
||||
"status": "string",
|
||||
"volumes": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
}
|
||||
},
|
||||
"dirty": true,
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string",
|
||||
"status": "running",
|
||||
"workspace_folder": "string"
|
||||
}
|
||||
],
|
||||
"warnings": [
|
||||
"string"
|
||||
]
|
||||
|
||||
Generated
+130
-23
@@ -9012,8 +9012,6 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
```json
|
||||
{
|
||||
"created_at": "2019-08-24T14:15:22Z",
|
||||
"devcontainer_dirty": true,
|
||||
"devcontainer_status": "running",
|
||||
"id": "string",
|
||||
"image": "string",
|
||||
"labels": {
|
||||
@@ -9040,21 +9038,19 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
|-----------------------|----------------------------------------------------------------------------------------|----------|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `created_at` | string | false | | Created at is the time the container was created. |
|
||||
| `devcontainer_dirty` | boolean | false | | Devcontainer dirty is true if the devcontainer configuration has changed since the container was created. This is used to determine if the container needs to be rebuilt. |
|
||||
| `devcontainer_status` | [codersdk.WorkspaceAgentDevcontainerStatus](#codersdkworkspaceagentdevcontainerstatus) | false | | Devcontainer status is the status of the devcontainer, if this container is a devcontainer. This is used to determine if the devcontainer is running, stopped, starting, or in an error state. |
|
||||
| `id` | string | false | | ID is the unique identifier of the container. |
|
||||
| `image` | string | false | | Image is the name of the container image. |
|
||||
| `labels` | object | false | | Labels is a map of key-value pairs of container labels. |
|
||||
| » `[any property]` | string | false | | |
|
||||
| `name` | string | false | | Name is the human-readable name of the container. |
|
||||
| `ports` | array of [codersdk.WorkspaceAgentContainerPort](#codersdkworkspaceagentcontainerport) | false | | Ports includes ports exposed by the container. |
|
||||
| `running` | boolean | false | | Running is true if the container is currently running. |
|
||||
| `status` | string | false | | Status is the current status of the container. This is somewhat implementation-dependent, but should generally be a human-readable string. |
|
||||
| `volumes` | object | false | | Volumes is a map of "things" mounted into the container. Again, this is somewhat implementation-dependent. |
|
||||
| » `[any property]` | string | false | | |
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
|--------------------|---------------------------------------------------------------------------------------|----------|--------------|--------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `created_at` | string | false | | Created at is the time the container was created. |
|
||||
| `id` | string | false | | ID is the unique identifier of the container. |
|
||||
| `image` | string | false | | Image is the name of the container image. |
|
||||
| `labels` | object | false | | Labels is a map of key-value pairs of container labels. |
|
||||
| » `[any property]` | string | false | | |
|
||||
| `name` | string | false | | Name is the human-readable name of the container. |
|
||||
| `ports` | array of [codersdk.WorkspaceAgentContainerPort](#codersdkworkspaceagentcontainerport) | false | | Ports includes ports exposed by the container. |
|
||||
| `running` | boolean | false | | Running is true if the container is currently running. |
|
||||
| `status` | string | false | | Status is the current status of the container. This is somewhat implementation-dependent, but should generally be a human-readable string. |
|
||||
| `volumes` | object | false | | Volumes is a map of "things" mounted into the container. Again, this is somewhat implementation-dependent. |
|
||||
| » `[any property]` | string | false | | |
|
||||
|
||||
## codersdk.WorkspaceAgentContainerPort
|
||||
|
||||
@@ -9076,6 +9072,79 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
| `network` | string | false | | Network is the network protocol used by the port (tcp, udp, etc). |
|
||||
| `port` | integer | false | | Port is the port number *inside* the container. |
|
||||
|
||||
## codersdk.WorkspaceAgentDevcontainer
|
||||
|
||||
```json
|
||||
{
|
||||
"agent": {
|
||||
"directory": "string",
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string"
|
||||
},
|
||||
"config_path": "string",
|
||||
"container": {
|
||||
"created_at": "2019-08-24T14:15:22Z",
|
||||
"id": "string",
|
||||
"image": "string",
|
||||
"labels": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"name": "string",
|
||||
"ports": [
|
||||
{
|
||||
"host_ip": "string",
|
||||
"host_port": 0,
|
||||
"network": "string",
|
||||
"port": 0
|
||||
}
|
||||
],
|
||||
"running": true,
|
||||
"status": "string",
|
||||
"volumes": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
}
|
||||
},
|
||||
"dirty": true,
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string",
|
||||
"status": "running",
|
||||
"workspace_folder": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
|--------------------|----------------------------------------------------------------------------------------|----------|--------------|----------------------------|
|
||||
| `agent` | [codersdk.WorkspaceAgentDevcontainerAgent](#codersdkworkspaceagentdevcontaineragent) | false | | |
|
||||
| `config_path` | string | false | | |
|
||||
| `container` | [codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer) | false | | |
|
||||
| `dirty` | boolean | false | | |
|
||||
| `id` | string | false | | |
|
||||
| `name` | string | false | | |
|
||||
| `status` | [codersdk.WorkspaceAgentDevcontainerStatus](#codersdkworkspaceagentdevcontainerstatus) | false | | Additional runtime fields. |
|
||||
| `workspace_folder` | string | false | | |
|
||||
|
||||
## codersdk.WorkspaceAgentDevcontainerAgent
|
||||
|
||||
```json
|
||||
{
|
||||
"directory": "string",
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string"
|
||||
}
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
|-------------|--------|----------|--------------|-------------|
|
||||
| `directory` | string | false | | |
|
||||
| `id` | string | false | | |
|
||||
| `name` | string | false | | |
|
||||
|
||||
## codersdk.WorkspaceAgentDevcontainerStatus
|
||||
|
||||
```json
|
||||
@@ -9138,8 +9207,6 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
"containers": [
|
||||
{
|
||||
"created_at": "2019-08-24T14:15:22Z",
|
||||
"devcontainer_dirty": true,
|
||||
"devcontainer_status": "running",
|
||||
"id": "string",
|
||||
"image": "string",
|
||||
"labels": {
|
||||
@@ -9163,6 +9230,45 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
}
|
||||
}
|
||||
],
|
||||
"devcontainers": [
|
||||
{
|
||||
"agent": {
|
||||
"directory": "string",
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string"
|
||||
},
|
||||
"config_path": "string",
|
||||
"container": {
|
||||
"created_at": "2019-08-24T14:15:22Z",
|
||||
"id": "string",
|
||||
"image": "string",
|
||||
"labels": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
},
|
||||
"name": "string",
|
||||
"ports": [
|
||||
{
|
||||
"host_ip": "string",
|
||||
"host_port": 0,
|
||||
"network": "string",
|
||||
"port": 0
|
||||
}
|
||||
],
|
||||
"running": true,
|
||||
"status": "string",
|
||||
"volumes": {
|
||||
"property1": "string",
|
||||
"property2": "string"
|
||||
}
|
||||
},
|
||||
"dirty": true,
|
||||
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
|
||||
"name": "string",
|
||||
"status": "running",
|
||||
"workspace_folder": "string"
|
||||
}
|
||||
],
|
||||
"warnings": [
|
||||
"string"
|
||||
]
|
||||
@@ -9171,10 +9277,11 @@ If the schedule is empty, the user will be updated to use the default schedule.|
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
|--------------|-------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `containers` | array of [codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer) | false | | Containers is a list of containers visible to the workspace agent. |
|
||||
| `warnings` | array of string | false | | Warnings is a list of warnings that may have occurred during the process of listing containers. This should not include fatal errors. |
|
||||
| Name | Type | Required | Restrictions | Description |
|
||||
|-----------------|-------------------------------------------------------------------------------------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `containers` | array of [codersdk.WorkspaceAgentContainer](#codersdkworkspaceagentcontainer) | false | | Containers is a list of containers visible to the workspace agent. |
|
||||
| `devcontainers` | array of [codersdk.WorkspaceAgentDevcontainer](#codersdkworkspaceagentdevcontainer) | false | | Devcontainers is a list of devcontainers visible to the workspace agent. |
|
||||
| `warnings` | array of string | false | | Warnings is a list of warnings that may have occurred during the process of listing containers. This should not include fatal errors. |
|
||||
|
||||
## codersdk.WorkspaceAgentListeningPort
|
||||
|
||||
|
||||
Reference in New Issue
Block a user