diff --git a/app/spicedb/concepts/commands/page.mdx b/app/spicedb/concepts/commands/page.mdx index 939f3df..8fd57da 100644 --- a/app/spicedb/concepts/commands/page.mdx +++ b/app/spicedb/concepts/commands/page.mdx @@ -27,12 +27,13 @@ A database that stores and computes permissions ### Children commands -- [spicedb datastore](#reference-spicedb-datastore) - datastore operations -- [spicedb lsp](#reference-spicedb-lsp) - serve language server protocol -- [spicedb man](#reference-spicedb-man) - Generate man page -- [spicedb serve](#reference-spicedb-serve) - serve the permissions database -- [spicedb serve-testing](#reference-spicedb-serve-testing) - test server with an in-memory datastore -- [spicedb version](#reference-spicedb-version) - displays the version of SpiceDB +- [spicedb datastore](#reference-spicedb-datastore) - datastore operations +- [spicedb lsp](#reference-spicedb-lsp) - serve language server protocol +- [spicedb man](#reference-spicedb-man) - Generate man page +- [spicedb serve](#reference-spicedb-serve) - serve the permissions database +- [spicedb serve-testing](#reference-spicedb-serve-testing) - test server with an in-memory datastore +- [spicedb version](#reference-spicedb-version) - displays the version of SpiceDB + ## Reference: `spicedb datastore` @@ -48,10 +49,11 @@ Operations against the configured datastore ### Children commands -- [spicedb datastore gc](#reference-spicedb-datastore-gc) - executes garbage collection -- [spicedb datastore head](#reference-spicedb-datastore-head) - compute the head (latest) database migration revision available -- [spicedb datastore migrate](#reference-spicedb-datastore-migrate) - execute datastore schema migrations -- [spicedb datastore repair](#reference-spicedb-datastore-repair) - executes datastore repair +- [spicedb datastore gc](#reference-spicedb-datastore-gc) - executes garbage collection +- [spicedb datastore head](#reference-spicedb-datastore-head) - compute the head (latest) database migration revision available +- [spicedb datastore migrate](#reference-spicedb-datastore-migrate) - execute datastore schema migrations +- [spicedb datastore repair](#reference-spicedb-datastore-repair) - executes datastore repair + ## Reference: `spicedb datastore gc` @@ -146,6 +148,8 @@ spicedb datastore gc [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb datastore head` compute the head (latest) database migration revision available @@ -177,6 +181,8 @@ spicedb datastore head [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb datastore migrate` Executes datastore schema migrations for the datastore. @@ -216,6 +222,8 @@ spicedb datastore migrate [revision] [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb datastore repair` Executes a repair operation for the datastore @@ -309,6 +317,8 @@ spicedb datastore repair [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb lsp` serve language server protocol @@ -332,10 +342,12 @@ spicedb lsp [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb man` Generate a man page for SpiceDB. -The output can be redirected to a file and installed to the system: + The output can be redirected to a file and installed to the system: ``` spicedb man > spicedb.1 @@ -343,6 +355,7 @@ The output can be redirected to a file and installed to the system: sudo mandb # Update man page database ``` + ``` spicedb man ``` @@ -355,6 +368,8 @@ spicedb man --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb serve` start a SpiceDB server @@ -473,6 +488,7 @@ spicedb serve [flags] --dispatch-upstream-ca-path string local path to the TLS CA used when connecting to the dispatch cluster --dispatch-upstream-timeout duration maximum duration of a dispatch call an upstream cluster before it times out (default 1m0s) --enable-experimental-watchable-schema-cache enables the experimental schema cache, which uses the Watch API to keep the schema up to date + --enable-memory-protection-middleware enables middleware that does a best effort at preventing OOM (Out of Memory) if the server's memory usage is too high by returning ResourceExhausted on incoming requests (default true) --enable-performance-insight-metrics enables performance insight metrics, which are used to track the latency of API calls by shape --enable-revision-heartbeat enables support for revision heartbeat, used to create a synthetic revision on an interval defined by the quantization window (Postgres driver only) (default true) --experimental-dispatch-secondary-maximum-primary-hedging-delays stringToString maximum number of hedging delays to use for each request type to delay the primary request. default is 5ms (default []) @@ -487,7 +503,7 @@ spicedb serve [flags] --grpc-max-workers uint32 set the number of workers for this server (0 value means 1 worker per request) --grpc-network string network type to serve gRPC ("tcp", "tcp4", "tcp6", "unix", "unixpacket") (default "tcp") --grpc-preshared-key strings (required) preshared key(s) that must be provided by clients to authenticate requests - --grpc-shutdown-grace-period duration amount of time after receiving sigint to continue serving + --grpc-shutdown-grace-period duration time limit given to the server to shutdown gracefully after it receives SIGINT or SIGTERM. A value of zero means no limit --grpc-tls-cert-path string local path to the TLS certificate used to serve gRPC --grpc-tls-key-path string local path to the TLS key used to serve gRPC --http-addr string address to listen on to serve proxy (default ":8443") @@ -542,6 +558,8 @@ spicedb serve [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb serve-testing` An in-memory spicedb server which serves completely isolated datastores per client-supplied auth token used. @@ -603,6 +621,8 @@ spicedb serve-testing [flags] --skip-release-check if true, skips checking for new SpiceDB releases ``` + + ## Reference: `spicedb version` displays the version of SpiceDB @@ -624,3 +644,6 @@ spicedb version [flags] --log-level string verbosity of logging ("trace", "debug", "info", "warn", "error") (default "info") --skip-release-check if true, skips checking for new SpiceDB releases ``` + + +