Skip to content

Commit f7a2e62

Browse files
[AutoDocs] Update Platform Docs (#3318)
Platform docs autocommit Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: cpanato <4115580+cpanato@users.noreply.github.com>
1 parent 51e1a4b commit f7a2e62

146 files changed

Lines changed: 254 additions & 183 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/chainguard/administration/cloudevents/events-reference.md

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ lead: ""
44
description: "Chainguard Events"
55
type: "article"
66
date: 2022-11-15T12:05:04
7-
lastmod: 2026-05-11T16:02:05
7+
lastmod: 2026-05-12T22:15:34
88
draft: false
99
tags: ["Platform", "Reference", "Product"]
1010
images: []
@@ -82,7 +82,7 @@ Ce-Id: cloudevent generated UUID
8282
Ce-Source: cgr.dev
8383
Ce-Specversion: 1.0
8484
Ce-Subject: The identifier of the repository being pulled from
85-
Ce-Time: 2026-05-11T16:02:05.830291448Z
85+
Ce-Time: 2026-05-12T22:15:34.677192633Z
8686
Ce-Type: dev.chainguard.registry.pull.v1
8787
Content-Length: 777
8888
Content-Type: application/json
@@ -112,7 +112,7 @@ User-Agent: Chainguard Enforce
112112
"tag": "The tag of the image being pulled",
113113
"type": "Type determines whether the object being pulled is a manifest or blob",
114114
"user_agent": "The user-agent of the client who pulled",
115-
"when": "2026-05-11T16:02:05.829483"
115+
"when": "2026-05-12T22:15:34.676211"
116116
}
117117
}
118118
```
@@ -132,7 +132,7 @@ Ce-Id: cloudevent generated UUID
132132
Ce-Source: cgr.dev
133133
Ce-Specversion: 1.0
134134
Ce-Subject: The identifier of the repository being pushed to
135-
Ce-Time: 2026-05-11T16:02:05.829647702Z
135+
Ce-Time: 2026-05-12T22:15:34.676434511Z
136136
Ce-Type: dev.chainguard.registry.push.v1
137137
Content-Length: 707
138138
Content-Type: application/json
@@ -161,7 +161,7 @@ User-Agent: Chainguard Enforce
161161
"tag": "The tag of the image being pushed",
162162
"type": "Type determines whether the object being pushed is a manifest or blob",
163163
"user_agent": "The user-agent of the client who pushed",
164-
"when": "2026-05-11T16:02:05.829469"
164+
"when": "2026-05-12T22:15:34.676189"
165165
}
166166
}
167167
```
@@ -181,7 +181,7 @@ Ce-Id: cloudevent generated UUID
181181
Ce-Source: https://console-api.enforce.dev/auth/v1/register
182182
Ce-Specversion: 1.0
183183
Ce-Subject: Chainguard UIDP
184-
Ce-Time: 2026-05-11T16:02:05.835008057Z
184+
Ce-Time: 2026-05-12T22:15:34.688624598Z
185185
Ce-Type: dev.chainguard.api.auth.registered.v1
186186
Content-Length: 154
187187
Content-Type: application/json
@@ -218,7 +218,7 @@ Ce-Id: cloudevent generated UUID
218218
Ce-Source: https://console-api.enforce.dev/events/v1/subscriptions
219219
Ce-Specversion: 1.0
220220
Ce-Subject: UIDP identifier of the subscription
221-
Ce-Time: 2026-05-11T16:02:05.840945077Z
221+
Ce-Time: 2026-05-12T22:15:34.68713879Z
222222
Ce-Type: dev.chainguard.api.events.subscription.created.v1
223223
Content-Length: 152
224224
Content-Type: application/json
@@ -254,7 +254,7 @@ Ce-Id: cloudevent generated UUID
254254
Ce-Source: https://console-api.enforce.dev/events/v1/subscriptions
255255
Ce-Specversion: 1.0
256256
Ce-Subject: UIDP identifier of the subscription to delete
257-
Ce-Time: 2026-05-11T16:02:05.841145437Z
257+
Ce-Time: 2026-05-12T22:15:34.687427718Z
258258
Ce-Type: dev.chainguard.api.events.subscription.deleted.v1
259259
Content-Length: 119
260260
Content-Type: application/json
@@ -290,7 +290,7 @@ Ce-Id: cloudevent generated UUID
290290
Ce-Source: https://console-api.enforce.dev/iam/v1/account_associations
291291
Ce-Specversion: 1.0
292292
Ce-Subject: UIDP with which this account information is associated
293-
Ce-Time: 2026-05-11T16:02:05.83389417Z
293+
Ce-Time: 2026-05-12T22:15:34.686085458Z
294294
Ce-Type: dev.chainguard.api.iam.account_associations.created.v1
295295
Content-Length: 385
296296
Content-Type: application/json
@@ -334,7 +334,7 @@ Ce-Id: cloudevent generated UUID
334334
Ce-Source: https://console-api.enforce.dev/iam/v1/account_associations
335335
Ce-Specversion: 1.0
336336
Ce-Subject: UIDP with which this account information is associated
337-
Ce-Time: 2026-05-11T16:02:05.834385218Z
337+
Ce-Time: 2026-05-12T22:15:34.686447452Z
338338
Ce-Type: dev.chainguard.api.iam.account_associations.updated.v1
339339
Content-Length: 336
340340
Content-Type: application/json
@@ -378,7 +378,7 @@ Ce-Id: cloudevent generated UUID
378378
Ce-Source: https://console-api.enforce.dev/iam/v1/account_associations
379379
Ce-Specversion: 1.0
380380
Ce-Subject: UIDP of the group whose associations will be deleted
381-
Ce-Time: 2026-05-11T16:02:05.834632941Z
381+
Ce-Time: 2026-05-12T22:15:34.686748353Z
382382
Ce-Type: dev.chainguard.api.iam.account_associations.deleted.v1
383383
Content-Length: 129
384384
Content-Type: application/json
@@ -414,7 +414,7 @@ Ce-Id: cloudevent generated UUID
414414
Ce-Source: https://console-api.enforce.dev/iam/v1/group_invites
415415
Ce-Specversion: 1.0
416416
Ce-Subject: group UIDP under which this invite resides
417-
Ce-Time: 2026-05-11T16:02:05.838748189Z
417+
Ce-Time: 2026-05-12T22:15:34.677872981Z
418418
Ce-Type: dev.chainguard.api.iam.group_invite.created.v1
419419
Content-Length: 145
420420
Content-Type: application/json
@@ -452,7 +452,7 @@ Ce-Id: cloudevent generated UUID
452452
Ce-Source: https://console-api.enforce.dev/iam/v1/group_invites
453453
Ce-Specversion: 1.0
454454
Ce-Subject: UIDP of the record
455-
Ce-Time: 2026-05-11T16:02:05.839034666Z
455+
Ce-Time: 2026-05-12T22:15:34.678127294Z
456456
Ce-Type: dev.chainguard.api.iam.group_invite.deleted.v1
457457
Content-Length: 92
458458
Content-Type: application/json
@@ -488,7 +488,7 @@ Ce-Id: cloudevent generated UUID
488488
Ce-Source: https://console-api.enforce.dev/iam/v1/groups
489489
Ce-Specversion: 1.0
490490
Ce-Subject: group UIDP under which this group resides
491-
Ce-Time: 2026-05-11T16:02:05.839269216Z
491+
Ce-Time: 2026-05-12T22:15:34.687800002Z
492492
Ce-Type: dev.chainguard.api.iam.group.created.v1
493493
Content-Length: 169
494494
Content-Type: application/json
@@ -525,7 +525,7 @@ Ce-Id: cloudevent generated UUID
525525
Ce-Source: https://console-api.enforce.dev/iam/v1/groups
526526
Ce-Specversion: 1.0
527527
Ce-Subject: group UIDP under which this group resides
528-
Ce-Time: 2026-05-11T16:02:05.839419348Z
528+
Ce-Time: 2026-05-12T22:15:34.68805146Z
529529
Ce-Type: dev.chainguard.api.iam.group.updated.v1
530530
Content-Length: 169
531531
Content-Type: application/json
@@ -562,7 +562,7 @@ Ce-Id: cloudevent generated UUID
562562
Ce-Source: https://console-api.enforce.dev/iam/v1/groups
563563
Ce-Specversion: 1.0
564564
Ce-Subject: UIDP of the record
565-
Ce-Time: 2026-05-11T16:02:05.839530897Z
565+
Ce-Time: 2026-05-12T22:15:34.688328626Z
566566
Ce-Type: dev.chainguard.api.iam.group.deleted.v1
567567
Content-Length: 92
568568
Content-Type: application/json
@@ -598,7 +598,7 @@ Ce-Id: cloudevent generated UUID
598598
Ce-Source: https://console-api.enforce.dev/iam/v1/identities
599599
Ce-Specversion: 1.0
600600
Ce-Subject: UIDP of identity
601-
Ce-Time: 2026-05-11T16:02:05.839735779Z
601+
Ce-Time: 2026-05-12T22:15:34.680140674Z
602602
Ce-Type: dev.chainguard.api.iam.identity.created.v1
603603
Content-Length: 329
604604
Content-Type: application/json
@@ -639,7 +639,7 @@ Ce-Id: cloudevent generated UUID
639639
Ce-Source: https://console-api.enforce.dev/iam/v1/identities
640640
Ce-Specversion: 1.0
641641
Ce-Subject: The unique identifier of this specific identity
642-
Ce-Time: 2026-05-11T16:02:05.839905437Z
642+
Ce-Time: 2026-05-12T22:15:34.680489434Z
643643
Ce-Type: dev.chainguard.api.iam.identity.updated.v1
644644
Content-Length: 245
645645
Content-Type: application/json
@@ -677,7 +677,7 @@ Ce-Id: cloudevent generated UUID
677677
Ce-Source: https://console-api.enforce.dev/iam/v1/identities
678678
Ce-Specversion: 1.0
679679
Ce-Subject: UIDP of the record
680-
Ce-Time: 2026-05-11T16:02:05.840029934Z
680+
Ce-Time: 2026-05-12T22:15:34.680731926Z
681681
Ce-Type: dev.chainguard.api.iam.identity.deleted.v1
682682
Content-Length: 92
683683
Content-Type: application/json
@@ -713,7 +713,7 @@ Ce-Id: cloudevent generated UUID
713713
Ce-Source: https://console-api.enforce.dev/iam/v1/identityProviders
714714
Ce-Specversion: 1.0
715715
Ce-Subject: UIDP of identity provider
716-
Ce-Time: 2026-05-11T16:02:05.837747197Z
716+
Ce-Time: 2026-05-12T22:15:34.680995938Z
717717
Ce-Type: dev.chainguard.api.iam.identity_providers.created.v1
718718
Content-Length: 378
719719
Content-Type: application/json
@@ -754,7 +754,7 @@ Ce-Id: cloudevent generated UUID
754754
Ce-Source: https://console-api.enforce.dev/iam/v1/identityProviders
755755
Ce-Specversion: 1.0
756756
Ce-Subject: The UIDP of the IAM group to nest this identity provider under
757-
Ce-Time: 2026-05-11T16:02:05.83794562Z
757+
Ce-Time: 2026-05-12T22:15:34.681321173Z
758758
Ce-Type: dev.chainguard.api.iam.identity_providers.updated.v1
759759
Content-Length: 279
760760
Content-Type: application/json
@@ -792,7 +792,7 @@ Ce-Id: cloudevent generated UUID
792792
Ce-Source: https://console-api.enforce.dev/iam/v1/identityProviders
793793
Ce-Specversion: 1.0
794794
Ce-Subject: UIDP of the IdP
795-
Ce-Time: 2026-05-11T16:02:05.83810043Z
795+
Ce-Time: 2026-05-12T22:15:34.681549879Z
796796
Ce-Type: dev.chainguard.api.iam.identity_providers.deleted.v1
797797
Content-Length: 89
798798
Content-Type: application/json
@@ -828,7 +828,7 @@ Ce-Id: cloudevent generated UUID
828828
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings
829829
Ce-Specversion: 1.0
830830
Ce-Subject: UIDP of the Role to bind
831-
Ce-Time: 2026-05-11T16:02:05.840202632Z
831+
Ce-Time: 2026-05-12T22:15:34.681816837Z
832832
Ce-Type: dev.chainguard.api.iam.rolebindings.created.v1
833833
Content-Length: 261
834834
Content-Type: application/json
@@ -868,7 +868,7 @@ Ce-Id: cloudevent generated UUID
868868
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings/batch
869869
Ce-Specversion: 1.0
870870
Ce-Subject: UID of this role binding, under a parent group UIDP
871-
Ce-Time: 2026-05-11T16:02:05.840342683Z
871+
Ce-Time: 2026-05-12T22:15:34.682065771Z
872872
Ce-Type: dev.chainguard.api.iam.rolebindings.created.batch.v1
873873
Content-Length: 220
874874
Content-Type: application/json
@@ -909,7 +909,7 @@ Ce-Id: cloudevent generated UUID
909909
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings
910910
Ce-Specversion: 1.0
911911
Ce-Subject: UID of this role binding
912-
Ce-Time: 2026-05-11T16:02:05.84049916Z
912+
Ce-Time: 2026-05-12T22:15:34.683285011Z
913913
Ce-Type: dev.chainguard.api.iam.rolebindings.updated.v1
914914
Content-Length: 173
915915
Content-Type: application/json
@@ -946,7 +946,7 @@ Ce-Id: cloudevent generated UUID
946946
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings
947947
Ce-Specversion: 1.0
948948
Ce-Subject: UID of the record
949-
Ce-Time: 2026-05-11T16:02:05.840619051Z
949+
Ce-Time: 2026-05-12T22:15:34.684341119Z
950950
Ce-Type: dev.chainguard.api.iam.rolebindings.deleted.v1
951951
Content-Length: 91
952952
Content-Type: application/json
@@ -982,7 +982,7 @@ Ce-Id: cloudevent generated UUID
982982
Ce-Source: https://console-api.enforce.dev/registry/v1/repos
983983
Ce-Specversion: 1.0
984984
Ce-Subject: The identifier of this specific repository
985-
Ce-Time: 2026-05-11T16:02:05.836409446Z
985+
Ce-Time: 2026-05-12T22:15:34.684730995Z
986986
Ce-Type: dev.chainguard.api.platform.registry.repo.created.v1
987987
Content-Length: 243
988988
Content-Type: application/json
@@ -1022,7 +1022,7 @@ Ce-Id: cloudevent generated UUID
10221022
Ce-Source: https://console-api.enforce.dev/registry/v1/repos
10231023
Ce-Specversion: 1.0
10241024
Ce-Subject: The identifier of this specific repository
1025-
Ce-Time: 2026-05-11T16:02:05.836804751Z
1025+
Ce-Time: 2026-05-12T22:15:34.685062132Z
10261026
Ce-Type: dev.chainguard.api.platform.registry.repo.updated.v1
10271027
Content-Length: 243
10281028
Content-Type: application/json
@@ -1062,7 +1062,7 @@ Ce-Id: cloudevent generated UUID
10621062
Ce-Source: https://console-api.enforce.dev/registry/v1/repos
10631063
Ce-Specversion: 1.0
10641064
Ce-Subject: The identifier of this specific repository
1065-
Ce-Time: 2026-05-11T16:02:05.836962368Z
1065+
Ce-Time: 2026-05-12T22:15:34.68528121Z
10661066
Ce-Type: dev.chainguard.api.platform.registry.repo.deleted.v1
10671067
Content-Length: 116
10681068
Content-Type: application/json
@@ -1097,7 +1097,7 @@ Ce-Id: cloudevent generated UUID
10971097
Ce-Source: https://console-api.enforce.dev/registry/v1/tags
10981098
Ce-Specversion: 1.0
10991099
Ce-Subject: The identifier of this specific tag
1100-
Ce-Time: 2026-05-11T16:02:05.837094548Z
1100+
Ce-Time: 2026-05-12T22:15:34.685465293Z
11011101
Ce-Type: dev.chainguard.api.platform.registry.tag.created.v1
11021102
Content-Length: 197
11031103
Content-Type: application/json
@@ -1134,7 +1134,7 @@ Ce-Id: cloudevent generated UUID
11341134
Ce-Source: https://console-api.enforce.dev/registry/v1/tags
11351135
Ce-Specversion: 1.0
11361136
Ce-Subject: The identifier of this specific tag
1137-
Ce-Time: 2026-05-11T16:02:05.837311555Z
1137+
Ce-Time: 2026-05-12T22:15:34.68564602Z
11381138
Ce-Type: dev.chainguard.api.platform.registry.tag.updated.v1
11391139
Content-Length: 197
11401140
Content-Type: application/json
@@ -1171,7 +1171,7 @@ Ce-Id: cloudevent generated UUID
11711171
Ce-Source: https://console-api.enforce.dev/registry/v1/tags
11721172
Ce-Specversion: 1.0
11731173
Ce-Subject: The identifier of this specific tag
1174-
Ce-Time: 2026-05-11T16:02:05.837432521Z
1174+
Ce-Time: 2026-05-12T22:15:34.685791671Z
11751175
Ce-Type: dev.chainguard.api.platform.registry.tag.deleted.v1
11761176
Content-Length: 109
11771177
Content-Type: application/json

content/chainguard/chainctl/chainctl-docs/chainctl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2026-05-11T16:01:54Z
2+
date: 2026-05-12T22:15:22Z
33
title: "chainctl"
44
slug: chainctl
55
url: /chainguard/chainctl/chainctl-docs/chainctl/

content/chainguard/chainctl/chainctl-docs/chainctl_actions.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2026-05-11T16:01:54Z
2+
date: 2026-05-12T22:15:22Z
33
title: "chainctl actions"
44
slug: chainctl_actions
55
url: /chainguard/chainctl/chainctl-docs/chainctl_actions/
@@ -31,5 +31,6 @@ Interact with the Chainguard Actions product.
3131
### SEE ALSO
3232

3333
* [chainctl](/chainguard/chainctl/chainctl-docs/chainctl/) - Chainguard Control
34+
* [chainctl actions discover](/chainguard/chainctl/chainctl-docs/chainctl_actions_discover/) - Discover GitHub Actions dependencies used by your workflows.
3435
* [chainctl actions entitlements](/chainguard/chainctl/chainctl-docs/chainctl_actions_entitlements/) - Manage Actions product entitlements.
3536

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
date: 2026-05-12T22:15:22Z
3+
title: "chainctl actions discover"
4+
slug: chainctl_actions_discover
5+
url: /chainguard/chainctl/chainctl-docs/chainctl_actions_discover/
6+
draft: false
7+
tags: ["chainctl", "Reference", "Product"]
8+
images: []
9+
type: "article"
10+
toc: true
11+
---
12+
## chainctl actions discover
13+
14+
Discover GitHub Actions dependencies used by your workflows.
15+
16+
### Synopsis
17+
18+
Discover GitHub Actions dependencies.
19+
20+
Walks the target's workflows and composite-action definitions and resolves
21+
every action and container image they (transitively) use.
22+
23+
TARGET may be:
24+
- a local directory (default: current directory) — scans .github/workflows/
25+
and action.{yml,yaml}
26+
- a repo "owner/repo" — scans the repo's workflows and action.{yml,yaml}
27+
- a single action ref "owner/repo[/subpath]@version"
28+
29+
Requires a GitHub token via $GITHUB_TOKEN or 'gh auth token'.
30+
31+
```
32+
chainctl actions discover [TARGET] [flags]
33+
```
34+
35+
### Examples
36+
37+
```
38+
chainctl actions discover
39+
chainctl actions discover .
40+
chainctl actions discover actions/checkout@v4
41+
chainctl actions discover chainguard-dev/mono
42+
```
43+
44+
### Options
45+
46+
```
47+
--cache-dir string Directory for caching GitHub API responses (default: $TMPDIR/chainctl-discover-cache)
48+
--clear-cache Clear the cache directory before running
49+
--timeout duration Maximum time to spend resolving dependencies (default 5m0s)
50+
```
51+
52+
### Options inherited from parent commands
53+
54+
```
55+
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
56+
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
57+
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
58+
--console string The url of the Chainguard platform Console. (default "https://console.chainguard.dev")
59+
--force-color Force color output even when stdout is not a TTY.
60+
-h, --help Help for chainctl
61+
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
62+
--log-level string Set the log level (debug, info) (default "ERROR")
63+
-o, --output string Output format. One of: [csv, env, go-template, id, json, markdown, none, table, terse, tree, wide]
64+
-v, --v int Set the log verbosity level.
65+
```
66+
67+
### SEE ALSO
68+
69+
* [chainctl actions](/chainguard/chainctl/chainctl-docs/chainctl_actions/) - Interact with the Chainguard Actions product.
70+

content/chainguard/chainctl/chainctl-docs/chainctl_actions_entitlements.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2026-05-11T16:01:54Z
2+
date: 2026-05-12T22:15:22Z
33
title: "chainctl actions entitlements"
44
slug: chainctl_actions_entitlements
55
url: /chainguard/chainctl/chainctl-docs/chainctl_actions_entitlements/

content/chainguard/chainctl/chainctl-docs/chainctl_actions_entitlements_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
date: 2026-05-11T16:01:54Z
2+
date: 2026-05-12T22:15:22Z
33
title: "chainctl actions entitlements create"
44
slug: chainctl_actions_entitlements_create
55
url: /chainguard/chainctl/chainctl-docs/chainctl_actions_entitlements_create/

0 commit comments

Comments
 (0)