Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Lior Nabat committed Aug 21, 2021
1 parent cdc73bb commit 942e553
Showing 1 changed file with 32 additions and 105 deletions.
137 changes: 32 additions & 105 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,123 +1,50 @@
# Introduction

## What is KubeMQ?
Enterprise-grade message broker native for Docker and Kubernetes. Delivered in a production-ready kubernetes cluster or in a standalone docker container or native binaries, and designed for any type of workload.
# What is KubeMQ?
Enterprise-grade message broker native for Docker and Kubernetes. Delivered in a production-ready kubernetes cluster or in a standalone docker container or native binaries, and designed for any type of workload.
KubeMQ is provided as a small, lightweight Docker container, designed for any workload and architecture running in Kubernetes or any other container orchestration system which support Docker.

## Installation

Every installation method requires a KubeMQ key.
Please [register](https://account.kubemq.io/login/register) to obtain your KubeMQ key.

### Kubernetes

Install KubeMQ cluster on any Kubernetes cluster.

Step 1:

``` bash
kubectl apply -f https://deploy.kubemq.io/init
```

Step 2:

``` bash
kubectl apply -f https://deploy.kubemq.io/key/{{your key}}
```
# Installation

## Kubernetes

### Docker
``` bash
kubectl apply -f https://deploy.kubemq.io/community/
```
## Docker

Pull and run KubeMQ standalone docker container:
``` bash
docker run -d -p 8080:8080 -p 50000:50000 -p 9090:9090 -e KEY={{yourkey}} kubemq/kubemq-standalone:latest
```
``` bash
docker run -d -p 8080:8080 -p 50000:50000 -p 9090:9090 kubemq/kubemq-community:latest
```
## Binaries

### Binaries

KubeMQ standalone binaries are available for Edge locations and for local development.

Steps:

1. Download the latest version of KubeMQ standalone from [Releases](https://github.com/kubemq-io/kubemq/releases)
1. Download the latest version of KubeMQ Community from [Releases](https://github.com/kubemq-io/kubemq-community/releases)
2. Unpack the downloaded archive
3. Run ```kubemq -k {{your key}}``` (A key is needed for the first time only)


### Windows Service

1. Download the Windows version from KubeMQ Releases. Once downloaded, the binary can be installed from anywhere.
2. Create config.yaml configuration file and save it to the same location of the Windows binary.


#### Service Installation

Run:
```bash
kubemq --service install
```

#### Service Installation With Username and Password

Run:
```bash
kubemq --service install --username {your-username} --password {your-password}
```

#### Service UnInstall

Run:
```bash
kubemq --service uninstall
```

#### Service Start

Run:
```bash
kubemq --service start -k {{yourkey}}
```


#### Service Stop

Run:
```bash
kubemq --service stop
```

#### Service Restart

Run:
```bash
kubemq --service restart
```
3. Run ```kubemq server```

**NOTE**: When running under Windows service, all logs will be emitted to Windows Events Logs.



## KubeMQ SDKs
# KubeMQ SDKs
KubeMQ SDKs support list:

| SDK | Github |
|:----|:---|
| C# | https://github.com/kubemq-io/kubemq-CSharp |
| Java | https://github.com/kubemq-io/kubemq-Java |
| Python | https://github.com/kubemq-io/kubemq-Python |
| Node | https://github.com/kubemq-io/kubemq-node |
| Go | https://github.com/kubemq-io/kubemq-go |
| REST | https://postman.kubemq.io/ |
| SDK | Github |
|:----|:---|
| C# | https://github.com/kubemq-io/kubemq-CSharp |
| Java | https://github.com/kubemq-io/kubemq-Java |
| Python | https://github.com/kubemq-io/kubemq-Python |
| Node | https://github.com/kubemq-io/kubemq-node |
| Go | https://github.com/kubemq-io/kubemq-go |
| REST | https://postman.kubemq.io/ |

## KubeMQ Cookbooks

| SDK | Github |
|:----|:---|
| C# | https://github.com/kubemq-io/csharp-sdk-cookbook |
| Java | https://github.com/kubemq-io/java-sdk-cookbook |
| Python | https://github.com/kubemq-io/python-sdk-cookbook |
| Node | https://github.com/kubemq-io/node-sdk-cookbook |
| Go | https://github.com/kubemq-io/go-sdk-cookbook|
| SDK | Github |
|:----|:---|
| C# | https://github.com/kubemq-io/csharp-sdk-cookbook |
| Java | https://github.com/kubemq-io/java-sdk-cookbook |
| Python | https://github.com/kubemq-io/python-sdk-cookbook |
| Node | https://github.com/kubemq-io/node-sdk-cookbook |
| Go | https://github.com/kubemq-io/go-sdk-cookbook|



Expand All @@ -128,5 +55,5 @@ Visit our [Extensive KubeMQ Documentation](https://docs.kubemq.io/).
## Support
You can reach us at:
- [**Email**](mailto:support@kubemq.io)
- [**Slack**](https://kubemq.slack.com) - [Invitation](https://join.slack.com/t/kubemq/shared_invite/enQtNDk3NjE1Mjg1MDMwLThjMGFmYjU1NTVhZWRjZTRjYTIxM2E5MjA5ZDFkMWUyODI3YTlkOWY2MmYzNGIwZjY3OThlMzYxYjYwMTVmYWM)
- [**By open an issue**](https://github.com/kubemq-io/kubemq/issues)
- [**Slack**](https://kubemq.slack.com) - [Invitation](https://join.slack.com/t/kubemq/shared_invite/enQtNDk3NjE1Mjg1MDMwLThjMGFmYjU1NTVhZWRjZTRjYTIxM2E5MjA5ZDFkMWUyODI3YTlkOWY2MmYzNGIwZjY3OThlMzYxYjYwMTVmYWM)
- [**Open an issue**](https://github.com/kubemq-io/kubemq/issues)

0 comments on commit 942e553

Please sign in to comment.