KubeMQ Docs
KubeMQ.ioLogin / Register
  • Introduction
  • What's New
  • Getting Started
    • Quick Start
    • Build & Deploy
    • Create Cluster
      • Build & Deploy
      • Helm
      • Openshift
    • Create Connector
      • Build & Deploy
      • Helm
      • Openshift
    • Message Patterns
      • Queues
      • Pub/Sub
      • RPC
  • Learn
    • The Basics
      • Channels
      • Smart Routing
      • Grouping
    • Message Patterns
      • Queues
      • Pub/Sub
      • RPC
    • Access Control
      • Authentication
      • Authorization
      • Notifications
    • Clustering and HA
    • Connectors
      • KubeMQ Targets
      • KubeMQ Sources
      • KubeMQ Bridges
  • Configuration
    • Cluster
      • Set Cluster Name
      • Set Cluster Namespace
      • Set Persistent Volume
      • Set Cluster Replicas
      • Set Cluster Image
      • Set Cluster Security
      • Set Authentication
      • Set Authorization
      • Set Notification
      • Set License
      • Set gRPC Interface
      • Set Rest Interface
      • Set Api Interface
      • Set Store Settings
      • Set Queues Settings
      • Set Routing
      • Set Health Probe
      • Set Resources Limits
      • Set Logs
      • Set Node Selectors
    • Connectors
      • KubeMQ Targets
        • Standalone
          • Redis
          • Memcached
          • Postgres
          • Mysql
          • MSSql
          • Percona
          • Aerospike
          • ReThinkDB
          • MongoDB
          • Elastic Search
          • Cassandra
          • Couchbase
          • CockroachDB
          • Kafka
          • Nats
          • MQTT
          • ActiveMQ
          • IBM-MQ
          • Minio/S3
          • OpenFaas
          • HTTP
        • AWS
          • Athena
          • DynamoDB
          • Elastic Search
          • KeySpaces
          • MariaDB
          • MSSql
          • MySQL
          • Postgres
          • RedShift
          • RedShift Service
          • AmazonMQ
          • MSK
          • Kinesis
          • SQS
          • SNS
          • S3
          • Lambda
          • CloudWatch Logs
          • CloudWatch Events
          • CloudWatch Metrics
        • GCP
          • Redis
          • Memcached
          • Postgres
          • Mysql
          • BigQuery
          • BigTable
          • Firestore
          • Spanner
          • Firebase
          • Pub/Sub
          • Storage
          • Functions
        • Azure
          • Azure SQL
          • Mysql
          • Postgres
          • Blob
          • Files
          • Queue
          • Events Hub
          • Service Bus
        • Sources
          • Queue
          • Events
          • Events Store
          • Command
          • Query
      • KubeMQ Sources
        • HTTP
        • Messaging
          • Kafka
          • RabbitMQ
          • MQTT
          • ActiveMQ
          • IBM-MQ
          • Nats
        • AWS
          • AmazonMQ
          • MSK
          • SQS
        • GCP
          • Pub/Sub
        • Azure
          • EventHubs
          • ServiceBus
        • Targets
          • Queue
          • Events
          • Events Store
          • Command
          • Query
      • KubeMQ Bridges
        • Targets
          • Queue
          • Events
          • Events Store
          • Command
          • Query
        • Sources
          • Queue
          • Events
          • Events Store
          • Command
          • Query
    • Docker
  • HOW TO
    • Connect Your Cluster
    • Show Dashboard
    • Get Cluster Status
    • Get Cluster Logs
  • SDK
    • Java
    • Java (Springboot)
    • C# (.NET)
    • Go
    • Python
    • Node
    • Rest
  • Troubleshooting
    • Start Here
  • License
    • Open Source Software Notices
Powered by GitBook
On this page

Was this helpful?

  1. Configuration
  2. Cluster

Set Rest Interface

Flags

Flag

Type/Options

Default

Description

--rest-disabled

bool

false

Disable rest interface

--rest-port

int

9090

Set rest port value

--rest-expose

string

ClusterIP

Desired service type

--rest-node-port

int

Desired port number in NodePort expose type

--rest-buffer-size

int

0

Set subscribe message / requests buffer size to use on server

--rest-body-limit

int

0

Set Max size of payload in bytes

Expose Options:

ClusterIP/NodePort/LoadBalancer

Example

Expose Rest interface port with a NodePort:

kubemqctl create cluster --rest-expose NodePort --rest-node-port 30600

Values

value

Type/Options

Default

Description

rest.disabled

bool

false

Disable rest interface

rest.port

int

9090

Set rest port value

rest.expose

string

ClusterIP

Desired service type

rest.nodePort

int

Desired port number in NodePort expose type

rest.bufferSize

int

0

Set subscribe message / requests buffer size to use on server

rest.bodyLimit

int

0

Set Max size of payload in bytes

Expose Options:

ClusterIP/NodePort/LoadBalancer

Examples

Expose Rest interface port with a NodePort:

helm install kubemq-cluster --set rest.expose=NodePort,rest-nodePort=30600  -n kubemq kubemq-charts/kubemq

Fields

Field

Type/Options

Default

Description

disabled

bool

false

Disable rest interface

port

int

9090

Set rest port value

expose

string

ClusterIP

Desired service type

nodePort

int

Desired port number in NodePort expose type

bufferSize

int

0

Set subscribe message / requests buffer size to use on server

bodyLimit

int

0

Set Max size of payload in bytes

Expose Options:

ClusterIP/NodePort/LoadBalancer

Example

Expose Rest interface port with a NodePort:

Run:

kubectl apply -f {below-yaml-file}
apiVersion: core.k8s.kubemq.io/v1alpha1
kind: KubemqCluster
metadata:
  name: kubemq-cluster
  namesapce: kubemq
  labels:
    app: kubemq-cluster
spec:
  replicas: 3
  rest:
    expose: NodePort
    nodePort: 30600
PreviousSet gRPC InterfaceNextSet Api Interface

Last updated 5 years ago

Was this helpful?