Tear Down a Package
This page explains how to tear down a package in kdb Insights Enterprise using the CLI.
The teardown
command enables you to:
- Terminate packages in
RUNNING
state, and take the databases and pipelines offline. - [Optionally] Remove persistent application data from disk.
The teardown
command can take the name or id of the package deployed on kdb Insights Enterprise. If the package is found and in a running state, it is taken offline.
It can be run as follows:
kxi pm teardown mypackage
You can use the help command to provide information regarding the additional options
Usage: kxi pm teardown [OPTIONS] PACKAGE
Teardown a deployed package running on an insights instance
╭─ Authentication option overrides ────────────────────────────────────────────╮
│ --hostname,--url TEXT Insights URL │
│ --realm TEXT Realm │
│ --client-id TEXT Client id │
│ --client-secret TEXT Client secret │
│ --auth-enabled/--auth-disabled Retrieve Bearer Token │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --rm-data Remove the data associated with the │
│ deployment │
│ --output-format -o [json|table] Output format for the list command │
│ --server-timeout TEXT Timeout for Insights server calls │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────╯
Using the web interface or the CLI
kdb Insights Enterprise has both a web interface and command line interface (CLI). You can use either one to tear down a package. For information on how to tear down packages using the web interface, refer to the web interface documentation.