Skip to content

Commit

Permalink
added zed docs
Browse files Browse the repository at this point in the history
Signed-off-by: Kartikay <kartikay_2101ce32@iitp.ac.in>
  • Loading branch information
kartikaysaxena committed Jan 17, 2025
1 parent c8cd78e commit 137812f
Show file tree
Hide file tree
Showing 37 changed files with 1,437 additions and 1 deletion.
4 changes: 4 additions & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,9 @@
"authzed": {
"title": "AuthZed Product Documentation",
"type": "page"
},
"zed": {
"title": "Zed Documentation",
"type": "page"
}
}
5 changes: 4 additions & 1 deletion pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#

Browse documentation for **SpiceDB** or **AuthZed Products** by selecting one below.
Browse documentation for **SpiceDB**, **AuthZed Products** or **Zed** by selecting one below.

import { Cards } from 'nextra/components'

Expand All @@ -16,4 +16,7 @@ import { Cards } from 'nextra/components'
<Cards.Card image arrow title="View" href="authzed/guides/picking-a-product">
<div className="p-4"><h3>AuthZed Products Documentation</h3></div>
</Cards.Card>
<Cards.Card image arrow title="View" href="zed/zed">
<div className="p-4"><h3>Zed Documentation</h3></div>
</Cards.Card>
</Cards>
39 changes: 39 additions & 0 deletions pages/zed/zed.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## zed

SpiceDB client, by AuthZed

### Synopsis

A command-line client for managing SpiceDB clusters, built by AuthZed

### Options

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
-h, --help help for zed
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups
* [zed context](zed_context.md) - Manage configurations for connecting to SpiceDB deployments
* [zed import](zed_import.md) - Imports schema and relationships from a file or url
* [zed permission](zed_permission.md) - Query the permissions in a permissions system
* [zed relationship](zed_relationship.md) - Query and mutate the relationships in a permissions system
* [zed schema](zed_schema.md) - Manage schema for a permissions system
* [zed use](zed_use.md) - Alias for `zed context use`
* [zed validate](zed_validate.md) - Validates the given validation file (.yaml, .zaml) or schema file (.zed)
* [zed version](zed_version.md) - Display zed and SpiceDB version information

###### Auto generated by spf13/cobra on 17-Jan-2025
44 changes: 44 additions & 0 deletions pages/zed/zed_backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## zed backup

Create, restore, and inspect permissions system backups

```
zed backup <filename> [flags]
```

### Options

```
-h, --help help for backup
--prefix-filter string include only schema and relationships with a given prefix
--rewrite-legacy potentially modify the schema to exclude legacy/broken syntax
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed](zed.md) - SpiceDB client, by AuthZed
* [zed backup create](zed_backup_create.md) - Backup a permission system to a file
* [zed backup parse-relationships](zed_backup_parse-relationships.md) - Extract the relationships from a backup file
* [zed backup parse-revision](zed_backup_parse-revision.md) - Extract the revision from a backup file
* [zed backup parse-schema](zed_backup_parse-schema.md) - Extract the schema from a backup file
* [zed backup redact](zed_backup_redact.md) - Redact a backup file to remove sensitive information
* [zed backup restore](zed_backup_restore.md) - Restore a permission system from a file

###### Auto generated by spf13/cobra on 17-Jan-2025
38 changes: 38 additions & 0 deletions pages/zed/zed_backup_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## zed backup create

Backup a permission system to a file

```
zed backup create <filename> [flags]
```

### Options

```
-h, --help help for create
--prefix-filter string include only schema and relationships with a given prefix
--rewrite-legacy potentially modify the schema to exclude legacy/broken syntax
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups

###### Auto generated by spf13/cobra on 17-Jan-2025
37 changes: 37 additions & 0 deletions pages/zed/zed_backup_parse-relationships.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
## zed backup parse-relationships

Extract the relationships from a backup file

```
zed backup parse-relationships <filename> [flags]
```

### Options

```
-h, --help help for parse-relationships
--prefix-filter string Include only relationships with a given prefix
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups

###### Auto generated by spf13/cobra on 17-Jan-2025
36 changes: 36 additions & 0 deletions pages/zed/zed_backup_parse-revision.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## zed backup parse-revision

Extract the revision from a backup file

```
zed backup parse-revision <filename> [flags]
```

### Options

```
-h, --help help for parse-revision
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups

###### Auto generated by spf13/cobra on 17-Jan-2025
38 changes: 38 additions & 0 deletions pages/zed/zed_backup_parse-schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## zed backup parse-schema

Extract the schema from a backup file

```
zed backup parse-schema <filename> [flags]
```

### Options

```
-h, --help help for parse-schema
--prefix-filter string include only schema and relationships with a given prefix
--rewrite-legacy potentially modify the schema to exclude legacy/broken syntax
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups

###### Auto generated by spf13/cobra on 17-Jan-2025
40 changes: 40 additions & 0 deletions pages/zed/zed_backup_redact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## zed backup redact

Redact a backup file to remove sensitive information

```
zed backup redact <filename> [flags]
```

### Options

```
-h, --help help for redact
--print-redacted-object-ids prints the redacted object IDs
--redact-definitions redact definitions (default true)
--redact-object-ids redact object IDs (default true)
--redact-relations redact relations (default true)
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups

###### Auto generated by spf13/cobra on 17-Jan-2025
43 changes: 43 additions & 0 deletions pages/zed/zed_backup_restore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
## zed backup restore

Restore a permission system from a file

```
zed backup restore <filename> [flags]
```

### Options

```
--batch-size uint restore relationship write batch size (default 1000)
--batches-per-transaction uint number of batches per transaction (default 10)
--conflict-strategy string strategy used when a conflicting relationship is found. Possible values: fail, skip, touch (default "fail")
--disable-retries retries when an errors is determined to be retryable (e.g. serialization errors)
-h, --help help for restore
--prefix-filter string include only schema and relationships with a given prefix
--request-timeout duration timeout for each request performed during restore (default 30s)
--rewrite-legacy potentially modify the schema to exclude legacy/broken syntax
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed backup](zed_backup.md) - Create, restore, and inspect permissions system backups

###### Auto generated by spf13/cobra on 17-Jan-2025
36 changes: 36 additions & 0 deletions pages/zed/zed_context.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## zed context

Manage configurations for connecting to SpiceDB deployments

### Options

```
-h, --help help for context
```

### Options inherited from parent commands

```
--certificate-path string path to certificate authority used to verify secure connections
--endpoint string spicedb gRPC API endpoint
--hostname-override string override the hostname used in the connection to the endpoint
--insecure connect over a plaintext connection
--log-format string format of logs ("auto", "console", "json") (default "auto")
--log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info")
--max-message-size int maximum size *in bytes* (defaults to 4_194_304 bytes ~= 4MB) of a gRPC message that can be sent or received by zed
--no-verify-ca do not attempt to verify the server's certificate chain and host name
--permissions-system string permissions system to query
--request-id string optional id to send along with SpiceDB requests for tracing
--skip-version-check if true, no version check is performed against the server
--token string token used to authenticate to SpiceDB
```

### SEE ALSO

* [zed](zed.md) - SpiceDB client, by AuthZed
* [zed context list](zed_context_list.md) - Lists all available contexts
* [zed context remove](zed_context_remove.md) - Removes a context
* [zed context set](zed_context_set.md) - Creates or overwrite a context
* [zed context use](zed_context_use.md) - Sets a context as the current context

###### Auto generated by spf13/cobra on 17-Jan-2025
Loading

0 comments on commit 137812f

Please sign in to comment.