README
¶
Memcached Operator
memcached-operator is a Kubernetes Operator for deploying and managing a cluster of Memcached instances.
memcached-operator provides a single Service endpoint that memcached client applications can connect to to make use of the memcached cluster. It provides this via a memcached proxy which is automatically updated whenever memcached instances are added or removed from the cluster.
memcached-operator supports sharded and replicated pools of servers as well as combinations of both strategies.
See the documentation for more information.
Project Status
Project status: alpha
memcached-operator is still under active development and has not been extensively tested yet. Use at your own risk. Backward-compatibility is not supported for alpha releases.
Prerequisites
- Version >= 1.8 of Kubernetes.
memcached-operator relies on garbage collection support for custom resources which is in Kubernetes 1.8+
Quickstart
You can install the memcached-operator using the included helm chart. Check out the git repository and run this in the root directory.
$ helm install --name memcached-operator charts/memcached-operator
The easiest way to create a memcached cluster is using the memcached helm chart:
$ helm install --name sharded stable/memcached
You can then create a memcached proxy to connect to the cluster.
apiVersion: ianlewis.org/v1alpha1
kind: MemcachedProxy
metadata:
name: sharded-example
spec:
rules:
type: "sharded"
service:
name: "sharded-memcached"
port: 11211
$ kubectl apply -f docs/sharded-example.yaml
You can then access your memcached cluster via thesharded-memcached
service. Check the documentation for more information.
Removal
You can remove the memcached-operator by deleting the helm release.
$ helm delete --purge memcached-operator
Development
Check out memcached-operator to your GOPATH
Building
memcached-operator can be built using the normal Go build tools. This will build a binary dynamically linked to glibc.
$ go build
You can build a fully statically linked binary as well:
$ make build
Disclaimers
This is not an official Google product
Documentation
¶
There is no documentation for this package.
Directories
¶
Path | Synopsis |
---|---|
pkg
|
|
apis/ianlewis.org/v1alpha1
Package v1alpha1 is the v1alpha1 version of the API.
|
Package v1alpha1 is the v1alpha1 version of the API. |
client/clientset/versioned
THIS FILE IS AUTOMATICALLY GENERATED.
|
THIS FILE IS AUTOMATICALLY GENERATED. |
client/clientset/versioned/fake
THIS FILE IS AUTOMATICALLY GENERATED.
|
THIS FILE IS AUTOMATICALLY GENERATED. |
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
|
This package contains the scheme of the automatically generated clientset. |
client/clientset/versioned/typed/ianlewis/v1alpha1
This package has the automatically generated typed clients.
|
This package has the automatically generated typed clients. |
client/clientset/versioned/typed/ianlewis/v1alpha1/fake
Package fake has the automatically generated clients.
|
Package fake has the automatically generated clients. |
test
|
|