-
Notifications
You must be signed in to change notification settings - Fork 2.2k
docs: update deprecated/outdated compose syntax and filenames #2514
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,53 +62,51 @@ If not specified, EMQX determines its node name based on the running environment | |
|
||
EMQX supports a variety of clustering methods, see our [documentation](https://docs.emqx.com/en/emqx/latest/deploy/cluster/create-cluster.html) for details. | ||
|
||
Let's create a static node list cluster from docker-compose. | ||
Let's create a static node list cluster from Docker Compose. | ||
|
||
- Create `docker-compose.yaml`: | ||
- Create `compose.yaml`: | ||
|
||
```yaml | ||
version: '3' | ||
|
||
services: | ||
emqx1: | ||
image: %%IMAGE%%:latest | ||
environment: | ||
- "[email protected]" | ||
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static" | ||
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]" | ||
networks: | ||
emqx-bridge: | ||
aliases: | ||
- node1.emqx.io | ||
|
||
emqx2: | ||
image: %%IMAGE%%:latest | ||
environment: | ||
- "[email protected]" | ||
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static" | ||
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]" | ||
networks: | ||
emqx-bridge: | ||
aliases: | ||
- node2.emqx.io | ||
|
||
networks: | ||
emqx-bridge: | ||
driver: bridge | ||
services: | ||
emqx1: | ||
image: %%IMAGE%%:latest | ||
environment: | ||
- "[email protected]" | ||
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static" | ||
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]" | ||
networks: | ||
emqx-bridge: | ||
aliases: | ||
- node1.emqx.io | ||
|
||
emqx2: | ||
image: %%IMAGE%%:latest | ||
environment: | ||
- "[email protected]" | ||
- "EMQX_CLUSTER__DISCOVERY_STRATEGY=static" | ||
- "EMQX_CLUSTER__STATIC__SEEDS=[[email protected], [email protected]]" | ||
networks: | ||
emqx-bridge: | ||
aliases: | ||
- node2.emqx.io | ||
|
||
networks: | ||
emqx-bridge: | ||
driver: bridge | ||
``` | ||
|
||
- Start the docker-compose cluster | ||
- Start the Docker Compose services | ||
|
||
```bash | ||
docker-compose -p my_emqx up -d | ||
docker compose -p my_emqx up -d | ||
``` | ||
|
||
- View cluster | ||
|
||
```bash | ||
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status" | ||
Cluster status: #{running_nodes => ['[email protected]','[email protected]'], | ||
stopped_nodes => []} | ||
$ docker exec -it my_emqx_emqx1_1 sh -c "emqx ctl cluster status" | ||
Cluster status: #{running_nodes => ['[email protected]','[email protected]'], | ||
stopped_nodes => []} | ||
``` | ||
|
||
### Persistence | ||
|
@@ -120,7 +118,7 @@ If you want to persist the EMQX docker container, you need to keep the following | |
|
||
Since data in these folders are partially stored under the `/opt/emqx/data/mnesia/${node_name}`, the user also needs to reuse the same node name to see the previous state. To make this work, one needs to set the host part of `EMQX_NODE__NAME` to something static that does not change when you restart or recreate the container. It could be container name, hostname or loopback IP address `127.0.0.1` if you only have one node. | ||
|
||
In if you use docker-compose, the configuration would look something like this: | ||
In if you use Docker Compose, the configuration would look something like this: | ||
|
||
```YAML | ||
volumes: | ||
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this need
-O compose.yaml
?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess not because Compose will still pick up the older filename
?. 👀