Skip to content

Commit

Permalink
Merge pull request #1392 from chainguard-dev/autodocs
Browse files Browse the repository at this point in the history
Enforce docs  autocommit
  • Loading branch information
SharpRake authored Feb 27, 2024
2 parents 840a2b2 + d4cf53f commit ec38d73
Show file tree
Hide file tree
Showing 109 changed files with 200 additions and 197 deletions.
112 changes: 56 additions & 56 deletions content/chainguard/administration/cloudevents/events-reference.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion content/chainguard/chainctl/chainctl-docs/chainctl.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl"
slug: chainctl
url: /chainguard/chainctl/chainctl-docs/chainctl/
Expand Down
2 changes: 1 addition & 1 deletion content/chainguard/chainctl/chainctl-docs/chainctl_auth.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl auth"
slug: chainctl_auth
url: /chainguard/chainctl/chainctl-docs/chainctl_auth/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl auth configure-docker"
slug: chainctl_auth_configure-docker
url: /chainguard/chainctl/chainctl-docs/chainctl_auth_configure-docker/
Expand All @@ -20,13 +20,13 @@ chainctl auth configure-docker [flags]
### Options

```
--group string The IAM group with which the pull-token identity is associated.
--headless Skip browser authentication and use device flow.
-h, --help help for configure-docker
--identity string The unique ID of the identity to assume when logging in.
--identity-provider string The unique ID of the customer managed identity provider to authenticate with
--identity-token string Use an explicit passed identity token or token path.
--org-name string Organization to use for authentication. If configured the organization's custom identity provider will be used
--parent string The IAM organization or folder with which the pull-token identity is associated.
--pull-token Whether to register a pull token that can pull images
--save If true with --pull-token, save the pull token to the Docker config
--ttl duration For how long a generated pull-token will be valid. (default 720h0m0s)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl auth login"
slug: chainctl_auth_login
url: /chainguard/chainctl/chainctl-docs/chainctl_auth_login/
Expand All @@ -26,10 +26,8 @@ chainctl auth login [--invite-code=INVITE_CODE | --register] [--identity-token=P
# Refreshing a token within a Kubernetes context:
chainctl auth login --identity-token=PATH_TO_TOKEN --refresh
# Register and create a new root group
chainctl auth login --register
# Register by accepting an invite to an existing group
# Register by accepting an invite to an existing location
chainctl auth login --invite-code eyJncnAiOiI5MzA...
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl auth logout"
slug: chainctl_auth_logout
url: /chainguard/chainctl/chainctl-docs/chainctl_auth_logout/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl auth status"
slug: chainctl_auth_status
url: /chainguard/chainctl/chainctl-docs/chainctl_auth_status/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters"
slug: chainctl_clusters
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters cidrs"
slug: chainctl_clusters_cidrs
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_cidrs/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters cidrs list"
slug: chainctl_clusters_cidrs_list
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_cidrs_list/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters describe"
slug: chainctl_clusters_describe
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_describe/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters install"
slug: chainctl_clusters_install
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_install/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters list"
slug: chainctl_clusters_list
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_list/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters open"
slug: chainctl_clusters_open
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_open/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters print-config"
slug: chainctl_clusters_print-config
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_print-config/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters profiles"
slug: chainctl_clusters_profiles
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_profiles/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters profiles list"
slug: chainctl_clusters_profiles_list
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_profiles_list/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters records"
slug: chainctl_clusters_records
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_records/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters records list"
slug: chainctl_clusters_records_list
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_records_list/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters records vulns"
slug: chainctl_clusters_records_vulns
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_records_vulns/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters records vulns describe"
slug: chainctl_clusters_records_vulns_describe
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_records_vulns_describe/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters records vulns list"
slug: chainctl_clusters_records_vulns_list
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_records_vulns_list/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters search"
slug: chainctl_clusters_search
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_search/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters uninstall"
slug: chainctl_clusters_uninstall
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_uninstall/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters update"
slug: chainctl_clusters_update
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_update/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters workloads"
slug: chainctl_clusters_workloads
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_workloads/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl clusters workloads list"
slug: chainctl_clusters_workloads_list
url: /chainguard/chainctl/chainctl-docs/chainctl_clusters_workloads_list/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config"
slug: chainctl_config
url: /chainguard/chainctl/chainctl-docs/chainctl_config/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config edit"
slug: chainctl_config_edit
url: /chainguard/chainctl/chainctl-docs/chainctl_config_edit/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config reset"
slug: chainctl_config_reset
url: /chainguard/chainctl/chainctl-docs/chainctl_config_reset/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config save"
slug: chainctl_config_save
url: /chainguard/chainctl/chainctl-docs/chainctl_config_save/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config set"
slug: chainctl_config_set
url: /chainguard/chainctl/chainctl-docs/chainctl_config_set/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config unset"
slug: chainctl_config_unset
url: /chainguard/chainctl/chainctl-docs/chainctl_config_unset/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config validate"
slug: chainctl_config_validate
url: /chainguard/chainctl/chainctl-docs/chainctl_config_validate/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl config view"
slug: chainctl_config_view
url: /chainguard/chainctl/chainctl-docs/chainctl_config_view/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl events"
slug: chainctl_events
url: /chainguard/chainctl/chainctl-docs/chainctl_events/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl events subscriptions"
slug: chainctl_events_subscriptions
url: /chainguard/chainctl/chainctl-docs/chainctl_events_subscriptions/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl events subscriptions create"
slug: chainctl_events_subscriptions_create
url: /chainguard/chainctl/chainctl-docs/chainctl_events_subscriptions_create/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl events subscriptions delete"
slug: chainctl_events_subscriptions_delete
url: /chainguard/chainctl/chainctl-docs/chainctl_events_subscriptions_delete/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl events subscriptions list"
slug: chainctl_events_subscriptions_list
url: /chainguard/chainctl/chainctl-docs/chainctl_events_subscriptions_list/
Expand Down
2 changes: 1 addition & 1 deletion content/chainguard/chainctl/chainctl-docs/chainctl_iam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl iam"
slug: chainctl_iam
url: /chainguard/chainctl/chainctl-docs/chainctl_iam/
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl iam account-associations"
slug: chainctl_iam_account-associations
url: /chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations/
Expand Down Expand Up @@ -35,7 +35,7 @@ Configure and manage cloud provider account associations.

* [chainctl iam](/chainguard/chainctl/chainctl-docs/chainctl_iam/) - IAM related commands for the Chainguard platform.
* [chainctl iam account-associations check](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check/) - Check the OIDC federation configurations for cloud providers.
* [chainctl iam account-associations describe](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_describe/) - Describe cloud provider account associations for a group.
* [chainctl iam account-associations set](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_set/) - Set cloud provider account associations for a group.
* [chainctl iam account-associations unset](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_unset/) - Remove cloud provider account associations from a group.
* [chainctl iam account-associations describe](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_describe/) - Describe cloud provider account associations for a location.
* [chainctl iam account-associations set](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_set/) - Set cloud provider account associations for a location.
* [chainctl iam account-associations unset](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_unset/) - Remove cloud provider account associations from a location.

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl iam account-associations check"
slug: chainctl_iam_account-associations_check
url: /chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check/
Expand Down Expand Up @@ -34,6 +34,6 @@ Check the OIDC federation configurations for cloud providers.
### SEE ALSO

* [chainctl iam account-associations](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations/) - Configure and manage cloud provider account associations.
* [chainctl iam account-associations check aws](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check_aws/) - Checks that the given group has been properly configured for OIDC federation with AWS
* [chainctl iam account-associations check gcp](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check_gcp/) - Checks that the given group has been properly configured for OIDC federation with GCP
* [chainctl iam account-associations check aws](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check_aws/) - Checks that the given location has been properly configured for OIDC federation with AWS
* [chainctl iam account-associations check gcp](/chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check_gcp/) - Checks that the given location has been properly configured for OIDC federation with GCP

Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl iam account-associations check aws"
slug: chainctl_iam_account-associations_check_aws
url: /chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check_aws/
Expand All @@ -11,10 +11,10 @@ toc: true
---
## chainctl iam account-associations check aws

Checks that the given group has been properly configured for OIDC federation with AWS
Checks that the given location has been properly configured for OIDC federation with AWS

```
chainctl iam account-associations check aws GROUP_NAME|GROUP_ID [flags]
chainctl iam account-associations check aws ORGANIZATION_NAME|ORGANIZATION_ID|FOLDER_NAME|FOLDER_ID [flags]
```

### Options
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
date: 2024-02-21T20:43:07Z
date: 2024-02-26T20:38:15Z
title: "chainctl iam account-associations check gcp"
slug: chainctl_iam_account-associations_check_gcp
url: /chainguard/chainctl/chainctl-docs/chainctl_iam_account-associations_check_gcp/
Expand All @@ -11,10 +11,10 @@ toc: true
---
## chainctl iam account-associations check gcp

Checks that the given group has been properly configured for OIDC federation with GCP
Checks that the given location has been properly configured for OIDC federation with GCP

```
chainctl iam account-associations check gcp GROUP_NAME|GROUP_ID [flags]
chainctl iam account-associations check gcp ORGANIZATION_NAME|ORGANIZATION_ID|FOLDER_NAME|FOLDER_ID [flags]
```

### Options
Expand Down
Loading

0 comments on commit ec38d73

Please sign in to comment.