1 - Installation
Deploy Memphis over Kubernetes
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 cloud-agnostic to any Kubernetes on any cloud.
Minimum Requirements (Without high availability)
Resource | Quantity |
|---|---|
Minimum Kubernetes version | 1.20 and above |
K8S Nodes | 1 |
CPU | 2 CPU |
Memory | 4GB RAM |
Storage | 12GB PVC |
Recommended Requirements (With high availability)
Resource | Minimum Quantity |
|---|---|
Minimum Kubernetes version | 1.20 and above |
K8S Nodes | 3 |
CPU | 4 CPU |
Memory | 8GB RAM |
Storage | 12GB PVC Per node |
Production-ready Memphis deployment with initial three memphis brokers configured in cluster mode for high availability and higher throughput.
Stable release
helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && helm install memphis memphis/memphis --set global.cluster.enabled="true" --create-namespace --namespace memphis --wait
Latest release
helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && helm install --set memphis.image="memphisos/memphis:latest",global.cluster.enabled="true" memphis memphis/memphis --create-namespace --namespace memphis --wait
Minimal deployment of Memphis with a single broker
Stable release
helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && helm install memphis memphis/memphis --create-namespace --namespace memphis --wait
Latest release
helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && helm install --set memphis.image="memphisos/memphis:latest" memphis memphis/memphis --create-namespace --namespace memphis --wait
Option | Description | Default Value | Example |
|---|---|---|---|
rootPwd | Root password for the dashboard | "memphis" | "memphis" |
user_pass_based_auth | Authentication method selector.
true = User + pass
false = User + connection token | "true" | "true" |
logsRetentionInDays | Amount of days to retain system logs | 3 | 3 |
connectionToken | Token for connecting an app to the Memphis Message Queue. Auto generated | "" | "memphis" |
ui_host | Which URL should be seen as the "UI hostname" | "" | "https://memphis.example.com" |
rest_gw_host | Which URL should be seen as the "REST Gateway hostname" | "" | "https://restgw.memphis.example.com" |
broker_host | Which URL should be seen as the "broker hostname" | "" | "memphis.example.com" |
dashboard.port | Dashboard's (GUI) port | 9000 | 9000 |
global.cluster.enabled | Cluster mode for HA and Performance | "false" | "false" |
exporter.enabled | Prometheus exporter | "false" | "false" |
analytics | Collection of anonymous metadata | "true" | "true" |
cluster.enabled | Enables Memphis cluster deployment. For fully HA configuration use global.cluster.enabled | "false" | "true" |
cluster.replicas | Memphis broker replicas | "3" | "5" |
websocket.tls.secret.name | *Optional* Memphis GUI using websockets for live rendering.
K8S secret name for the certs | "" | "memphis-ws-tls-secret" |
websocket.tls.cert | *Optional*
Memphis GUI using websockets for live rendering.
.pem file to use | "" | "memphis_local.pem" |
websocket.tls.key | *Optional*
Memphis GUI using websockets for live rendering.
key file | "" | "memphis-key_local.pem" |
memphis.tls.verify | *Optional*
For encrypted client-memphis communication. Verification for the CA autority. SSL. | "" | "true" |
memphis.tls.secret.name | *Optional*
For encrypted client-memphis communication.
K8S secret name that holds the certs. SSL. | "" | "memphis-client-tls-secret" |
memphis.tls.cert | *Optional*
For encrypted client-memphis communication.
.pem file to use. SSL. | "" | "memphis_client.pem" |
memphis.tls.key | *Optional*
For encrypted client-memphis communication.
Private key file to use. SSL. | "" | "memphis-key_client.pem" |
memphis.tls.ca | *Optional*
For encrypted client-memphis communication.
CA file to use. SSL. | "" | "rootCA.pem" |
metadata.postgresql.username | *Optional*
Username for postgres db | "postgres" | "postgres" |
metadata.pgpool.tls.enabled | *Optional*
Enabling TLS-based communication with PG | "false" | "false" |
metadata.pgpool.tls.certificatesSecret | *Optional*
PG TLS cert secret to be used | "" | "tls-secret" |
metadata.pgpool.tls.certFilename | *Optional*
PG TLS cert file to be used | "" | "tls.crt" |
metadata.pgpool.tls.certKeyFilename | *Optional*
PG TLS key to be used | "" | "tls.key" |
metadata.pgpool.tls.certCAFilename | *Optional*
PG TLS cert CA to be used | "" | "ca.crt" |
metadata.external.enabled | *Optional*
For using external PG instead of deploying dedicated one for Memphis | "false" | "true" |
metadata.external.dbTlsMutual | *Optional*
External PG TLS-basec communication | "true" | "true" |
metadata.external.dbName | *Optional*
External PG db name | "" | "memphis" |
metadata.external.dbHost | *Optional*
External PG db hostname | "" | "metadata.example.url" |
metadata.external.dbPort | *Optional*
External PG db port | "" | 5432 |
metadata.external.dbUser | *Optional*
External PG db user | "" | "postgres" |
metadata.external.dbPass | *Optional*
External PG db password | "" | "12345678" |
Here is how to run an installation command with additional options -
helm install memphis --set cluster.replicas=3,rootPwd="rootpassword" memphis/memphis --create-namespace --namespace memphis
- memphis. Memphis broker.
- memphis-rest-gateway. Memphis REST Gateway.
- memphis-metadata. Metadata store.
a) Generate a self-signed certificate using
mkcert$ mkcert -client \
-cert-file memphis_client.pem \
-key-file memphis-key_client.pem \
"127.0.0.1" "localhost" "*.memphis.dev" ::1 \
b) Find the
rootCA$ mkcert -CAROOT
c) Create self-signed certificates for client
$ mkcert -client -cert-file client.pem -key-file key-client.pem localhost ::1
a) Create a dedicated namespace for memphis
kubectl create namespace memphis
b) Create a k8s secret with the required certs
1
kubectl create secret generic memphis-client-tls-secret \
2
--from-file=memphis_client.pem \
3
--from-file=memphis-key_client.pem \
4
--from-file=rootCA.pem -n memphis
memphis-client-tls-secret
1
tls:
2
secret:
3
name: memphis-client-tls-secret
4
ca: "rootCA.pem"
5
cert: "memphis_client.pem"
6
key: "memphis-key_client.pem"
1
helm install memphis memphis \
2
--create-namespace --namespace memphis --wait \
3
--set \
4
global.cluster.enabled="true",\
5
memphis.tls.verify="true",\
6
memphis.tls.cert="memphis_client.pem",\
7
memphis.tls.key="memphis-key_client.pem",\
8
memphis.tls.secret.name="memphis-client-tls-secret",\
9
memphis.tls.ca="rootCA.pem"
- 1.Create a k8s secret with the provided TLS certs
kubectl create secret generic memphis-client-tls-secret \
--from-file=memphis_client.pem \
--from-file=memphis-key_client.pem \
--from-file=rootCA.pem -n memphis
- 2.Upgrade Memphis to use the TLS certs
helm upgrade memphis memphis -n memphis --reuse-values \
--set \
memphis.tls.verify="true",\
memphis.tls.cert="memphis_client.pem",\
memphis.tls.key="memphis-key_client.pem",\
memphis.tls.secret.name="tls-client-secret",\
memphis.tls.ca="rootCA.pem"
metadata:
enabled: false
external:
enabled: true
dbTlsMutual: true
dbName: memphis
dbHost: <URL>
dbPort: 5432
dbUser: postgres
dbPass: "12345678"
helm install memphis memphis -f postgresql_values.yaml \
--create-namespace --namespace memphis --wait \
--set \
global.cluster.enabled="true"
Search terms: SSL
Last modified 3d ago