oh dataplane
Onboard and manage a GENERIC_K8S data plane on a customer-run Kubernetes cluster with S3-compatible storage. Every subcommand accepts --org ORG_ID to override the profile's project_uid.
Install the storage-check dependencies before running storage connect or storage rotate:
pip install 'onehouse-cli[dataplane]'
Inspect and configure
| Command | Result |
|---|---|
oh dataplane describe --org ORG_ID | Show organization, storage, settings, and workflow state without secrets. |
oh dataplane validate-storage --org ORG_ID | Ask Onehouse to validate the registered storage credentials. |
oh dataplane node-types --org ORG_ID | List node types offered by the connected cluster. |
oh dataplane status --org ORG_ID | Show the provisioning workflow and dp-connect status. |
oh dataplane storage status --org ORG_ID | Show registered storage and bucket name without secrets. |
describe, validate-storage, and node-types accept --show-sql. status and storage status do not.
Set data plane settings
set changes only the settings supplied. Give at least one setting; passing the same key through a named flag and --options is an error.
| Flag | Description |
|---|---|
--zookeeper-servers HOST:PORT[,HOST:PORT] | Comma-separated ZooKeeper servers. |
--storage-class NAME | Storage class for ZooKeeper volumes. Pass '' to use the cluster default. |
--options KEY=VALUE | Another supported setting; repeatable. |
--show-sql | Print the SQL without applying it. |
oh dataplane set --org ORG_ID --zookeeper-servers zk-0.example.com:2181,zk-1.example.com:2181
Connect or rotate storage
oh dataplane storage connect --org ORG_ID checks the S3-compatible endpoint, credentials, bucket access, and a put/read/list/delete probe before it registers the key. It opens a local browser form by default. The secret key stays in the oh process and is not printed or written to disk. storage rotate runs the same checks for a replacement key and requires storage to be registered already.
| Flag | Description |
|---|---|
--bucket-mode create|existing | connect defaults to create; rotate defaults to existing. existing requires the bucket to exist. |
--no-browser | Print the form URL instead of opening a browser. |
--port N | Pin the local form port, for example when using an SSH forward. |
--tty | Prompt in the terminal with the secret hidden. |
--from-aws-profile NAME | Read credentials and any configured endpoint and region from an AWS profile. |
--from-env | Read ONEHOUSE_S3_ACCESS_KEY_ID and ONEHOUSE_S3_SECRET_ACCESS_KEY; intended for CI. |
--endpoint URL | S3 endpoint; also read from ONEHOUSE_S3_ENDPOINT. |
--region NAME | Signing region; also read from ONEHOUSE_S3_REGION. |
Choose at most one of --tty, --from-aws-profile, and --from-env. --no-browser and --port apply only to the browser form. A failed storage check exits with an error and does not register the key.
oh dataplane storage connect --org ORG_ID --tty
oh dataplane storage rotate --org ORG_ID --from-aws-profile my-storage-profile
Provision and tear down
template writes the byok-dp-connect Helm values to a file with mode 0600. The file contains credentials; the command prints its location and chart details, not its contents. --s3-endpoint overrides the registered S3 endpoint for the template.
oh dataplane template --org ORG_ID --out values.yaml
oh dataplane create --org ORG_ID --wait
oh dataplane status --org ORG_ID
create starts provisioning. --wait polls until the workflow succeeds, fails, or reaches the global --timeout limit. create accepts --show-sql when you want to preview the statement.
drop starts data plane teardown immediately without a confirmation prompt. Use --show-sql to preview the statement; --wait polls for the teardown result.
oh dataplane drop --org ORG_ID --show-sql