diff --git a/app/spicedb/concepts/commands/page.mdx b/app/spicedb/concepts/commands/page.mdx index 991e3abd..a2a87e9e 100644 --- a/app/spicedb/concepts/commands/page.mdx +++ b/app/spicedb/concepts/commands/page.mdx @@ -131,7 +131,7 @@ spicedb datastore gc [flags] --otel-trace-propagator string OpenTelemetry trace propagation format ("b3", "w3c", "ottrace"). Add multiple propagators separated by comma. (default "w3c") --pprof-block-profile-rate int sets the block profile sampling rate (between 0 and 1) --pprof-mutex-profile-rate int sets the mutex profile sampling rate (between 0 and 1) - --termination-log-path string local path to the termination log file, which contains a JSON payload to surface as reason for termination + --termination-log-path string local file path for Kubernetes terminationMessagePath; written with a JSON exit reason on TerminationError; disabled when empty --write-conn-acquisition-timeout duration amount of time that the server will wait for a connection to the datastore to become available when performing a write operation before throwing a ResourceExhausted error. 0 means wait indefinitely. (CockroachDB driver only) (default 30ms) ``` @@ -165,7 +165,7 @@ spicedb datastore head [flags] --otel-trace-propagator string OpenTelemetry trace propagation format ("b3", "w3c", "ottrace"). Add multiple propagators separated by comma. (default "w3c") --pprof-block-profile-rate int sets the block profile sampling rate (between 0 and 1) --pprof-mutex-profile-rate int sets the mutex profile sampling rate (between 0 and 1) - --termination-log-path string local path to the termination log file, which contains a JSON payload to surface as reason for termination + --termination-log-path string local file path for Kubernetes terminationMessagePath; written with a JSON exit reason on TerminationError; disabled when empty ``` ### Options Inherited From Parent Flags @@ -206,7 +206,7 @@ spicedb datastore migrate [revision] [flags] --otel-trace-propagator string OpenTelemetry trace propagation format ("b3", "w3c", "ottrace"). Add multiple propagators separated by comma. (default "w3c") --pprof-block-profile-rate int sets the block profile sampling rate (between 0 and 1) --pprof-mutex-profile-rate int sets the mutex profile sampling rate (between 0 and 1) - --termination-log-path string local path to the termination log file, which contains a JSON payload to surface as reason for termination + --termination-log-path string local file path for Kubernetes terminationMessagePath; written with a JSON exit reason on TerminationError; disabled when empty ``` ### Options Inherited From Parent Flags @@ -294,7 +294,7 @@ spicedb datastore repair [flags] --otel-trace-propagator string OpenTelemetry trace propagation format ("b3", "w3c", "ottrace"). Add multiple propagators separated by comma. (default "w3c") --pprof-block-profile-rate int sets the block profile sampling rate (between 0 and 1) --pprof-mutex-profile-rate int sets the mutex profile sampling rate (between 0 and 1) - --termination-log-path string local path to the termination log file, which contains a JSON payload to surface as reason for termination + --termination-log-path string local file path for Kubernetes terminationMessagePath; written with a JSON exit reason on TerminationError; disabled when empty --write-conn-acquisition-timeout duration amount of time that the server will wait for a connection to the datastore to become available when performing a write operation before throwing a ResourceExhausted error. 0 means wait indefinitely. (CockroachDB driver only) (default 30ms) ``` @@ -475,14 +475,12 @@ spicedb serve [flags] --dispatch-cache-enabled enable caching of dispatch calls this server makes to other servers (default true) --dispatch-cache-max-cost string upper bound (in bytes or as a percent of available memory) of the cache for dispatch calls this server makes to other servers (default "30%") --dispatch-cache-metrics enable metrics for the cache for dispatch calls this server makes to other servers (default true) - --dispatch-cache-num-counters int number of counters for tracking access frequency in the cache for dispatch calls this server makes to other servers. A higher number means more accurate eviction decisions but more memory usage (default 10000) --dispatch-check-permission-concurrency-limit uint16 maximum number of parallel goroutines to create for each check request or subrequest. defaults to --dispatch-concurrency-limit --dispatch-chunk-size uint16 maximum number of object IDs in a dispatched request (default 100) --dispatch-cluster-addr string address to listen on to serve dispatch (default ":50053") --dispatch-cluster-cache-enabled enable caching of dispatch calls this server receives from other servers (default true) --dispatch-cluster-cache-max-cost string upper bound (in bytes or as a percent of available memory) of the cache for dispatch calls this server receives from other servers (default "70%") --dispatch-cluster-cache-metrics enable metrics for the cache for dispatch calls this server receives from other servers (default true) - --dispatch-cluster-cache-num-counters int number of counters for tracking access frequency in the cache for dispatch calls this server receives from other servers. A higher number means more accurate eviction decisions but more memory usage (default 100000) --dispatch-cluster-enabled enable dispatch gRPC server --dispatch-cluster-max-conn-age duration how long a connection serving dispatch should be able to live (default 30s) --dispatch-cluster-max-workers uint32 set the number of workers for this server (0 value means 1 worker per request) @@ -527,7 +525,6 @@ spicedb serve [flags] --lookup-resources-chunk-cache-enabled enable caching of LookupResources3 chunks (default true) --lookup-resources-chunk-cache-max-cost string upper bound (in bytes or as a percent of available memory) of the cache for LookupResources3 chunks (default "50MiB") --lookup-resources-chunk-cache-metrics enable metrics for the cache for LookupResources3 chunks - --lookup-resources-chunk-cache-num-counters int number of counters for tracking access frequency in the cache for LookupResources3 chunks. A higher number means more accurate eviction decisions but more memory usage (default 10000) --max-bulk-export-relationships-limit uint32 maximum number of relationships that can be exported in a single request (default 10000) --max-caveat-context-size int maximum allowed size of request caveat context in bytes. A value of zero or less means no limit (default 4096) --max-datastore-read-page-size uint limit on the maximum page size that we will load into memory from the datastore at one time (default 1000) @@ -543,7 +540,6 @@ spicedb serve [flags] --ns-cache-enabled enable caching of schema (default true) --ns-cache-max-cost string upper bound (in bytes or as a percent of available memory) of the cache for schema (default "32MiB") --ns-cache-metrics enable metrics for the cache for schema (default true) - --ns-cache-num-counters int number of counters for tracking access frequency in the cache for schema. A higher number means more accurate eviction decisions but more memory usage (default 1000) --otel-endpoint string OpenTelemetry collector endpoint - the endpoint can also be set by using enviroment variables --otel-insecure connect to the OpenTelemetry collector in plaintext --otel-provider string OpenTelemetry provider for tracing ("none", "otlphttp", "otlpgrpc") (default "none") @@ -556,12 +552,11 @@ spicedb serve [flags] --stored-schema-cache-enabled enable caching of stored schema (default true) --stored-schema-cache-max-cost string upper bound (in bytes or as a percent of available memory) of the cache for stored schema (default "32MiB") --stored-schema-cache-metrics enable metrics for the cache for stored schema (default true) - --stored-schema-cache-num-counters int number of counters for tracking access frequency in the cache for stored schema. A higher number means more accurate eviction decisions but more memory usage (default 1000) --streaming-api-response-delay-timeout duration maximum time that streaming APIs (LookupSubjects, LookupResources, ReadRelationships and ExportBulkRelationships) can be allowed to run but no response be sent to the client before the stream times out (default 30s) --telemetry-ca-override-path string path to a custom CA to use with the telemetry endpoint --telemetry-endpoint string endpoint to which telemetry is reported, empty string to disable (default "https://telemetry.authzed.com") --telemetry-interval duration approximate period between telemetry reports, minimum 1 minute (default 1h0m0s) - --termination-log-path string local path to the termination log file, which contains a JSON payload to surface as reason for termination + --termination-log-path string local file path for Kubernetes terminationMessagePath; written with a JSON exit reason on TerminationError; disabled when empty --update-relationships-max-preconditions-per-call uint16 maximum number of preconditions allowed for WriteRelationships and DeleteRelationships calls (default 1000) --watch-api-heartbeat duration heartbeat time on the watch in the API. 0 means to default to the datastore's minimum. (default 1s) --write-conn-acquisition-timeout duration amount of time that the server will wait for a connection to the datastore to become available when performing a write operation before throwing a ResourceExhausted error. 0 means wait indefinitely. (CockroachDB driver only) (default 30ms) @@ -627,7 +622,7 @@ spicedb serve-testing [flags] --readonly-http-enabled enable http read-only HTTP server --readonly-http-tls-cert-path string local path to the TLS certificate used to serve read-only HTTP --readonly-http-tls-key-path string local path to the TLS key used to serve read-only HTTP - --termination-log-path string local path to the termination log file, which contains a JSON payload to surface as reason for termination + --termination-log-path string local file path for Kubernetes terminationMessagePath; written with a JSON exit reason on TerminationError; disabled when empty --update-relationships-max-preconditions-per-call uint16 maximum number of preconditions allowed for WriteRelationships and DeleteRelationships calls (default 1000) --write-relationships-max-updates-per-call uint16 maximum number of updates allowed for WriteRelationships calls (default 1000) ```