Thanks to visit codestin.com
Credit goes to github.com

Skip to content

feat: Add workspace agent lifecycle state reporting #5785

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.

Sign up for GitHub

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
mafredri merged 24 commits into from
Jan 24, 2023
Merged

feat: Add workspace agent lifecycle state reporting #5785

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
40e9c87
feat: Add new migrations
mafredri Jan 19, 2023
5abf555
Generate database changes
mafredri Jan 19, 2023
a84e467
feat: Add agent state reporting
mafredri Jan 19, 2023
8119e71
Generate docs
mafredri Jan 19, 2023
515e342
WIP
mafredri Jan 19, 2023
1e53635
Rename state -> lifecycle state
mafredri Jan 19, 2023
534f954
Add tests, improve lifecycle reporting
mafredri Jan 23, 2023
90192e5
Fix lint
mafredri Jan 23, 2023
aaf19bc
test: Update terraform tests for provider v0.6.7
mafredri Jan 23, 2023
bd1a87f
test(site): Update agent mocks
mafredri Jan 23, 2023
df9944e
Add new columns to workspace agent table
mafredri Jan 23, 2023
60f414f
Fix plumbing
mafredri Jan 23, 2023
087070e
Run OverrideVSCodeConfigs even on error
mafredri Jan 23, 2023
c6928e9
Use consistent Seconds terminology
mafredri Jan 23, 2023
c132d4e
Fix s/continue/break/
mafredri Jan 23, 2023
903e850
Fix git auth override order
mafredri Jan 23, 2023
034a850
Fix nit
mafredri Jan 23, 2023
f76247f
Publish workspace update
mafredri Jan 23, 2023
2ccdcac
Hide report lifecycle endpoint from apidocs
mafredri Jan 24, 2023
830f9f1
Set all existing agents to ready
mafredri Jan 24, 2023
2b1569f
Add debug logging to lifecycle states
mafredri Jan 24, 2023
71706e0
Add note about error during vscode git auth override
mafredri Jan 24, 2023
21a9d28
Fix typo in tests
mafredri Jan 24, 2023
da67c73
Merge branch 'main' into mafredri/feat-add-workspace-agent-ready-status
mafredri Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Generate docs
  • Loading branch information
@mafredri
mafredri committed Jan 23, 2023
commit 8119e71c37e9a73f9f1e2ba1d93284391032945f
72 changes: 72 additions & 0 deletions coderd/apidoc/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

58 changes: 58 additions & 0 deletions coderd/apidoc/swagger.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion codersdk/workspaceagents.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ type WorkspaceAgentMetadata struct {
DERPMap *tailcfg.DERPMap `json:"derpmap"`
EnvironmentVariables map[string]string `json:"environment_variables"`
StartupScript string `json:"startup_script"`
StartupScriptTimeout time.Duration `json:"startup_script_timeout" format:"duration"`
StartupScriptTimeout time.Duration `json:"startup_script_timeout"`
Directory string `json:"directory"`
MOTDFile string `json:"motd_file"`
}
Expand Down
37 changes: 37 additions & 0 deletions docs/api/agents.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \
"git_auth_configs": 0,
"motd_file": "string",
"startup_script": "string",
"startup_script_timeout": 0,
"vscode_port_proxy_uri": "string"
}
```
Expand All @@ -382,6 +383,41 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/me/metadata \

To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Submit workspace agent state

### Code samples

```shell
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/workspaceagents/me/report-state \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
```

`POST /workspaceagents/me/report-state`

> Body parameter

```json
{
"state": "starting"
}
```

### Parameters

| Name | In | Type | Required | Description |
| ------ | ---- | -------------------------------------------------------------------------------------------- | -------- | ----------------------------- |
| `body` | body | [codersdk.PostWorkspaceAgentStateRequest](schemas.md#codersdkpostworkspaceagentstaterequest) | true | Workspace agent state request |

### Responses

| Status | Meaning | Description | Schema |
| ------ | --------------------------------------------------------------- | ----------- | ------ |
| 204 | [No Content](https://tools.ietf.org/html/rfc7231#section-6.3.5) | Success | |

To perform this operation, you must be authenticated. [Learn more](authentication.md).

## Submit workspace agent stats

### Code samples
Expand Down Expand Up @@ -507,6 +543,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaceagents/{workspaceagent} \
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down
16 changes: 16 additions & 0 deletions docs/api/builds.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,7 @@ curl -X GET http://coder-server:8080/api/v2/users/{user}/workspace/{workspacenam
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down Expand Up @@ -242,6 +243,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild} \
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down Expand Up @@ -527,6 +529,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/res
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down Expand Up @@ -601,6 +604,7 @@ Status Code **200**
| `»» operating_system` | string | false | | |
| `»» resource_id` | string(uuid) | false | | |
| `»» startup_script` | string | false | | |
| `»» state` | [codersdk.WorkspaceAgentState](schemas.md#codersdkworkspaceagentstate) | false | | |
| `»» status` | [codersdk.WorkspaceAgentStatus](schemas.md#codersdkworkspaceagentstatus) | false | | |
| `»» troubleshooting_url` | string | false | | |
| `»» updated_at` | string(date-time) | false | | |
Expand Down Expand Up @@ -630,6 +634,10 @@ Status Code **200**
| `sharing_level` | `owner` |
| `sharing_level` | `authenticated` |
| `sharing_level` | `public` |
| `state` | `starting` |
| `state` | `start_timeout` |
| `state` | `start_error` |
| `state` | `ready` |
| `status` | `connecting` |
| `status` | `connected` |
| `status` | `disconnected` |
Expand Down Expand Up @@ -738,6 +746,7 @@ curl -X GET http://coder-server:8080/api/v2/workspacebuilds/{workspacebuild}/sta
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down Expand Up @@ -885,6 +894,7 @@ curl -X GET http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down Expand Up @@ -991,6 +1001,7 @@ Status Code **200**
| `»»» operating_system` | string | false | | |
| `»»» resource_id` | string(uuid) | false | | |
| `»»» startup_script` | string | false | | |
| `»»» state` | [codersdk.WorkspaceAgentState](schemas.md#codersdkworkspaceagentstate) | false | | |
| `»»» status` | [codersdk.WorkspaceAgentStatus](schemas.md#codersdkworkspaceagentstatus) | false | | |
| `»»» troubleshooting_url` | string | false | | |
| `»»» updated_at` | string(date-time) | false | | |
Expand Down Expand Up @@ -1038,6 +1049,10 @@ Status Code **200**
| `sharing_level` | `owner` |
| `sharing_level` | `authenticated` |
| `sharing_level` | `public` |
| `state` | `starting` |
| `state` | `start_timeout` |
| `state` | `start_error` |
| `state` | `ready` |
| `status` | `connecting` |
| `status` | `connected` |
| `status` | `disconnected` |
Expand Down Expand Up @@ -1188,6 +1203,7 @@ curl -X POST http://coder-server:8080/api/v2/workspaces/{workspace}/builds \
"operating_system": "string",
"resource_id": "4d5215ed-38bb-48ed-879a-fdb9ca58522f",
"startup_script": "string",
"state": "starting",
"status": "connecting",
"troubleshooting_url": "string",
"updated_at": "2019-08-24T14:15:22Z",
Expand Down
Loading