stable/mcrouter/README.md
As of Nov 13, 2020, charts in this repo will no longer be updated. For more information, see the Helm Charts Deprecation and Archive Notice, and Update.
Helm chart for Mcrouter, a Memcached protocol router for scaling memcached deployments.
This chart is deprecated and no longer supported.
The following table lists the configurable parameters of the Mcrouter chart and their default values.
| Parameter | Description | Default |
|---|---|---|
controller | Controller used for deploying the Mcrouter pods. Possible values: daemonset or statefulset | daemonset |
daemonset.hostPort | Host port used by the DaemonSet controller | 5000 |
image | Container's image | jphalip/mcrouter:0.36.0 |
| Note: Third-party image (see source) | ||
| It is recommended to build a new, up-to-date image based on the official Dockerfile | ||
mcrouterCommandParams.configFile | The config file to use for the mcrouter command. If not provided, then a config file will automatically be generated based on the Memcached chart's parameters. | No value |
mcrouterCommandParams.port | Port(s) to listen on (comma separated) | 5000 |
memcached.enabled | If true, the Memcached chart will be installed as a dependency | true |
resources.limits.cpu | CPU resource limits | 256m |
resources.limits.memory | Memory resource limits | 512Mi |
resources.requests.cpu | CPU resource requests | 100m |
resources.requests.memory | Memory resource requests | 128Mi |
statefulset.antiAffinity | Pod anti-affinity logic used by the StatefulSet controller. Possible values: hard, soft | hard |
statefulset.replicas | Number of pod replicas used by the StatefulSet controller | 1 |
This chart allows the use of two different controllers: DaemonSet (default) and StatefulSet.
If using the DaemonSet controller then each Mcrouter pods will connect to a port on their respective node' host (defaults to 5000). Each of your application pods may then connect to the same port on their respective node. To access the node's name, you may expose that name via an environment variable with the spec.nodeName entry in your application's PodSpec as described in the Kubernetes documentation.
If using the StatefulSet controller then the service can be accessed by default on port 5000 on the following DNS name from within your cluster: <release name>-mcrouter.<namespace>.svc.cluster.local.
Install the Mcrouter chart:
helm install stable/mcrouter --name=myproxy
Connect to one of the Mcrouter pods and start a telnet session:
MCROUTER_POD_IP=$(kubectl get pods -l app=myproxy-mcrouter -o jsonpath="{.items[0].status.podIP}")
kubectl run -it --rm alpine --image=alpine --restart=Never telnet $MCROUTER_POD_IP 5000
In the telnet prompt enter the following commands:
set mykey 0 0 5
hello
get mykey
quit