Skip to content

Commit 0facafe

Browse files
Kira-PilotKira-Pilot
committed
added tags to audit-logs.md
1 parent 51c7aee commit 0facafe

File tree

4 files changed

+82
-15
lines changed

4 files changed

+82
-15
lines changed

‎.vscode/settings.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,7 @@
117117
"tailnet",
118118
"tailnettest",
119119
"Tailscale",
120+
"tbody",
120121
"TCGETS",
121122
"tcpip",
122123
"TCSETS",
@@ -128,6 +129,7 @@
128129
"tfjson",
129130
"tfplan",
130131
"tfstate",
132+
"thead",
131133
"tios",
132134
"tmpdir",
133135
"tparallel",

‎Makefile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,7 @@ gen: \
418418
provisionerd/proto/provisionerd.pb.go \
419419
site/src/api/typesGenerated.ts \
420420
docs/admin/prometheus.md \
421+
docs/admin/audit-logs.md \
421422
coderd/apidoc/swagger.json \
422423
.prettierignore.include \
423424
.prettierignore \
@@ -436,6 +437,7 @@ gen/mark-fresh:
436437
provisionerd/proto/provisionerd.pb.go \
437438
site/src/api/typesGenerated.ts \
438439
docs/admin/prometheus.md \
440+
docs/admin/audit-logs.md \
439441
coderd/apidoc/swagger.json \
440442
.prettierignore.include \
441443
.prettierignore \
@@ -490,6 +492,11 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
490492
cd site
491493
yarn run format:write:only ../docs/admin/prometheus.md
492494

495+
docs/admin/audit-logs.md: scripts/auditdocgen/main.go enterprise/audit/table.go
496+
go run scripts/auditdocgen/main.go
497+
cd site
498+
yarn run format:write:only ../docs/admin/audit-logs.md
499+
493500
coderd/apidoc/swagger.json: $(shell find ./scripts/apidocgen $(FIND_EXCLUSIONS) -type f) $(wildcard coderd/*.go) $(wildcard enterprise/coderd/*.go) $(wildcard codersdk/*.go) .swaggo docs/manifest.json
494501
./scripts/apidocgen/generate.sh
495502
yarn run --cwd=site format:write:only ../docs/api ../docs/manifest.json ../coderd/apidoc/swagger.json

‎docs/admin/audit-logs.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,23 @@ their deployment.
55

66
## Tracked Events
77

8-
We track **create, update and delete** events for the following resources:
9-
10-
- GitSSHKey
11-
- Template
12-
- TemplateVersion
13-
- Workspace
14-
- WorkspaceBuild
15-
- User
16-
- Group
8+
We track the following resources:
9+
10+
<!-- Code generated by 'make docs/admin/audit-logs.md'. DO NOT EDIT -->
11+
12+
| <b>Resource<b> | |
13+
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14+
| AuditableGroup | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>avatar_url</td><td>true</td></tr><tr><td>quota_allowance</td><td>true</td></tr><tr><td>members</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr></tbody></table> |
15+
| Organization | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>id</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>description</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> |
16+
| OrganizationMember | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>updated_at</td><td>false</td></tr><tr><td>roles</td><td>true</td></tr><tr><td>user_id</td><td>true</td></tr><tr><td>organization_id</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr></tbody></table> |
17+
| User | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>deleted</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>username</td><td>true</td></tr><tr><td>rbac_roles</td><td>true</td></tr><tr><td>login_type</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>hashed_password</td><td>true</td></tr><tr><td>status</td><td>true</td></tr><tr><td>last_seen_at</td><td>false</td></tr><tr><td>email</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>avatar_url</td><td>false</td></tr></tbody></table> |
18+
| Workspace | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>id</td><td>true</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>name</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>owner_id</td><td>true</td></tr><tr><td>autostart_schedule</td><td>true</td></tr><tr><td>ttl</td><td>true</td></tr><tr><td>last_used_at</td><td>false</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr></tbody></table> |
19+
| WorkspaceBuild | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>id</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>template_version_id</td><td>true</td></tr><tr><td>initiator_id</td><td>false</td></tr><tr><td>deadline</td><td>false</td></tr><tr><td>daily_cost</td><td>false</td></tr><tr><td>build_number</td><td>false</td></tr><tr><td>provisioner_state</td><td>false</td></tr><tr><td>reason</td><td>false</td></tr><tr><td>workspace_id</td><td>false</td></tr><tr><td>transition</td><td>false</td></tr></tbody></table> |
20+
| GitSSHKey | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>created_at</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>private_key</td><td>true</td></tr><tr><td>public_key</td><td>true</td></tr><tr><td>user_id</td><td>true</td></tr></tbody></table> |
21+
| Template | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>updated_at</td><td>false</td></tr><tr><td>provisioner</td><td>true</td></tr><tr><td>id</td><td>true</td></tr><tr><td>default_ttl</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr><tr><td>icon</td><td>true</td></tr><tr><td>min_autostart_interval</td><td>true</td></tr><tr><td>deleted</td><td>false</td></tr><tr><td>display_name</td><td>true</td></tr><tr><td>group_acl</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>user_acl</td><td>true</td></tr><tr><td>is_private</td><td>true</td></tr><tr><td>active_version_id</td><td>true</td></tr><tr><td>allow_user_cancel_workspace_jobs</td><td>true</td></tr><tr><td>description</td><td>true</td></tr></tbody></table> |
22+
| TemplateVersion | <table><thead><tr><th>Field</th><th>Tracked</th></tr></thead><tbody><tr><td>id</td><td>true</td></tr><tr><td>template_id</td><td>true</td></tr><tr><td>name</td><td>true</td></tr><tr><td>created_at</td><td>false</td></tr><tr><td>updated_at</td><td>false</td></tr><tr><td>readme</td><td>true</td></tr><tr><td>job_id</td><td>false</td></tr><tr><td>created_by</td><td>true</td></tr><tr><td>organization_id</td><td>false</td></tr></tbody></table> |
23+
24+
<!-- End generated by 'make docs/admin/audit-logs.md'. -->
1725

1826
## Filtering logs
1927

‎scripts/auditdocgen/main.go

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,33 @@ package main
22

33
import (
44
"bytes"
5+
"flag"
56
"fmt"
67
"log"
8+
"os"
79
"strconv"
810
"strings"
911

12+
"golang.org/x/xerrors"
13+
1014
"github.com/coder/coder/enterprise/audit"
1115
)
1216

17+
var (
18+
auditDocFile string
19+
dryRun bool
20+
21+
generatorPrefix = []byte("<!-- Code generated by 'make docs/admin/audit-logs.md'. DO NOT EDIT -->")
22+
generatorSuffix = []byte("<!-- End generated by 'make docs/admin/audit-logs.md'. -->")
23+
)
24+
25+
type AuditableResourcesMap map[string]map[string]bool
26+
1327
func main() {
28+
flag.StringVar(&auditDocFile, "audit-doc-file", "docs/admin/audit-logs.md", "Path to audit log doc file")
29+
flag.BoolVar(&dryRun, "dry-run", false, "Dry run")
30+
flag.Parse()
31+
1432
auditableResourcesMap, err := readAuditableResources()
1533
if err != nil {
1634
log.Fatal("can't read auditableResources: ", err)
@@ -26,14 +44,19 @@ func main() {
2644
log.Fatal("can't update audit doc: ", err)
2745
}
2846

47+
if dryRun {
48+
log.Println(string(doc))
49+
return
50+
}
51+
2952
err = writeAuditDoc(doc)
3053
if err != nil {
3154
log.Fatal("can't write updated audit doc: ", err)
3255
}
3356
}
3457

35-
type AuditableResourcesMap map[string]map[string]bool
36-
58+
// Transforms audit.AuditableResources to AuditableResourcesMap,
59+
// which uses friendlier language.
3760
func readAuditableResources() (AuditableResourcesMap, error) {
3861
auditableResourcesMap := make(AuditableResourcesMap)
3962

@@ -49,16 +72,35 @@ func readAuditableResources() (AuditableResourcesMap, error) {
4972
return auditableResourcesMap, nil
5073
}
5174

75+
// Reads the content of docs/admin/audit-logs.md
5276
func readAuditDoc() ([]byte, error) {
53-
var doc []byte
77+
doc, err := os.ReadFile(auditDocFile)
78+
if err != nil {
79+
return nil, err
80+
}
81+
fmt.Println("document returned", doc)
82+
5483
return doc, nil
5584
}
5685

86+
// Writes a markdown table of audit log resources to a buffer
5787
func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([]byte, error) {
58-
var updatedDoc []byte
88+
i := bytes.Index(doc, generatorPrefix)
89+
if i < 0 {
90+
return nil, xerrors.New("generator prefix tag not found")
91+
}
92+
tableStartIndex := i + len(generatorPrefix) + 1
93+
94+
j := bytes.Index(doc[tableStartIndex:], generatorSuffix)
95+
if j < 0 {
96+
return nil, xerrors.New("generator suffix tag not found")
97+
}
98+
tableEndIndex := tableStartIndex + j
5999

60100
var buffer bytes.Buffer
101+
buffer.Write(doc[:tableStartIndex])
61102
buffer.WriteByte('\n')
103+
62104
buffer.WriteString("|<b>Resource<b>||\n")
63105
buffer.WriteString("|--|-----------------|\n")
64106

@@ -73,10 +115,18 @@ func updateAuditDoc(doc []byte, auditableResourcesMap AuditableResourcesMap) ([]
73115
buffer.WriteString("</tbody></table>\n")
74116
}
75117

76-
fmt.Println("updated table", buffer.String())
77-
return updatedDoc, nil
118+
buffer.WriteString("\n")
119+
buffer.Write(doc[tableEndIndex:])
120+
return buffer.Bytes(), nil
78121
}
79122

123+
// Updates docs/admin/audit-logs.md with new table content
80124
func writeAuditDoc(doc []byte) error {
125+
// G306: Expect WriteFile permissions to be 0600 or less
126+
/* #nosec G306 */
127+
err := os.WriteFile(auditDocFile, doc, 0644)
128+
if err != nil {
129+
return err
130+
}
81131
return nil
82132
}

0 commit comments

Comments
 (0)