You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You are welcome to submit any bugs, issues and feature requests on this repository.
4
+
5
+
6
+
## Commit Message Guidelines
7
+
8
+
We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**.
9
+
10
+
### Commit Message Format
11
+
12
+
Each commit message consists of a **header**, a **body** and a **footer**. The header has a special format that includes a **type**, a **scope** and a **subject**:
13
+
14
+
```
15
+
<type>(<scope>): <subject>
16
+
<BLANK LINE>
17
+
<body>
18
+
<BLANK LINE>
19
+
<footer>
20
+
```
21
+
22
+
The **header** with **type** is mandatory. The **scope** of the header is optional. This repository has no predefined scopes. A custom scope can be used for clarity if desired.
23
+
24
+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
25
+
26
+
The footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any.
27
+
28
+
Example 1:
29
+
30
+
```
31
+
feat: add Fuji release compose files
32
+
```
33
+
34
+
```
35
+
fix(script): correct run script to use the right ports
36
+
37
+
Previously device services used wrong port numbers. This commit fixes the port numbers to use the latest port numbers.
38
+
39
+
Closes: #123, #245, #992
40
+
```
41
+
42
+
### Revert
43
+
44
+
If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
45
+
46
+
### Type
47
+
48
+
Must be one of the following:
49
+
50
+
-**feat**: New feature for the user, not a new feature for build script
51
+
-**fix**: Bug fix for the user, not a fix to a build script
52
+
-**docs**: Documentation only changes
53
+
-**style**: Formatting, missing semi colons, etc; no production code change
54
+
-**refactor**: Refactoring production code, eg. renaming a variable
55
+
-**chore**: Updating grunt tasks etc; no production code change
56
+
-**perf**: A code change that improves performance
57
+
-**test**: Adding missing tests, refactoring tests; no production code change
58
+
-**build**: Changes that affect the CI/CD pipeline or build system or external dependencies (example scopes: travis, jenkins, makefile)
59
+
-**ci**: Changes provided by DevOps for CI purposes.
60
+
-**revert**: Reverts a previous commit.
61
+
62
+
### Scope
63
+
64
+
There are no predefined scopes for this repository. A custom scope can be provided for clarity.
65
+
66
+
### Subject
67
+
68
+
The subject contains a succinct description of the change:
69
+
70
+
- use the imperative, present tense: "change" not "changed" nor "changes"
71
+
- don't capitalize the first letter
72
+
- no dot (.) at the end
73
+
74
+
### Body
75
+
76
+
Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
77
+
78
+
### Footer
79
+
80
+
The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**.
81
+
82
+
**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
Copy file name to clipboardExpand all lines: README.md
+79-50Lines changed: 79 additions & 50 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,81 @@
1
1
# emqx-operator
2
-
// TODO(user): Add simple overview of use/purpose
2
+
3
+
EMQX Operator is a [Kubernetes](https://kubernetes.io/) operator for managing [EMQX](https://emqx.com/) clusters.
3
4
4
5
## Description
5
-
// TODO(user): An in-depth paragraph about your project and overview of use
6
6
7
-
## Getting Started
7
+
The operator conceptually consists of the following parts:
8
+
- EMQX CRD: Definition for a resource that resembles the EMQX cluster in the Kubernetes API.
9
+
- Rebalance CRD: Definition for a resource that orchestrates rebalancing of EMQX clusters.
10
+
- Controller manager: Kubernetes controller that manages various Kubernetes resources according to EMQX CRs specifications.
11
+
12
+
This operator supports:
13
+
* Management of EMQX clusters in both regular and core-replicant deployment modes.
14
+
* Management of [EMQX DS](https://docs.emqx.com/en/emqx/latest/durability/durability_introduction.html#sessions-and-durable-storage) replication, including automatic rebalancing.
15
+
* Rebalancing of MQTT sessions and connections across EMQX cluster nodes.
16
+
17
+
## Compatibility
18
+
19
+
This operator is compatible with the following EMQX releases:
This will install both the CRDs, the controller manager and relevant resources into the cluster. The controller manager will be deployed in the `emqx-operator-system` namespace.
33
+
34
+
## Upgrading
35
+
36
+
### From 2.2.x
37
+
38
+
To upgrade from 2.2.x to 2.3.0, you need to patch the existing CRDs first to explicitly remove the conversion webhook.
0 commit comments