Skip to content

Commit

Permalink
docs: fix spell error
Browse files Browse the repository at this point in the history
  • Loading branch information
Rory-Z authored and kiragoo committed Jun 14, 2022
1 parent b4fd6ac commit a707d35
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A Kubernetes Operator for EMQX Broker and EMQX Enterprise

## Overview

The EMQX Operator provides [Kubernetes](https://kubernetes.io/) native deployment and management of [EMQX](https://www.emqx.io/) includes EMQX Broker and EMQX Enterprise. The purpose of this project is to simplify and automate the configuration of EMQX cluster.
The EMQX Operator provides [Kubernetes](https://kubernetes.io/) native deployment and management of [EMQX](https://www.emqx.io/) including EMQX Broker and EMQX Enterprise. The purpose of this project is to simplify and automate the configuration of the EMQX cluster.

The EMQX Operator includes, but is not limited to, the following features:

Expand All @@ -23,24 +23,24 @@ The EMQX Operator requires a Kubernetes cluster of version `>=1.20.0`.
A core feature of the EMQX Operator is to monitor the Kubernetes API server for changes to specific objects and ensure that the running EMQX deployments match these objects.
The Operator acts on the following [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions/).

The example of EMQX Broker see the [emqx.yaml](config/samples/emqx/v1beta2/emqx.yaml) and the example of EMQX Enterprise see the [emqx-ee.yaml](config/samples/emqx/v1beta2/emqx-ee.yaml).
For the example of EMQX Broker see the [`emqx.yaml`](config/samples/emqx/v1beta2/emqx.yaml) and for the example of EMQX Enterprise see the [emqx-ee.yaml](config/samples/emqx/v1beta2/emqx-ee.yaml).

The EMQX Operator automatically detects changes on any of the above custom resource objects, and ensures that running deployments are kept in sync with the changes.
The EMQX Operator automatically detects changes on any of the above custom resource objects and ensures that running deployments are kept in sync with the changes.

## Getting Start

For more information on get started, see the [getting started](docs/en_US/getting-started/getting-started.md)
For more information on getting started, see the [getting started](docs/en_US/getting-started/getting-started.md)

## Development

### Prerequisites

- golang environment
- Golang environment
- docker (used for creating container images, etc.)
- Kubernetes cluster

## Contributing
Many files (api, config, controller, hack,...) in this repository are auto-generated.
Many files (API, config, controller, hack,...) in this repository are auto-generated.
Before proposing a pull request:

1. Commit your changes.
Expand Down
16 changes: 8 additions & 8 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@
### Features 🌈

- New Custom Resource Define: `EmqxPlugin`, for managing EMQX plugins and auto bind service port
- After deploy EMQX Custom Resource, EMQX Operator will auto create default `EmqxPlugin` Custom Resource, and you can manage it.
- You can create you own `EmqxPlugin` Custom Resource, and user-define them config, and EMQX Operator will load them to EMQX Custom Resource.
- If the `EmqxPlugin` Custom Resource need listener port, EMQX Operator will bind the port to service.
- After deploying EMQX Custom Resource, EMQX Operator will auto-create default `EmqxPlugin` Custom Resource, and you can manage it.
- You can create your own `EmqxPlugin` Custom Resource and user-defined their config, and EMQX Operator will load them to EMQX Custom Resource.
- If the `EmqxPlugin` Custom Resource needs listen port, EMQX Operator will bind the port to service.
- If you delete some `EmqxPlugin` Custom Resource, EMQX Operator will unbind the port to service, and unload them to EMQX Custom Resource.

- New API version: `apps.emqx.io/v1beta3`, please check out reference docs
- Now you can set up any EMQX configure via `.spec.emqxTemplate.config`, if you set some listener configure, EMQX Operator will auto bind the listening port to the service
- Now you can set up any EMQX configure via `.spec.emqxTemplate.config`, if you set some listener to it, EMQX Operator will auto bind the listening port to the service
- Now we support set up `readinessProbe/livenessProbe/startupProbe` by `.spec.emqxTemplate` in EMQX Custom Resource
- Now we support set up container `args` by `.spec.emqxTemplate ` in EMQX Custom Resource
- Now we support set up `initContainers ` by `.spec` in EMQX Custom Resource
- The format of our `.spec.emqxTemplate.acl` settings is now the same as the original emqx format, no additional conversions are needed
- Now we support setting up container `args` by `.spec.emqxTemplate ` in EMQX Custom Resource
- Now we support setting up `initContainers ` by `.spec` in EMQX Custom Resource
- The format of our `.spec.emqxTemplate.acl` settings is now the same as the EMQX format, no additional conversions are needed

### Broken Change 🚫

- We not longer support API version: `apps.emqx.io/v1beta1`
- We no longer support the API version: `apps.emqx.io/v1beta1`
2 changes: 1 addition & 1 deletion deploy/charts/emqx-operator/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# emqx-operator

The EMQX Operator provides [Kubernetes](https://kubernetes.io/) native deployment and management of [EMQX](https://www.emqx.io/) includes EMQX Broker and EMQX Enterprise. The purpose of this project is to simplify and automate the configuration of EMQX cluster.
The EMQX Operator provides [Kubernetes](https://kubernetes.io/) native deployment and management of [EMQX](https://www.emqx.io/) includes EMQX Broker and EMQX Enterprise. The purpose of this project is to simplify and automate the configuration of the EMQX cluster.

## Prerequisites

Expand Down

0 comments on commit a707d35

Please sign in to comment.