Skip to content

Commit 8de2e54

Browse files
authored
add: admin field/audit log mappings (coder#1146)
* add: admin field/audit log mappings * add: note on undocumented fields
1 parent 6efc276 commit 8de2e54

File tree

1 file changed

+74
-0
lines changed

1 file changed

+74
-0
lines changed

admin/audit.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,3 +58,77 @@ actions included:
5858
- `view`: the Coder CLI used a secret
5959
- `write`: the user made a change to a Coder entity (e.g., workspace, user,
6060
resource pool, etc.)
61+
62+
## Admin logged events
63+
64+
With the exception of a few, logged events made by Admin panel changes will output
65+
the changed field(s) and the new, corresponding value. Below is the expected
66+
(example) output for each Admin panel change.
67+
68+
> The Admin fields not documented below currently do not output a field/diff.
69+
70+
### Infrastructure
71+
72+
**Admin Setting** | **Action** | **Target** | **Field** | **Diff**
73+
------|------|------|------|------
74+
Access URL | Write | infrastructure | access URL | `coder.com`
75+
GPU Vendor | Write | infrastructure | gpu vendor | `amd/nvidia/none`
76+
Enable container-based virtual machines | Write | infrastructure | enable container vms| `true/false`
77+
Enable caching | Write | infrastructure | enabled cached container vms | `true/false`
78+
Enable auto loading of `shiftfs` kernel module | Write | infrastructure | enable load shiftfs | `true/false`
79+
Default to container-based virtual machines | Write | infrastructure | default container vms | `true/false`
80+
Enable self-contained workspace builds | Write | features | coder agent pull assets | `enabled/disabled`
81+
Enable workspace process logging | Write | features | exectrace | `enabled/disabled`
82+
Enable TUN device | Write | features | fuse device | `enabled/disabled`
83+
Enable FUSE device | Write | features | tun device | `enabled/disabled`
84+
Enable default registry | Write | infrastructure | default registry enabled | `true/false`
85+
Enable ECR IAM role authentication | Write |features | ecr auth irsa | `enabled/disabled`
86+
Enable AAD authentication for ACR | Write | features | azure auth aad | `enabled/disabled`
87+
Enable fallback shell support for K8s | Write | features | |
88+
Extension marketplace type | Write | * | ext marketplace type | `public/custom`
89+
Dev URL access permissions | Write | devurl access | public/org/authed/ | `true/false`
90+
Enable memory overprovisioning | Write | infrastructure | memory overprovisioning enabled | `true/false`
91+
92+
### Git OAuth
93+
94+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
95+
|------|------|------|------|------|
96+
| Client ID | Write | oauth configs | client id| `0fb2...7a4a` |
97+
| Client Secret | Write | oauth configs | client secret | `******` |
98+
| Description | Write | oauth configs | description | `example` |
99+
|Name | Write | oauth configs | name | `GitHub` |
100+
| Provider |Write | oauth configs |service type | `github/gitlab` |
101+
| URL | Write| oauth configs | URL host | `host.com`
102+
103+
### Appearance
104+
105+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
106+
|------|------|------|------|------|
107+
| System Banner | Write | system banner | enabled | `true/false` |
108+
| Background color | Write | system banner | color bg | `#9A4967` |
109+
| Footer | Write | system banner | text footer | `UNCLASSIFIED` |
110+
| Header | Write | system banner | text header | `UNCLASSIFIED` |
111+
| Service Banner | Write | appearance | svc banner enabled | `true/false` |
112+
| Background color | Write | appearance | svc banner color bg | `#18382D` |
113+
| Message | Write | appearance | svc banner body | `Maintenance 9:01PM` |
114+
| Terms of Service | Write | appearance | tos body | `Accept Terms & Conditions` |
115+
| Text field | Write | appearance | tos enabled | `true/false` |
116+
117+
### Telemetry
118+
119+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
120+
|------|------|------|------|------|
121+
| Send crash reports | Write | telemetry | crash reports enabled | `true/false` |
122+
| Send usage telemetry | Write | telemetry | enhanced telemetry enabled| `true/false` |
123+
| Send enhanced usage telemetry | Write | telemetry | telemetry enabled | `true/false` |
124+
125+
### Templates
126+
127+
> The template policy dropdown will provide a unique `commit`/`hash` for the
128+
> uploaded file. If file is uploaded from disk, then `file path`/`git ref` will
129+
> be `local`.
130+
131+
| **Admin Setting** | **Action** | **Target** | **Field** | **Diff** |
132+
|------|------|------|------|------|
133+
| Enable workspace templates | Write | infrastructure | enable workspaces as code | `true/false` |
134+
| Template policy | Write | local | commit/file hash/filepath/git ref/From | `0000...0000`/`ed19...843b`/`local`/`local`/`User`|

0 commit comments

Comments
 (0)