OS Manuals

/usr/bin/kine

Run Kubernetes on MySQL, Postgres, sqlite, dqlite, not etcd.

From kine 0.17.5-r0 (os), captured 2026-11-06 by running kine --help (exit 0). permalink

NAME:
   kine - Minimal etcd v3 API to support custom Kubernetes storage engines

USAGE:
   kine [global options] command [command options]

VERSION:
   v0.17.5 (f82bd25)

COMMANDS:
   help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --listen-address value                      Address to listen on for connections from etcd clients. (default: "0.0.0.0:2379") [$KINE_LISTEN_ADDRESS]
   --endpoint value                            Storage endpoint (default is sqlite). [$KINE_ENDPOINT]
   --ca-file value                             CA cert for DB connection. [$KINE_CA_FILE]
   --cert-file value                           Certificate for DB connection. [$KINE_CERT_FILE]
   --key-file value                            Key file for DB connection. [$KINE_KEY_FILE]
   --skip-verify                               Whether the TLS client should verify the server certificate. (default: false) [$KINE_SKIP_VERIFY]
   --log-format value                          Log format to use; options are 'plain' or 'json'. (default: "plain") [$KINE_LOG_FORMAT]
   --metrics-bind-address value                The address the metric endpoint binds to. Default :8080, set 0 to disable metrics serving. (default: ":8080") [$KINE_METRICS_BIND_ADDRESS]
   --server-cert-file value                    Certificate for etcd connection. [$KINE_SERVER_CERT_FILE]
   --server-key-file value                     Key file for etcd connection. [$KINE_SERVER_KEY_FILE]
   --trusted-ca-file value                     CA certificate for verifying client certificates. [$KINE_TRUSTED_CA_FILE]
   --datastore-max-idle-connections value      Maximum number of idle connections retained by datastore. If value = 0, the system default will be used. If value < 0, idle connections will not be reused. (default: 20) [$KINE_DATASTORE_MAX_IDLE_CONNECTIONS]
   --datastore-max-open-connections value      Maximum number of open connections used by datastore. If value <= 0, then there is no limit. (default: 0) [$KINE_DATASTORE_MAX_OPEN_CONNECTIONS]
   --datastore-connection-max-lifetime value   Maximum amount of time a connection may be reused. If value <= 0, then there is no limit. (default: 0s) [$KINE_DATASTORE_CONNECTION_MAX_LIFETIME]
   --datastore-connection-max-idle-time value  Maximum amount of time a connection may remain idle before being closed. If value <= 0, then there is no limit. (default: 2m0s) [$KINE_DATASTORE_CONNECTION_MAX_IDLE_TIME]
   --datastore-poll-interval value             Interval between datastore polls when no local inserts have occurred. Default is 1s, but can be reduced to improve responsiveness at the cost of increased query count at idle. (default: 1s) [$KINE_DATASTORE_POLL_INTERVAL]
   --slow-sql-threshold value                  The duration which SQL executed longer than will be logged at level info. Default 1s, set <= 0 to disable slow SQL log. (default: 1s) [$KINE_SLOW_SQL_THRESHOLD]
   --slow-sql-warning-threshold value          The duration which SQL executed longer than will be logged at level warn. Default 5s. (default: 5s) [$KINE_SLOW_SQL_WARNING_THRESHOLD]
   --metrics-enable-profiling                  Enable net/http/pprof handlers on the metrics bind address. Default is false. (default: false) [$KINE_METRICS_ENABLE_PROFILING]
   --metrics-ignore-tls-config                 Ignore TLS config for metrics server. Default is false. (default: false) [$KINE_METRICS_IGNORE_TLS_CONFIG]
   --watch-progress-notify-interval value      Interval between periodic watch progress notifications. Default is 5s to ensure support for watch progress notifications. (default: 5s) [$KINE_WATCH_PROGRESS_NOTIFY_INTERVAL]
   --emulated-etcd-version value               The emulated etcd version to return on a call to the status endpoint. Defaults to 3.6.11, in order to indicate support for watch progress notifications. (default: "3.6.11") [$KINE_EMULATED_ETCD_VERSION]
   --compact-interval value                    Interval between automatic compaction. Default is off so that compact may be managed by the apiserver. (default: 0s) [$KINE_COMPACT_INTERVAL]
   --compact-interval-jitter value             Percentage of jitter to apply to interval durations. A value of 10 will apply a jitter of +/-10 percent to the interval duration. It cannot be negative, and must be less than 100. Default is 0. (default: 0) [$KINE_COMPACT_INTERVAL_JITTER]
   --compact-timeout value                     Timeout for automatic compaction. Default is 5s. (default: 5s) [$KINE_COMPACT_TIMEOUT]
   --compact-min-retain value                  Minimum number of revisions to retain when compacting. Default is 1000. (default: 1000) [$KINE_COMPACT_MIN_RETAIN]
   --compact-batch-size value                  Number of revisions to compact in a single batch. Default is 1000. (default: 1000) [$KINE_COMPACT_BATCH_SIZE]
   --poll-batch-size value                     Number of revisions to poll in a single batch. Default is 500. (default: 500) [$KINE_POLL_BATCH_SIZE]
   --peer-bind-address value                   gRPC listen address (host:port) for the t4 peer WAL-streaming server. Empty means single-node mode. Example: 0.0.0.0:3380. [$KINE_PEER_BIND_ADDRESS]
   --peer-advertise-address value              Address other t4 nodes use to reach this node's peer server. Defaults to --peer-bind-address. [$KINE_PEER_ADVERTISE_ADDRESS]
   --s3-bucket value                           S3 bucket for the t4 driver. Empty means local-only (no S3 durability). [$KINE_S3_BUCKET]
   --s3-folder value                           Optional key prefix inside the t4 driver's S3 bucket. [$KINE_S3_FOLDER]
   --s3-endpoint value                         Custom S3-compatible endpoint URL for the t4 driver (MinIO, Ceph, etc.). [$KINE_S3_ENDPOINT]
   --s3-region value                           AWS region for the t4 driver. Default is us-east-1. [$AWS_REGION, $AWS_DEFAULT_REGION]
   --s3-access-key value                       Static S3 access key for the t4 driver. Must be set together with --s3-secret-key. [$AWS_ACCESS_KEY_ID]
   --s3-secret-key value                       Static S3 secret key for the t4 driver. [$AWS_SECRET_ACCESS_KEY]
   --s3-session-token value                    Optional S3 session token for the t4 driver (for temporary STS credentials). Used only when --s3-access-key is also set. [$AWS_SESSION_TOKEN]
   --s3-profile value                          AWS profile name to engage the ambient AWS credentials chain for the t4 driver (env vars, ~/.aws/credentials, IMDS). Ignored when --s3-access-key is set. [$AWS_PROFILE]
   --s3-ca-bundle value                        Path to a PEM CA bundle used to trust HTTPS S3 endpoints for the t4 driver. Useful for MinIO behind a private CA. [$AWS_CA_BUNDLE]
   --debug                                     Enable debug logging to stdout. (default: false) [$KINE_DEBUG]
   --help, -h                                  show help
   --version, -v                               print the version
Options (42)
OptionDescriptionSource
--listen-address valueAddress to listen on for connections from etcd clients.help
--endpoint valueStorage endpoint (default is sqlite).help
--ca-file valueCA cert for DB connection.help
--cert-file valueCertificate for DB connection.help
--key-file valueKey file for DB connection.help
--skip-verifyWhether the TLS client should verify the server certificate.help
--log-format valueLog format to use;help
--metrics-bind-address valueThe address the metric endpoint binds to.help
--server-cert-file valueCertificate for etcd connection.help
--server-key-file valueKey file for etcd connection.help
--trusted-ca-file valueCA certificate for verifying client certificates.help
--datastore-max-idle-connections valueMaximum number of idle connections retained by datastore.help
--datastore-max-open-connections valueMaximum number of open connections used by datastore.help
--datastore-connection-max-lifetime valueMaximum amount of time a connection may be reused.help
--datastore-connection-max-idle-time valueMaximum amount of time a connection may remain idle before being closed.help
--datastore-poll-interval valueInterval between datastore polls when no local inserts have occurred.help
--slow-sql-threshold valueThe duration which SQL executed longer than will be logged at level info.help
--slow-sql-warning-threshold valueThe duration which SQL executed longer than will be logged at level warn.help
--metrics-enable-profilingEnable net/http/pprof handlers on the metrics bind address.help
--metrics-ignore-tls-configIgnore TLS config for metrics server.help
--watch-progress-notify-interval valueInterval between periodic watch progress notifications.help
--emulated-etcd-version valueThe emulated etcd version to return on a call to the status endpoint.help
--compact-interval valueInterval between automatic compaction.help
--compact-interval-jitter valuePercentage of jitter to apply to interval durations.help
--compact-timeout valueTimeout for automatic compaction.help
--compact-min-retain valueMinimum number of revisions to retain when compacting.help
--compact-batch-size valueNumber of revisions to compact in a single batch.help
--poll-batch-size valueNumber of revisions to poll in a single batch.help
--peer-bind-address valuegRPC listen address (host:port) for the t4 peer WAL-streaming server.help
--peer-advertise-address valueAddress other t4 nodes use to reach this node's peer server.help
--s3-bucket valueS3 bucket for the t4 driver.help
--s3-folder valueOptional key prefix inside the t4 driver's S3 bucket.help
--s3-endpoint valueCustom S3-compatible endpoint URL for the t4 driver (MinIO, Ceph, etc.).help
--s3-region valueAWS region for the t4 driver.help
--s3-access-key valueStatic S3 access key for the t4 driver.help
--s3-secret-key valueStatic S3 secret key for the t4 driver.help
--s3-session-token valueOptional S3 session token for the t4 driver (for temporary STS credentials).help
--s3-profile valueAWS profile name to engage the ambient AWS credentials chain for the t4 driver (env vars, ~/.aws/credentials, IMDS).help
--s3-ca-bundle valuePath to a PEM CA bundle used to trust HTTPS S3 endpoints for the t4 driver.help
--debugEnable debug logging to stdout.help
--help, -hshow helphelp
--version, -vprint the versionhelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.