Skip to main content
Version: 2.0.0

tdkserver quickstart

Initialize, create and start a tabsdata instance in one step

tdkserver quickstart \
--instance tabsdata \
--loglevel trace \
--provider kminus \
--context docker-desktop \
--kubeconfig ~/.kube/config \
--current \
--namespace tabsdata \
--port 2457 \
--reqs-td reqs_td-example \
--save true \
--details true \
--yes true \
--accept-terms yes \
--verbose \
--keep-progress true
FlagTypeRequiredDescription
--instancestringOptionalName of the instance to initialize, create and start. Defaults to 'tabsdata'.
--logleveltrace | debug | info | warn | errorOptionalLog level for the kminus orchestrator and pod runner. Defaults to 'debug'. Only valid with the 'kminus' provider.

Example: tdk quickstart --provider kminus --loglevel info | | --provider | kminus | docker | eks | fargate | Optional | Provider of the cluster: 'kminus' for a development kminus cluster, 'docker' for the Kubernetes cluster bundled with Docker Desktop on macOS/Windows, 'eks' for AWS EKS, 'fargate' for AWS EKS-on-Fargate. When unspecified, the value from the active tabsdata session is taken; when no active tabsdata session is set, this argument is required. | | --context | string | Optional | Name of the kubeconfig context to use. Valid only for the 'docker' provider. Mutually exclusive with --current. Composes with --kubeconfig. | | --kubeconfig | string | Optional | Path to a kubeconfig file. Valid only for the 'docker' provider. When unspecified, the file pointed to by the KUBECONFIG environment variable, or ~/.kube/config, is used. Composes with --context and --current. | | --current | flag | Optional | Use the current-context entry of the kubeconfig file. Valid only for the 'docker' provider. Mutually exclusive with --context. Composes with --kubeconfig. | | --namespace | string | Optional | Namespace for the instance. Valid only for the 'docker' provider. Overrides the namespace defined in the kubeconfig context. When neither is set, the kubernetes default namespace is used. | | --port | string | Optional | Base HTTP/HTTPS port. Ports for the instance services are assigned sequentially starting from this value. Defaults to 2457. | | --reqs-td | string | Optional | Complementary packages for the td virtual environment. The file replaces the empty requirements-td.txt of the initialized instance and is installed when the virtual environment is built. | | --save | true | false | Optional | Copy the cluster settings files (kubeconfig, etc.) into the instance folder so the instance is self-contained. | | --details | true | false | Optional | Show the summary of resolved values before each step. Defaults to 'true'. Pass '--details false' to skip the summaries. | | -y, --yes | true | false | Optional | Skip the interactive confirmation prompts and proceed immediately. | | --accept-terms | string | Optional | Accept or decline the license terms without interactive prompt [y/yes/n/no]. | | --verbose | flag | Optional | Show the output of each step that this command runs. | | --keep-progress | true | false | Optional | Keep the progress line of each step that this command runs, instead of clearing it when the step finishes [true/false]. Defaults to true. |