README
¶
KubeDB
KubeDB is a command to interact with databases running in Kubernetes. It supports dumping, restoring, and dropping into a database shell. Optional flags are available to set running database parameters (see each command's help entry for more details). If no flags are given, KubeDB will inspect the pod configuration and attempt to configure itself via the Kubernetes EnvVar API.
Installation
Homebrew (macOS, Linux)
Click to expand
brew install clevyr/tap/kubedb
APT Repository (Ubuntu, Debian)
Click to expand
-
If you don't have it already, install the
ca-certificatespackagesudo apt install ca-certificates -
Add Clevyr's apt repository
echo 'deb [trusted=yes] https://apt.clevyr.com /' | sudo tee /etc/apt/sources.list.d/clevyr.list -
Update apt repositories
sudo apt update -
Install KubeDB
sudo apt install kubedb
RPM Repository (CentOS, RHEL)
Click to expand
-
If you don't have it already, install the
ca-certificatespackagesudo yum install ca-certificates -
Add Clevyr's rpm repository to
/etc/yum.repos.d/clevyr.repo[clevyr] name=Clevyr baseurl=https://rpm.clevyr.com enabled=1 gpgcheck=0 -
Install KubeDB
sudo yum install kubedb
KubeDB requires an existing Kubeconfig. See below for details.
Usage
View the generated docs for usage information.
Connecting to GKE
-
To connect to a Kubernetes cluster running in GKE, ensure you have the
gcloudcommand installed. If you have it then skip to step 2.
Otherwise, you can either take a look at GCP's install doc, or run:brew install google-cloud-sdk gcloud init -
Then to generate a Kubeconfig, run:
gcloud container clusters get-credentials --project=PROJECT CLUSTER_NAME -
If you don’t encounter any errors then you should be connected and ready to work with databases! To verify, type in the following command and press the tab key twice:
kubedb exec -n <TAB><TAB>All of your current namespaces should show up in your shell. Many of the KubeDB flags support tab completion.
Documentation
¶
There is no documentation for this package.
Source Files
Directories