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.

Requirements

Minimum Requirements (Without high availability)

Resource

Quantity

Minimum Kubernetes version

1.20 and above

K8S Nodes

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

CPU

4 CPU

Memory

8GB RAM

Storage

12GB PVC Per node

Installation

Production

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 --version=1.4.4

Latest release

helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && helm install --set global.cluster.enabled="true" memphis memphis/memphis --create-namespace --namespace memphis --wait

Development

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 --version=1.4.4

Latest release

helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && helm install memphis memphis/memphis --create-namespace --namespace memphis --wait

Additional helm options can be found here.

Deployed pods

memphis. Memphis broker.
memphis-rest-gateway. Memphis REST Gateway.
memphis-metadata. Metadata store.
memphis-metadata-coordinator. Metadata coordinator

For more information on each component, please head to the architecture section.

Deployment diagram

Appendix A: Install Memphis using predefined parameters

Currently, you can use this for creating users during deployment.

Execute Helm install with the created values file:

helm install my-memphis memphis -f config.yaml --create-namespace --namespace memphis --wait

Creating users

(Based on Memphis password policy: at least 8 characters long, contains both uppercase and lowercase, and at least one number and one special character(!?-@#$%):

config.yaml

auth:
#By default, Memphis sets this option to "false," enabling first user creation during the initial login.
  enabled: true
  users:
    mgmt:
    - user: admin
      password: Admin123456!
    - user: test_mgmt
      password: Test123456!
    - user: test
      password: Test123456@
    client:
    - user: test_app
      password: Test123456!@
    - user: test_app2
      password: Test123456@!

Refer to the example file for guidance: example/initial_config_values.yaml

Appendix B: Dedicated options per specific K8S distributions

To deploy the Memphis cluster on top of Red Hat Openshift it's necessary to configure default security context parameters as follows:

helm repo add memphis https://k8s.memphis.dev/charts/ --force-update && 
helm install memphis memphis/memphis --set \
global.cluster.enabled="true",\
metadata.postgresql.containerSecurityContext.enabled="false",\
metadata.postgresql.podSecurityContext.enabled="false",\
metadata.pgpool.containerSecurityContext.enabled="false",\
metadata.pgpool.podSecurityContext.enabled="false" \
--create-namespace --namespace memphis --wait

Appendix C: Helm deployment options

Option

Description

Default Value

Example

global.cluster.enabled

Cluster mode for HA and Performance

"false"

exporter.enabled

Prometheus exporter

"false"

exporter.serviceExposed.enbaled

Expose metrics port with memphis service

"false"

"true"

cluster.enabled

Enables Memphis cluster deployment. For fully HA configuration use global.cluster.enabled

"false"

"true"

cluster.replicas

Memphis broker replicas

"3"

"5"

memphis.image

Memphis image name

"memphisos/memphis:x.x.x-stable"

"memphisos/memphis:latest"

memphis.ui.port

Dashboard's (GUI) port

9000

memphis.hosts.uiHostName

Which URL should be seen as the "UI hostname"

"https://memphis.example.com"

memphis.hosts.restgwHostName

Which URL should be seen as the "REST Gateway hostname"

"https://restgw.memphis.example.com"

memphis.hosts.brokerHostName

Which URL should be seen as the "broker hostname"

"memphis.example.com"

memphis.configFile.logsRetentionInDays

Amount of days to retain system logs

memphis.configFile.gcProducerConsumerRetentionInHours

Amount of hours to retain producer/consumer in system

memphis.configFile.tieredStorageUploadIntervalSeconds

nterval in seconds between uploads to tiered storage

memphis.configFile.dlsRetentionHours

Amount of hours to retain messages in DLS

memphis.configFile.userPassBasedAuth

Authentication method selector. true = User + pass false = User + connection token

"true"

memphis.creds.rootPwd

Root password for the dashboard. Randomly generated.

"superpass"

memphis.creds.connectionToken

Token for connecting an app to the Memphis Message Queue. Auto generated.Randomly generated.

"connectionToken

memphis.creds.jwtSecret

For internal traffic. Randomly generated.

"<JWT_TOKEN>"

memphis.creds.refreshJwtSecret

For internal traffic. Randomly generated.

"<JWT_TOKEN>"

memphis.creds.encryptionSecretKey

Encryption secret key for internal encryption. Randomly generated.

memphis.creds.secretConfig.name

Name of the secret with memphis creds

"memphis-creds"

"external-creds"

memphis.creds.secretConfig.existingSecret

*Optional* For use of the existing secret with memphis creds

"false"

"true"

memphis.creds.secretConfig.rootPwd_key