Install
Download the current development version of kd:
Windows
If the KUBECONFIG
environment is
not set, kd will default to using
%USERPROFILE%/.kube/config.yaml
. If
you want to set an alternatively KUBECONFIG, you
will need to set your KUBECONFIG
environment variable.
Navigate to the kd executable using File Explorer and Open.
Linux
Make kd executable:
$ chmod a+x ./kd-linux-amd64-v0.3
If the KUBECONFIG
environment is
not set, kd will default to using
${HOME}/.kube/config.yaml
. If you
want to set an alternatively KUBECONFIG, export
KUBECONFIG
. Example:
$ export KUBECONFIG="${HOME}/cluster.yaml"
Run kd:
$ ./kd-linux-amd64-v0.3
Clusters
The sidebar display the list of Clusters that
are configured within KUBECONFIG
.
Selecting a Cluster will make it active.
Workloads
Deployments
Select Deployments within the sidebar to display all Deployments for the selected Cluster.
The Search Bar within the Deployments Table in the middle pane provides support for filtering the list of Deployments. The following Search Bar queries are supported:
name
:- Search for Deployments with a name. Example:
name:db
- Search for Deployments with a name. Example:
namespace
:- Search for Deployments within a namespace.
Example:
namespace:cert-manager
- Search for Deployments within a namespace.
Example:
Search queries which are not prefixed with a
key (i.e. name:
) will default to
searching Deployments by name.
Deployments can be restarted by right clicking the Deployment within the Deployments List pane and selecting “Restart”.
StatefulSets
Select StatefulSets within the sidebar to display all StatefulSets for the selected Cluster.
The Search Bar within the StatefulSets Table provides support for filtering the list of StatefulSets.
The following Search Bar queries are supported for StatefulSets:
name
:- Search for StatefulSets with a name.
Example:
name:db
- Search for StatefulSets with a name.
Example:
namespace
:- Search for StatefulSets within a namespace.
Example:
namespace:postgres-db
- Search for StatefulSets within a namespace.
Example:
Search queries which are not prefixed with a
key (i.e. name:
) will default to
searching StateFulSets by name.
StatefulSets can be restarted by right clicking the StatefulSet within the StatefulSet List pane and selecting “Restart”.
Pods
Select Pods within the sidebar to display all Pods for the selected Cluster.
The Search Bar within the Pods Table in the middle pane provides support for filtering the list of Pods. The following Search Bar queries are supported:
name
:- Search for Pods with a name. Example:
name:main
- Search for Pods with a name. Example:
namespace
:- Search for Pods within a namespace. Example:
namespace:kube-system
- Search for Pods within a namespace. Example:
status
:- Search for Pods with a status. Example:
status:failed
- Search for Pods with a status. Example:
label
:- Search for Pods with a label. Example:
label:app.kubernetes.io/name=prometheus
- Search for Pods with a label. Example:
Pods can be deleted by right clicking the Pod within the Pod List pane and selecting “Delete”.
Configuration
ConfigMaps
Select ConfigMaps within the sidebar under Configuration to display all ConfigMaps for the selected Cluster.
The Search Bar provides support for filtering for ConfigMaps:
name
:- Search for ConfigMaps with a name. Example:
name:grafana
- Search for ConfigMaps with a name. Example:
namespace
:- Search for ConfigMaps within a namespace.
Example:
namespace:kube-system
- Search for ConfigMaps within a namespace.
Example:
Search queries which are not prefixed with a
key (i.e. name:
) will default to
searching ConfigMaps by name.
Networking
Ingress
Select Ingress within the sidebar under Networking to display all Ingresses for the selected Cluster.
The Search Bar provides support for filtering for Ingresses:
name
:- Search for Ingresses with a name. Example:
name: prometheus
- Search for Ingresses with a name. Example:
namespace
:- Search for Ingresses within a namespace.
Example:
namespace:web
- Search for Ingresses within a namespace.
Example:
class
:- Search for Ingresses with an Ingress Class
name. Example:
class: nginx
- Search for Ingresses with an Ingress Class
name. Example:
Search queries which are not prefixed with a
key (i.e. name:
) will default to
searching Ingresses by name.
Ingresses can be deleted by right clicking the Ingress within the Ingress List pane and selecting “Delete”.