Skip to content

Files

Latest commit

 

History

History

augerctl

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

augerctl

augerctl is a command line client for Kubernetes specific etcd, and as close as possible to kubectl. It can be used in scripts or for administrators to explore an etcd cluster.

Getting augerctl

The latest release is not yet available as a binary on Github, the next release will be available.

so that it can be built from source.

git clone https://github.com/etcd-io/auger
cd auger
go install ./augerctl

or

go install github.com/etcd-io/auger/augerctl@main

and the binary will be available in the path $GOBIN or $GOPATH/bin

Configuration

--endpoints

  • gRPC endpoints of etcd cluster
  • default: "http://127.0.0.1:2379"

--cert

  • path to the etcd client TLS cert file
  • default: none

--key

  • path to the etcd client TLS key file
  • default: none

--cacert

  • path to the etcd client TLS CA cert file
  • default: none

--user

  • username for authentication, provide username[:password]
  • default: none

--password

  • password for authentication, only available if --user has no password
  • default: none

Usage

Setting a resource

TODO

Retrieving a resource

List a single service with namespace default and name kubernetes

augerctl get services -n default kubernetes

# Nearly equivalent
kubectl get services -n default kubernetes -o yaml

List a single resource of type priorityclasses and name system-node-critical without namespaced

augerctl get priorityclasses system-node-critical

# Nearly equivalent
kubectl get priorityclasses system-node-critical -o yaml

List all leases with namespace kube-system

augerctl get leases -n kube-system

# Nearly equivalent
kubectl get leases -n kube-system -o yaml

List a single resource of type apiservices.apiregistration.k8s.io and name v1.apps

augerctl get apiservices.apiregistration.k8s.io v1.apps

# Nearly equivalent
kubectl get apiservices.apiregistration.k8s.io v1.apps -o yaml

List all resources

augerctl get

# Nearly equivalent
kubectl get $(kubectl api-resources --verbs=list --output=name | paste -s -d, - ) -A -o yaml

Deleting a resource

TODO

Watching for changes

TODO

Endpoint

If the etcd cluster isn't available on http://127.0.0.1:2379, specify a --endpoints flag.

Project Details

Versioning

augerctl uses semantic versioning. Releases will follow with the Kubernetes release cycle as possible (need API updates), but the version numbers will be not.

License

augerctl is under the Apache 2.0 license. See the LICENSE file for details.