Skip to content

Commit

Permalink
Remove empty lines
Browse files Browse the repository at this point in the history
Reformat READMEs
  • Loading branch information
LukasBrand committed Sep 28, 2023
1 parent 2e2b217 commit a2f92b5
Show file tree
Hide file tree
Showing 3 changed files with 381 additions and 385 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,36 +9,42 @@

![Extension Overview](img/AzureClusterDiscovery.svg)

This HiveMQ extension allows your HiveMQ cluster nodes to discover each other dynamically by regularly exchanging their information via Azure Blobs in an Azure Blob Storage Container.
This HiveMQ extension allows your HiveMQ cluster nodes to discover each other dynamically by regularly exchanging their
information via Azure Blobs in an Azure Blob Storage Container.

HiveMQ instances are added at runtime as soon as they become available by placing their information, on how to connect to them, to the configured Azure Storage Container.
HiveMQ instances are added at runtime as soon as they become available by placing their information, on how to connect
to them, to the configured Azure Storage Container.
The extension will regularly check the configured Azure Storage Container for files from other HiveMQ nodes.
Additionally, every broker updates its own file on a regular basis to prevent the file from expiring.

## Installation

* Download the extension from the [HiveMQ Website](https://www.hivemq.com/releases/extensions/hivemq-azure-cluster-discovery-extension-1.0.0.zip) or from the [GitHub Releases Page](https://github.com/hivemq/hivemq-azure-cluster-discovery-extension/releases/latest).
* Download the extension from
the [HiveMQ Website](https://www.hivemq.com/releases/extensions/hivemq-azure-cluster-discovery-extension-1.0.0.zip) or
from the [GitHub Releases Page](https://github.com/hivemq/hivemq-azure-cluster-discovery-extension/releases/latest).
* Copy the content of the zip file to the `extensions` folder of your HiveMQ nodes.
* Modify the `azDiscovery.properties` file for your needs.
* Change the [Discovery Mechanism](https://www.hivemq.com/docs/latest/hivemq/cluster.html#discovery) of HiveMQ to `extension`.
* Change the [Discovery Mechanism](https://www.hivemq.com/docs/latest/hivemq/cluster.html#discovery) of HiveMQ
to `extension`.

## Configuration

The information each node writes into the bucket consists of an ip-address and a port.
The ip-address and port are taken from the `external-address` and `external-port` which is configured in the cluster `transport` (config.xml).
The ip-address and port are taken from the `external-address` and `external-port` which is configured in the
cluster `transport` (config.xml).
If they are not set, the `bind-address` and `bind-port` will be used.

The `azDiscovery.properties` can be reloaded during runtime.

### General Configuration

| Config Name | Default Value | Description |
| ------------- |:-------------:|:-----|
| connection‑string | | The required connection string of your Azure Storage Account. See the [Azure Documentation](https://docs.microsoft.com/de-de/com.hivemq.extensions.azure/storage/common/storage-configure-connection-string) for more information.
| container‑name | hivemq-discovery | The name of the Azure Storage Container in which the Blob for the discovery will be created in. If the Container does not exist yet, it will be created by the extension.
| file‑prefix | hivemq-node- | An optional file-prefix for the Blob to create, which holds the cluster node information for the discovery. Do not omit this value if you reuse the specified container for other files.
| file‑expiration | 360 | Timeout in seconds after which the created Blob will be deleted by other nodes, if it was not updated in time.
| update‑interval | 180 | Interval in seconds in which the Blob will be updated. Must be less than file-expiration.
| Config Name | Default Value | Description |
|--------------------------|:----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| connection‑string | | The required connection string of your Azure Storage Account. See the [Azure Documentation](https://docs.microsoft.com/de-de/com.hivemq.extensions.azure/storage/common/storage-configure-connection-string) for more information. |
| container‑name | hivemq-discovery | The name of the Azure Storage Container in which the Blob for the discovery will be created in. If the Container does not exist yet, it will be created by the extension. |
| file‑prefix | hivemq-node- | An optional file-prefix for the Blob to create, which holds the cluster node information for the discovery. Do not omit this value if you reuse the specified container for other files. |
| file‑expiration | 360 | Timeout in seconds after which the created Blob will be deleted by other nodes, if it was not updated in time. |
| update‑interval | 180 | Interval in seconds in which the Blob will be updated. Must be less than file-expiration. |

### Example Configuration

Expand All @@ -54,7 +60,7 @@ update-interval=60

* Create an Azure Storage Account.
* Get your Connection String for the Storage Account.
* Place the Connection String into the `azDiscovery.properties` file of your HiveMQ nodes.
* Place the Connection String into the `azDiscovery.properties` file of your HiveMQ nodes.
* Start your HiveMQ nodes and verify the discovery.

## Need Help?
Expand All @@ -64,7 +70,8 @@ The best place to get in contact is our [Support](http://www.hivemq.com/support/

## Contributing

If you want to contribute to HiveMQ Azure Cluster Discovery Extension, see the [contributing guidelines](CONTRIBUTING.md).
If you want to contribute to HiveMQ Azure Cluster Discovery Extension, see
the [contributing guidelines](CONTRIBUTING.md).

## License

Expand Down
7 changes: 4 additions & 3 deletions arm-quickstart-templates/hivemq-vm-cluster/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# HiveMQ Virtual Machine Cluster
# HiveMQ Virtual Machine Cluster

This template deploys a n-Node HiveMQ cluster to Azure.
This template deploys an n-Node HiveMQ cluster to Azure.

[![Deploy To Azure](https://raw.githubusercontent.com/Azure/azure-quickstart-templates/master/1-CONTRIBUTION-GUIDE/images/deploytoazure.svg?sanitize=true)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2Fhivemq%2Fhivemq-azure-cluster-discovery-extension%2Fmaster%2Farm-quickstart-templates%2Fhivemq-vm-cluster%2Fazuredeploy.json)

The following resources will be deployed bis this template:

- n Virtual Machines with HiveMQ and the HiveMQ Azure Cluster Discovery Extension installed
- An Azure Storage Account used by the Extension
- An Availability Set in which the Virtual Machines are placed
- An Azure Load Balancer used to access the HiveMQ services
- A Virtual Network in which the Virtual Machines and Load Balancer are placed
- A Virtual Network in which the Virtual Machines and Load Balancer are placed
- Network Interfaces with Public IP-Addresses for the Virtual Machines
- A Network Interface with a Public IP-Address for the Load Balancer
Loading

0 comments on commit a2f92b5

Please sign in to comment.