Skip to content

Commit

Permalink
[AutoDocs] Update Platform Docs (#1905)
Browse files Browse the repository at this point in the history
Platform docs v0.1.278 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>
  • Loading branch information
octo-sts[bot] and cpanato authored Nov 14, 2024
1 parent e4e3b59 commit cb10ae0
Show file tree
Hide file tree
Showing 81 changed files with 3,251 additions and 711 deletions.
1,769 changes: 1,769 additions & 0 deletions autodocs/platform-changelog.md

Large diffs are not rendered by default.

66 changes: 33 additions & 33 deletions content/chainguard/administration/cloudevents/events-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@ lead: ""
description: "Chainguard Events"
type: "article"
date: 2022-11-15T12:05:04
lastmod: 2024-08-19T22:20:29
lastmod: 2024-11-13T00:36:15
draft: false
tags: ["Platform", "Reference", "Product"]
images: []
weight: 780
---

Chainguard generates and emits [CloudEvents](https://cloudevents.io/) based on actions that occur within a Chainguard account, such as creating an IAM invitation or an image being pushed to your repository.
Chainguard generates and emits [CloudEvents](https://cloudevents.io/) based on actions that occur within a Chainguard account, such as registering a Kubernetes cluster or creating an IAM invitation. Chainguard also emits events when workloads or policies are changed in a cluster.

Check out [this GitHub repository](https://github.com/chainguard-dev/enforce-events) for some sample applications that demonstrate how to use events to create Slack notifications, open GitHub issues, and mirror images.

Expand All @@ -23,7 +23,7 @@ chainctl events subscriptions create –parent $YOUR_ORGANIZATION_OR_FOLDER http

Once you are subscribed to Chainguard events, you will start receiving HTTP POST requests. Each request has a common set of CloudEvent header fields, denoted by the `Ce-` prefix. The event body is encoded using JSON and will have two top-level keys, `actor` and `body`.

The `actor` field is the identity of the actor in your Chainguard account that triggered the event (e.g. the team member who pulled an image) . The `body` field contains the specific data about the event, for example the response status for an invite creation request.
The `actor` field is the identity of the actor in your Chainguard account that triggered the event, such as a team member or a Kubernetes cluster. The `body` field contains the specific data about the event, for example the response status for an invite creation request, or a cluster delete request.

## UIDP Identifiers

Expand Down Expand Up @@ -74,7 +74,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: cgr.dev
Ce-Specversion: 1.0
Ce-Subject: The identifier of the repository being pulled from
Ce-Time: 2024-06-04T22:20:29.128066735Z
Ce-Time: 2024-11-13T00:36:15.616256055Z
Ce-Type: dev.chainguard.registry.pull.v1
Content-Length: 777
Content-Type: application/json
Expand Down Expand Up @@ -104,7 +104,7 @@ User-Agent: Chainguard Enforce
"tag": "The tag of the image being pulled",
"type": "Type determines whether the object being pulled is a manifest or blob",
"user_agent": "The user-agent of the client who pulled",
"when": "2024-06-04T22:20:29.127018"
"when": "2024-11-13T00:36:15.615286"
}
}
```
Expand All @@ -124,7 +124,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: cgr.dev
Ce-Specversion: 1.0
Ce-Subject: The identifier of the repository being pushed to
Ce-Time: 2024-06-04T22:20:29.127136643Z
Ce-Time: 2024-11-13T00:36:15.615407107Z
Ce-Type: dev.chainguard.registry.push.v1
Content-Length: 707
Content-Type: application/json
Expand Down Expand Up @@ -153,7 +153,7 @@ User-Agent: Chainguard Enforce
"tag": "The tag of the image being pushed",
"type": "Type determines whether the object being pushed is a manifest or blob",
"user_agent": "The user-agent of the client who pushed",
"when": "2024-06-04T22:20:29.126991"
"when": "2024-11-13T00:36:15.615266"
}
}
```
Expand All @@ -173,7 +173,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/auth/v1/register
Ce-Specversion: 1.0
Ce-Subject: Chainguard UIDP
Ce-Time: 2024-06-04T22:20:29.131227744Z
Ce-Time: 2024-11-13T00:36:15.623652965Z
Ce-Type: dev.chainguard.api.auth.registered.v1
Content-Length: 154
Content-Type: application/json
Expand Down Expand Up @@ -210,7 +210,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/events/v1/subscriptions
Ce-Specversion: 1.0
Ce-Subject: UIDP identifier of the subscription
Ce-Time: 2024-06-04T22:20:29.134157002Z
Ce-Time: 2024-11-13T00:36:15.617077876Z
Ce-Type: dev.chainguard.api.events.subscription.created.v1
Content-Length: 152
Content-Type: application/json
Expand Down Expand Up @@ -246,7 +246,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/events/v1/subscriptions
Ce-Specversion: 1.0
Ce-Subject: UIDP identifier of the subscription to delete
Ce-Time: 2024-06-04T22:20:29.134349236Z
Ce-Time: 2024-11-13T00:36:15.617302774Z
Ce-Type: dev.chainguard.api.events.subscription.deleted.v1
Content-Length: 119
Content-Type: application/json
Expand Down Expand Up @@ -282,7 +282,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/account_associations
Ce-Specversion: 1.0
Ce-Subject: UIDP with which this account information is associated
Ce-Time: 2024-06-04T22:20:29.131443198Z
Ce-Time: 2024-11-13T00:36:15.621120948Z
Ce-Type: dev.chainguard.api.iam.account_associations.created.v1
Content-Length: 385
Content-Type: application/json
Expand Down Expand Up @@ -326,7 +326,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/account_associations
Ce-Specversion: 1.0
Ce-Subject: UIDP with which this account information is associated
Ce-Time: 2024-06-04T22:20:29.131685893Z
Ce-Time: 2024-11-13T00:36:15.621350648Z
Ce-Type: dev.chainguard.api.iam.account_associations.updated.v1
Content-Length: 336
Content-Type: application/json
Expand Down Expand Up @@ -370,7 +370,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/account_associations
Ce-Specversion: 1.0
Ce-Subject: UIDP of the group whose associations will be deleted
Ce-Time: 2024-06-04T22:20:29.131889554Z
Ce-Time: 2024-11-13T00:36:15.621567066Z
Ce-Type: dev.chainguard.api.iam.account_associations.deleted.v1
Content-Length: 129
Content-Type: application/json
Expand Down Expand Up @@ -406,7 +406,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/group_invites
Ce-Specversion: 1.0
Ce-Subject: group UIDP under which this invite resides
Ce-Time: 2024-06-04T22:20:29.129428153Z
Ce-Time: 2024-11-13T00:36:15.623166826Z
Ce-Type: dev.chainguard.api.iam.group_invite.created.v1
Content-Length: 145
Content-Type: application/json
Expand Down Expand Up @@ -444,7 +444,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/group_invites
Ce-Specversion: 1.0
Ce-Subject: UIDP of the record
Ce-Time: 2024-06-04T22:20:29.129686176Z
Ce-Time: 2024-11-13T00:36:15.623371679Z
Ce-Type: dev.chainguard.api.iam.group_invite.deleted.v1
Content-Length: 92
Content-Type: application/json
Expand Down Expand Up @@ -480,7 +480,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/groups
Ce-Specversion: 1.0
Ce-Subject: group UIDP under which this group resides
Ce-Time: 2024-06-04T22:20:29.128752981Z
Ce-Time: 2024-11-13T00:36:15.621815638Z
Ce-Type: dev.chainguard.api.iam.group.created.v1
Content-Length: 169
Content-Type: application/json
Expand Down Expand Up @@ -517,7 +517,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/groups
Ce-Specversion: 1.0
Ce-Subject: group UIDP under which this group resides
Ce-Time: 2024-06-04T22:20:29.12899472Z
Ce-Time: 2024-11-13T00:36:15.622013488Z
Ce-Type: dev.chainguard.api.iam.group.updated.v1
Content-Length: 169
Content-Type: application/json
Expand Down Expand Up @@ -554,7 +554,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/groups
Ce-Specversion: 1.0
Ce-Subject: UIDP of the record
Ce-Time: 2024-06-04T22:20:29.129186934Z
Ce-Time: 2024-11-13T00:36:15.622228991Z
Ce-Type: dev.chainguard.api.iam.group.deleted.v1
Content-Length: 92
Content-Type: application/json
Expand Down Expand Up @@ -590,7 +590,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/identities
Ce-Specversion: 1.0
Ce-Subject: UIDP of identity
Ce-Time: 2024-06-04T22:20:29.129925434Z
Ce-Time: 2024-11-13T00:36:15.622461827Z
Ce-Type: dev.chainguard.api.iam.identity.created.v1
Content-Length: 329
Content-Type: application/json
Expand Down Expand Up @@ -631,7 +631,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/identities
Ce-Specversion: 1.0
Ce-Subject: The unique identifier of this specific identity
Ce-Time: 2024-06-04T22:20:29.130156257Z
Ce-Time: 2024-11-13T00:36:15.622668033Z
Ce-Type: dev.chainguard.api.iam.identity.updated.v1
Content-Length: 245
Content-Type: application/json
Expand Down Expand Up @@ -669,7 +669,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/identities
Ce-Specversion: 1.0
Ce-Subject: UIDP of the record
Ce-Time: 2024-06-04T22:20:29.1303446Z
Ce-Time: 2024-11-13T00:36:15.622836237Z
Ce-Type: dev.chainguard.api.iam.identity.deleted.v1
Content-Length: 92
Content-Type: application/json
Expand Down Expand Up @@ -705,7 +705,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/identityProviders
Ce-Specversion: 1.0
Ce-Subject: UIDP of identity provider
Ce-Time: 2024-06-04T22:20:29.130592264Z
Ce-Time: 2024-11-13T00:36:15.617590733Z
Ce-Type: dev.chainguard.api.iam.identity_providers.created.v1
Content-Length: 378
Content-Type: application/json
Expand Down Expand Up @@ -746,7 +746,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/identityProviders
Ce-Specversion: 1.0
Ce-Subject: The UIDP of the IAM group to nest this identity provider under
Ce-Time: 2024-06-04T22:20:29.13079852Z
Ce-Time: 2024-11-13T00:36:15.617883671Z
Ce-Type: dev.chainguard.api.iam.identity_providers.updated.v1
Content-Length: 279
Content-Type: application/json
Expand Down Expand Up @@ -784,7 +784,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/identityProviders
Ce-Specversion: 1.0
Ce-Subject: UIDP of the IdP
Ce-Time: 2024-06-04T22:20:29.131002522Z
Ce-Time: 2024-11-13T00:36:15.618090861Z
Ce-Type: dev.chainguard.api.iam.identity_providers.deleted.v1
Content-Length: 89
Content-Type: application/json
Expand Down Expand Up @@ -820,7 +820,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings
Ce-Specversion: 1.0
Ce-Subject: UIDP of the Role to bind
Ce-Time: 2024-06-04T22:20:29.133571876Z
Ce-Time: 2024-11-13T00:36:15.62389087Z
Ce-Type: dev.chainguard.api.iam.rolebindings.created.v1
Content-Length: 261
Content-Type: application/json
Expand Down Expand Up @@ -860,7 +860,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings
Ce-Specversion: 1.0
Ce-Subject: UID of this role binding
Ce-Time: 2024-06-04T22:20:29.133779906Z
Ce-Time: 2024-11-13T00:36:15.624074534Z
Ce-Type: dev.chainguard.api.iam.rolebindings.updated.v1
Content-Length: 173
Content-Type: application/json
Expand Down Expand Up @@ -897,7 +897,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/iam/v1/rolebindings
Ce-Specversion: 1.0
Ce-Subject: UID of the record
Ce-Time: 2024-06-04T22:20:29.13395845Z
Ce-Time: 2024-11-13T00:36:15.624239613Z
Ce-Type: dev.chainguard.api.iam.rolebindings.deleted.v1
Content-Length: 91
Content-Type: application/json
Expand Down Expand Up @@ -933,7 +933,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/registry/v1/repos
Ce-Specversion: 1.0
Ce-Subject: The identifier of this specific repository
Ce-Time: 2024-06-04T22:20:29.132154681Z
Ce-Time: 2024-11-13T00:36:15.618479716Z
Ce-Type: dev.chainguard.api.platform.registry.repo.created.v1
Content-Length: 243
Content-Type: application/json
Expand Down Expand Up @@ -973,7 +973,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/registry/v1/repos
Ce-Specversion: 1.0
Ce-Subject: The identifier of this specific repository
Ce-Time: 2024-06-04T22:20:29.132393308Z
Ce-Time: 2024-11-13T00:36:15.618773666Z
Ce-Type: dev.chainguard.api.platform.registry.repo.updated.v1
Content-Length: 243
Content-Type: application/json
Expand Down Expand Up @@ -1013,7 +1013,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/registry/v1/repos
Ce-Specversion: 1.0
Ce-Subject: The identifier of this specific repository
Ce-Time: 2024-06-04T22:20:29.132587271Z
Ce-Time: 2024-11-13T00:36:15.618998356Z
Ce-Type: dev.chainguard.api.platform.registry.repo.deleted.v1
Content-Length: 116
Content-Type: application/json
Expand Down Expand Up @@ -1048,7 +1048,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/registry/v1/tags
Ce-Specversion: 1.0
Ce-Subject: The identifier of this specific tag
Ce-Time: 2024-06-04T22:20:29.132772669Z
Ce-Time: 2024-11-13T00:36:15.619650967Z
Ce-Type: dev.chainguard.api.platform.registry.tag.created.v1
Content-Length: 197
Content-Type: application/json
Expand Down Expand Up @@ -1085,7 +1085,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/registry/v1/tags
Ce-Specversion: 1.0
Ce-Subject: The identifier of this specific tag
Ce-Time: 2024-06-04T22:20:29.133171155Z
Ce-Time: 2024-11-13T00:36:15.620084088Z
Ce-Type: dev.chainguard.api.platform.registry.tag.updated.v1
Content-Length: 197
Content-Type: application/json
Expand Down Expand Up @@ -1122,7 +1122,7 @@ Ce-Id: cloudevent generated UUID
Ce-Source: https://console-api.enforce.dev/registry/v1/tags
Ce-Specversion: 1.0
Ce-Subject: The identifier of this specific tag
Ce-Time: 2024-06-04T22:20:29.133348588Z
Ce-Time: 2024-11-13T00:36:15.620844544Z
Ce-Type: dev.chainguard.api.platform.registry.tag.deleted.v1
Content-Length: 109
Content-Type: application/json
Expand Down
20 changes: 11 additions & 9 deletions content/chainguard/chainctl/chainctl-docs/chainctl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-06-04T22:20:27Z
date: 2024-11-13T00:36:09Z
title: "chainctl"
slug: chainctl
url: /chainguard/chainctl/chainctl-docs/chainctl/
Expand All @@ -20,14 +20,16 @@ chainctl [flags]
### Options

```
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.enforce.dev")
-h, --help help for chainctl
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.chainguard.dev")
--force-color Force color output even when stdout is not a TTY.
-h, --help help for chainctl
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
--log-level string Set the log level (debug, info) (default "ERROR")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
```

### SEE ALSO
Expand Down
18 changes: 10 additions & 8 deletions content/chainguard/chainctl/chainctl-docs/chainctl_auth.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-06-04T22:20:27Z
date: 2024-11-13T00:36:09Z
title: "chainctl auth"
slug: chainctl_auth
url: /chainguard/chainctl/chainctl-docs/chainctl_auth/
Expand All @@ -22,13 +22,15 @@ Auth related commands for the Chainguard platform.
### Options inherited from parent commands

```
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.enforce.dev")
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.chainguard.dev")
--force-color Force color output even when stdout is not a TTY.
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
--log-level string Set the log level (debug, info) (default "ERROR")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
```

### SEE ALSO
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-06-04T22:20:27Z
date: 2024-11-13T00:36:09Z
title: "chainctl auth configure-docker"
slug: chainctl_auth_configure-docker
url: /chainguard/chainctl/chainctl-docs/chainctl_auth_configure-docker/
Expand Down Expand Up @@ -35,13 +35,15 @@ chainctl auth configure-docker [flags]
### Options inherited from parent commands

```
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.enforce.dev")
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
--api string The url of the Chainguard platform API. (default "https://console-api.enforce.dev")
--audience string The Chainguard token audience to request. (default "https://console-api.enforce.dev")
--config string A specific chainctl config file. Uses CHAINCTL_CONFIG environment variable if a file is not passed explicitly.
--console string The url of the Chainguard platform Console. (default "https://console.chainguard.dev")
--force-color Force color output even when stdout is not a TTY.
--issuer string The url of the Chainguard STS endpoint. (default "https://issuer.enforce.dev")
--log-level string Set the log level (debug, info) (default "ERROR")
-o, --output string Output format. One of: ["", "json", "id", "table", "terse", "tree", "wide"]
-v, --v int Set the log verbosity level.
```

### SEE ALSO
Expand Down
Loading

0 comments on commit cb10ae0

Please sign in to comment.