Deploy Memphis over Kubernetes using Helm
Helm is a k8s package manager that allows users to deploy apps in a single, configurable command.
More information about Helm can be found here.
Memphis is cloud-native and agnostic to any Kubernetes on any cloud. This means it can be deployed over production environments with Helm.

Step 1: Install

helm repo add memphis --force-update &&
helm install memphis memphis/memphis --create-namespace --namespace memphis

Optional: Helm Install Options

Default Value
Root password for the dashboard
Token for connecting an app to the Memphis Message Queue. Auto generated
Dashboard's (GUI) port
Cluster mode for HA and Performance
Collection of anonymous metadata
helm install <name of the deployment> memphis/memphis --create-namespace --namespace <name os the ns>
An example of a command with real values:
helm install memphis memphis/memphis --create-namespace --namespace memphis
An example with configured options:
helm install memphis --set cluster.replicas=1,rootPwd="rootpassword" memphis/memphis --create-namespace --namespace memphis
Successful deployment should print the following notes. If not, please raise an issue over Github.
NAME: memphis
LAST DEPLOYED: Thu May 5 17:05:40 2022
NAMESPACE: memphis
STATUS: deployed
__ __ _ _
| \/ | ___ _ __ ___ _ __ | |__ (_)___
| |\/| |/ _ \ '_ ` _ \| '_ \| '_ \| / __|
| | | | __/ | | | | | |_) | | | | \__ \
|_| |_|\___|_| |_| |_| .__/|_| |_|_|___/
Melvis thank you for installing memphis!
A dev first event-processing platform.
Memphis UI can be accessed on the following DNS name from within your cluster: memphis-ui.memphis.svc.cluster.local
To access Memphis from localhost, run the below command:
1. kubectl port-forward service/memphis-cluster 6666:6666 9000:9000 --namespace memphis > /dev/null &
Dashboard: http://localhost:9000
Memphis broker: localhost:6666 (Client/SDK connections)
Memphis broker: localhost:9000 (CLI connection)
Read more about networking options here:
Deployment Information
## Secrets ##
UI/CLI/SDK root username - root
UI/CLI root Password - kubectl get secret memphis-creds -n memphis -o jsonpath="{.data.ROOT_PASSWORD}" | base64 --decode
## Components ##
3 Brokers - MQ
UI - GUI Dashboard
MongoDB - Internal Database for management
If the output did not save, or regeneration is needed, please use the following command:
helm get notes memphis -n memphis

Deployed Pods

  • memphis-broker-0: Three (default) MQ workers (Jetstream- and Memphis-made replicas). Responsible for data ingestion and process, just like "Kafka's" brokers
  • memphis-ui-xxx: UI. Responsible for delivering a graphical user interface for managing the cluster.
  • memphis-mongodb-0/1: MongoDB, for Memphis internal usage.

Step 3: Access via UI / CLI / SDK

Expose the UI in a localhost environment using "port-forward":
kubectl port-forward service/memphis-cluster 9000:9000 --namespace memphis & >/dev/null
UI/CLI root username - root
UI/CLI root Password - kubectl get secret memphis-creds -n memphis -o jsonpath="{.data.ROOT_PASSWORD}" | base64 --decode
If a simpler localhost connection is needed for more services, use Kubefwd.
Expose the UI in a production environment:
  • Nodeport
    kubectl patch svc memphis-ui --type='json' -p '[{"op":"replace","path":"/spec/type","value":"NodePort"}]'
    kubectl describe svc memphis-ui | grep -i Endpoints
    NodePort will expose the UI via one of the k8s workers' IPs.
  • Load Balancer
kubectl patch svc memphis-ui --type='json' -p '[{"op":"replace","path":"/spec/type","value":"LoadBalancer"}]'
kubectl describe svc memphis-ui | grep -i "LoadBalancer Ingress"
LoadBalancer Ingress:
  • Ingress - Please use the following file:
kind: Ingress
name: memphis-ui-ingress
namespace: memphis
annotations: "true" nginx letsencrypt-staging
- hosts:
- ""
secretName: demo-tls
- host: ""
- path: /
pathType: Prefix
name: memphis-ui
number: 80
Find out more on publishing k8s services here.
For the entire CLI reference and how to install it, please head to the following page:
The CLI client connects to Memphis via the UI.
After installing the CLI client and exposing the UI through one of the methods listed under the UI tab, please run the following:
$# mem connect
Use command: mem connect --user <user> --password <password> --server <server>
Example: mem connect -u root -p memphis -s <host>:<management_port>
Connection configuration to Memphis
Usage: index connect <command> [options]
Connection to Memphis
-u, --user <user> User
-p, --password <password> Password
-s, --server <server> Memphis
-h, --help display help for command
$# mem connect -u root -p memphis -s http://localhost:9000
Connected successfully to Memphis control plane.
For more detailed information, please head to the SDKs section below.


Memphis Node.JS SDK can be used to demonstrate the required parameters.

await memphis.connect({
host: "<memphis-host>",
port: <port>, // defaults to 6666
username: "<username>", // (application type user)
connectionToken: "<broker-token>", // you will get it on application type user creation
reconnect: true, // defaults to false
maxReconnect: 10, // defaults to 10
reconnectIntervalMs: 1500, // defaults to 1500
timeoutMs: 1500 // defaults to 1500
  • host: Usually "memphis-cluster" or the UI URL.
  • username: Usually "root". Head to the users' section via the UI or CLI to add more.
  • connectionToken: Each app that produces and/or consumer data with Memphis uses token authentication. To display the initial one, please run the following:
kubectl get secret memphis-creds -n <namespace> -o jsonpath="{.data.CONNECTION_TOKEN}" | base64 --decode
Copy link
Edit on GitHub
Step 1: Install
Step 3: Access via UI / CLI / SDK