README
¶
kubesearch
Fulltext search for Kubernetes API objects
The Kubernetes API supports exact matches in order to lookup API objects. For example, the user can fetch a Pod by name or list Pods using labels. In both scenarios, the user must know exactly the name of the Pod or labels of the Pod.
Kubesearch and the client kubectl-search let the user search for relevant API objects without having to know the exact name, namespace, or labels.
Getting started
Include steps to pull a container or install a release.
Usage
Run kubesearch as a stand-alone service
kubesearch
Search for Kubernetes objects using kubectl
kubectl create ns flargle
kubectl run blargle -n flargle --image=nginx:alpine
kubectl run boggle -n flargle --image=nginx:latest
kubectl search blargle
kubectl search flargle
kubectl search nginx
kubectl search \"nginx:alpine\"
API
/v1/search?query=<fulltext query string> # Search using a phrase query by surrounding the query in " (quotes)
To do
- Develop a better tokenizer using ANTLR4
- Normalize terms to lowercase
- Support basic ranked retrieval using term frequency
- Support phrase-search (searching for exact phrases which may include token separators)
- Index annotations, container names, images names, labels, and volume names
- Index arbitrary object fields
- Make indexable fields configurable
- Use a treap
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kubectl-search
Package main provides the CLI entrypoint for the kubectl plugin kubectl-search; nothing else.
|
Package main provides the CLI entrypoint for the kubectl plugin kubectl-search; nothing else. |
|
kubesearch
Package main provides the CLI entrypoint for kubesearch; nothing else.
|
Package main provides the CLI entrypoint for kubesearch; nothing else. |
|
search
|
|
|
api
Package api provides the API for searching for Kubernetes objects.
|
Package api provides the API for searching for Kubernetes objects. |
|
controller
Package controller provides a Kubernetes controller that watches for changes to Kubernetes objects and updates the an inverted index with those changes.
|
Package controller provides a Kubernetes controller that watches for changes to Kubernetes objects and updates the an inverted index with those changes. |
|
index
Package index provides an inverted index that supports fulltext search.
|
Package index provides an inverted index that supports fulltext search. |
Click to show internal directories.
Click to hide internal directories.