Skip to content
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

[AMQ-7514] Replace non-inclusive terms in classic docs #85

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/_5x_releases/activemq-5002000-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ redirect_from:

[Overview](overview) > [Download](download) > [ActiveMQ 5.2.0 Release](activemq-520-release)

{% include inclusive-terminology-notice.html %}

<div class="alert alert-warning">
This is an older release. To get the current release, please see the <a href="{{site.baseurl}}/components/classic/download" class="alert-link">download page</a>.
</div>
Expand All @@ -24,12 +26,12 @@ New Features in 5.2

The new features and enhancements in this release include:

* [Additional advisory messages](Message FeaturesFeatures/Message Features/Features/Message Features/advisory-message) for messages delivered/consumed fast producers/slow consumers, Usage limits, Slaves become masters etc.
* [Additional advisory messages](Message FeaturesFeatures/Message Features/Features/Message Features/advisory-message) for messages delivered/consumed fast producers/slow consumers, Usage limits, Passive brokers become Active brokers etc.
* Enhanced ssl context configuration through spring/xbean
* New individual acknowledge mode for message consumption
* Ability to configure the automatic discarding of the items being sent to the dead letter queue
* Ability to limit the maximum number of connections to a Broker
* Ability to configure [separate lock](https://issues.apache.org/activemq/browse/AMQ-1244) Datasource for JDBC Master slave.
* Ability to configure [separate lock](https://issues.apache.org/activemq/browse/AMQ-1244) Datasource for JDBC Active Passive.
* activemq-camel and activemq-connection-pool now have their own modules, no longer in activemq-core
* The default [ActiveMQConnectionFactory](http://activemq.apache.org/maven/activemq-core/apidocs/org/apache/activemq/ActiveMQConnectionFactory.html) brokerUrl now uses the [failover transport](failover-transport-reference).
* Uses Apache Camel [1.5](http://activemq.apache.org/camel/camel-150-release.html).
Expand Down
4 changes: 3 additions & 1 deletion src/_5x_releases/activemq-5008000-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ redirect_from:

[Overview](overview) > [Download](download) > [ActiveMQ 5.8.0 Release](activemq-580-release)

{% include inclusive-terminology-notice.html %}

<div class="alert alert-warning">
This is an older release. To get the current release, please see the <a href="{{site.baseurl}}/components/classic/download" class="alert-link">download page</a>.
</div>
Expand All @@ -20,7 +22,7 @@ Apache ActiveMQ 5.8.0 resolves [160 issues](https://issues.apache.org/jira/secur
* management via [REST](ProtocolsConnectivity/Protocols/Connectivity/Protocols/rest) with [jolokia](http://www.jolokia.org/) jmx to http bridge
* Includes [Apache Camel 2.10.3](http://camel.apache.org/camel-2103-release.html)
* Java 7 support (compiled with jdk6 and validated with jdk7)
* [Pure Master Slave](pure-master-slave) no longer supported
* [Pure Active Passive](pure-active-passive) no longer supported

There are some changes in 5.8 that may require some code change

Expand Down
6 changes: 4 additions & 2 deletions src/_5x_releases/activemq-5009000-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,20 @@ redirect_from:

[Overview](overview) > [Download](download) > [ActiveMQ 5.9.0 Release](activemq-590-release)

{% include inclusive-terminology-notice.html %}

<div class="alert alert-warning">
This is an older release. To get the current release, please see the <a href="{{site.baseurl}}/components/classic/download" class="alert-link">download page</a>.
</div>

Apache ActiveMQ 5.9.0 resolves [more than 200 issues](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+AMQ+AND+fixVersion+%3D+%225.9.0%22+AND+status+%3D+Resolved+ORDER+BY+priority+DESC&mode=hide), mostly bug fixes and improvements. It has the following new features:

* [Replicated LevelDB Store](replicated-Features/PersistenceFeatures/Persistence/Features/Persistence/leveldb-store) for shared nothing Master/Slave.
* [Replicated LevelDB Store](replicated-Features/PersistenceFeatures/Persistence/Features/Persistence/leveldb-store) for shared nothing Active/Passive.
* [Runtime Configuration](New Features/New Features in 5.9/runtime-Community/FAQ/configuration)
* Generic JMS XA connection pool in activemq-jms-pool module (has no ActiveMQ dependency)
* MQTT over WebSockets support
* [**broker**](FeaturesFeatures/Features/broker-camel-component) Apache Camel component
* Broker auto-restart upon losing master status
* Broker auto-restart upon losing active status
* AMQP Hardening
* LevelDB Hardening

Expand Down
6 changes: 4 additions & 2 deletions src/_5x_releases/activemq-5009001-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,20 @@ redirect_from:

[Overview](overview) > [Download](download) > [ActiveMQ 5.9.1 Release](activemq-591-release)

{% include inclusive-terminology-notice.html %}

<div class="alert alert-warning">
This is an older release. To get the current release, please see the <a href="{{site.baseurl}}/components/classic/download" class="alert-link">download page</a>.
</div>

Apache ActiveMQ 5.9.1 resolves [more than 120 issues](https://issues.apache.org/jira/secure/IssueNavigator.jspa?reset=true&jqlQuery=project+%3D+AMQ+AND+fixVersion+%3D+%225.9.1%22+AND+status+%3D+Resolved+ORDER+BY+priority+DESC&mode=hide), mostly bug fixes and improvements. It has the following new features:

* [Replicated LevelDB Store](replicated-Features/PersistenceFeatures/Persistence/Features/Persistence/leveldb-store) for shared nothing Master/Slave.
* [Replicated LevelDB Store](replicated-Features/PersistenceFeatures/Persistence/Features/Persistence/leveldb-store) for shared nothing Active/Passive.
* [Runtime Configuration](New Features/New Features in 5.9/runtime-Community/FAQ/configuration)
* Generic JMS XA connection pool in activemq-jms-pool module (has no ActiveMQ dependency)
* MQTT over WebSockets support
* [**broker**](FeaturesFeatures/Features/broker-camel-component) Apache Camel component
* Broker auto-restart upon losing master status
* Broker auto-restart upon losing active status
* AMQP Hardening
* LevelDB Hardening

Expand Down
3 changes: 3 additions & 0 deletions src/_includes/inclusive-terminology-notice.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<div class="alert alert-warning">
This page has been updated to remove non-inclusive terminology. Please refer to the following announcement for more information: <a href="/news/inclusive-terminology">Replacing non-inclusive terms throughout source code, comments, and documentation</a>
</div>
14 changes: 14 additions & 0 deletions src/_news/inclusive-terminology.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
release_date: 2022-05-13
title: Replacing non-inclusive terms throughout source code, comments, and documentation
shortDescription:
title-class: page-title-main
type: main
---
#### Replacing non-inclusive terms throughout source code, comments, and documentation
Moving forward, we will replace master/slave with 2 nouns to denote configured state and 2 adjectives to denote runtime state, and we will need to use those consistently across code and documentation for both brokers as follows:

**Nouns:** Primary/Backup
**Adjectives:** Active/Passive

These changes will take time to fully implement so please bear with us during this transition.
9 changes: 5 additions & 4 deletions src/activemq-artemis-roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: Artemis' Roadmap to ActiveMQ <i>Next</i>
title-class: page-title-main
type: main
---
{% include inclusive-terminology-notice.html %}

The goal of this page is to identify the outstanding issues that must be addressed by Artemis in order to achieve feature parity with ActiveMQ "Classic". The overall objective for working toward feature parity between "Classic" and Artemis is for Artemis to eventually become the next major version of ActiveMQ. This page exists so that we can work together as a group to achieve this goal. This page does **not** list the features which Artemis has *beyond* what currently exists in ActiveMQ "Classic".

Expand All @@ -27,7 +28,7 @@ Keep in mind that not every feature must have a &#9989;. Artemis may still be re

|Feature|Artemis Support|JIRA|Notes|
|---|:---:|---|---|
|[Broker Camel Component](broker-camel-component)|&#9989;||[example](https://github.com/apache/activemq-artemis/tree/master/examples/features/standard/camel)|
|[Broker Camel Component](broker-camel-component)|&#9989;||[example](https://github.com/apache/activemq-artemis/tree/main/examples/features/standard/camel)|
|[Discovery](discovery)|&#9989;||[UDP multicast & JGroups](components/artemis/documentation/latest/using-jms)|
|[Enterprise Integration Patterns](enterprise-integration-patterns)|&#9989;||see "Broker Camel Component"|
|[Horizontal Scaling](horizontal-scaling)|&#9989;||supported via [clustering](components/artemis/documentation/latest/clusters) or [federation](components/artemis/documentation/latest/federation)|
Expand All @@ -44,7 +45,7 @@ Keep in mind that not every feature must have a &#9989;. Artemis may still be re

|Feature|Artemis Support|JIRA|Notes|
|---|:---:|---|---|
|[Master-slave](masterslave)|&#9989;||using JDBC, shared filesystem, & replication; [documentation](components/artemis/documentation/latest/ha)|
|[Active-passive](activepassive)|&#9989;||using JDBC, shared filesystem, & replication; [documentation](components/artemis/documentation/latest/ha)|
|[Network of brokers](networks-of-brokers)|&#9989;|[ARTEMIS-2265](https://issues.apache.org/jira/browse/ARTEMIS-2265)|equivalent through [clustering](components/artemis/documentation/latest/clusters) or [federation](components/artemis/documentation/latest/federation)|
|[Replicated message store](replicated-message-store)|&#9989;||equivalent via [replication](components/artemis/documentation/latest/ha) HA config|

Expand Down Expand Up @@ -137,5 +138,5 @@ Migration
This section should help to answer the end user question, _'How do I migrate from ActiveMQ "Classic" to Artemis?'_. This should include the identification of any tools that can help make this easier, as well as documenting information and procedures specific to migrating.

* [Migration Guide](components/artemis/migration)
* Export messages from KahaDB using [this tool](https://github.com/apache/activemq-cli-tools/tree/master/activemq-kahadb-exporter). The exported XML can be imported via the `./artemis data imp` command.
* For non-standard backends (where direct export isn't an option) follow [this example](https://github.com/apache/activemq-artemis/tree/master/examples/features/sub-modules/inter-broker-bridge/artemis-jms-bridge) to migrate messages from ActiveMQ "Classic" to Artemis over the wire.
* Export messages from KahaDB using [this tool](https://github.com/apache/activemq-cli-tools/tree/main/activemq-kahadb-exporter). The exported XML can be imported via the `./artemis data imp` command.
* For non-standard backends (where direct export isn't an option) follow [this example](https://github.com/apache/activemq-artemis/tree/main/examples/features/sub-modules/inter-broker-bridge/artemis-jms-bridge) to migrate messages from ActiveMQ "Classic" to Artemis over the wire.
24 changes: 24 additions & 0 deletions src/activepassive.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
layout: default_md
title: ActivePassive
title-class: page-title-activemq5
type: activemq5
redirect_from:
- /masterslave
---
[Features](features) > [Clustering](clustering) > [ActivePassic](activepassive)

{% include inclusive-terminology-notice.html %}

Introduction to Active / Passive
------------------------------

The following are the different kinds of Active/Passive configurations available:

Active Passive Type|Requirements|Pros|Cons
---|---|---|---
[Shared File System Active Passive](shared-file-system-active-passive)|A shared file system such as a SAN|Run as many passive brokers as required. Automatic recovery of old active brokers|Requires shared file system
[JDBC Active Passive](jdbc-active-passive)|A Shared database|Run as many passive brokers as required. Automatic recovery of old active brokers|Requires a shared database. Also relatively slow as it cannot use the high performance journal

If you are using a shared network file system such as a SAN we recommend a [Shared File System Active Passive](shared-file-system-active-passive). If you are happy to dispense with the high performance journal and are using pure JDBC as your persistence engine then you should use [JDBC Active Passive](jdbc-active-passive) instead.

3 changes: 2 additions & 1 deletion src/advisory-message.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type: activemq5

[Features](features) > [Message Features](message-features) > [Advisory Message](advisory-message)

{% include inclusive-terminology-notice.html %}

ActiveMQ supports advisory messages which allows you to watch the system using regular JMS messages. Currently we have advisory messages that support:

Expand Down Expand Up @@ -101,7 +102,7 @@ Advisory Topics|Description|Properties|Data Structure|Default|PolicyEntry Proper
`ActiveMQ.Advisory.MessageConsumed.Queue`|Message consumed by a client.|`String='orignalMessageId'` - the delivered id|`Message`|`false`|`advisoryForConsumed`
`ActiveMQ.Advisory.MessageConsumed.Topic`|Message consumed by a client.|`String='orignalMessageId'` - the delivered id|`Message`|`false`|`advisoryForConsumed`
`ActiveMQ.Advisory.FULL`|A Usage resource is at its limit.|`String='usageName'` - the name of Usage resource|`null`|`false`|`advisoryWhenFull`
`ActiveMQ.Advisory.MasterBroker`|A broker is now the master in a master/slave configuration.|`null`|`null`|`true`|`none`
`ActiveMQ.Advisory.MasterBroker`|A broker is now the active broker in an active/passive configuration.|`null`|`null`|`true`|`none`

### New Advisories in 5.4

Expand Down
4 changes: 3 additions & 1 deletion src/books.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ type: activemq5

[Community](community) > [Books](books)

{% include inclusive-terminology-notice.html %}

Books
=====

Expand Down Expand Up @@ -47,5 +49,5 @@ Learn how to use messaging technologies to build responsive and resilient applic

### Apache ActiveMQ Reference Guide Kit

The TTM's "[Apache ActiveMQ Reference Guide](http://www.ttmsolutions.com/Apache_Software/ActiveMQ_Reference_Guide.php)" (PDF book) provides information to learn how to implement, deploy, administer, and tune Apache ActiveMQ. The Reference Guide includes details on how to work with ActiveMQ components, connectors, client/broker configuration, master/slave configuration, administration, logging, performance tuning and advanced features.
The TTM's "[Apache ActiveMQ Reference Guide](http://www.ttmsolutions.com/Apache_Software/ActiveMQ_Reference_Guide.php)" (PDF book) provides information to learn how to implement, deploy, administer, and tune Apache ActiveMQ. The Reference Guide includes details on how to work with ActiveMQ components, connectors, client/broker configuration, active/passive configuration, administration, logging, performance tuning and advanced features.

3 changes: 2 additions & 1 deletion src/can-two-brokers-share-the-same-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type: activemq5

 [FAQ](faq) > [Using Apache ActiveMQ](using-apache-activemq) > [Can two brokers share the same database](can-two-brokers-share-the-same-database)

{% include inclusive-terminology-notice.html %}

Can two brokers share the same database
---------------------------------------
Expand All @@ -15,5 +16,5 @@ The short answer is no; 2 brokers cannot operate on the same sets of database ta

If you want to share the same physical database server across two brokers to simplify your installation & backup procedures then just create 2 different logins for each broker so that they get their own sets of database tables within the same physical database. (i.e. each broker gets its own logical database within the same physical database server).

Also if you want to only have one database but many possible brokers (for HA) then just use [JDBC Master Slave](jdbc-master-slave)
Also if you want to only have one database but many possible brokers (for HA) then just use [JDBC Active Passive](jdbc-active-passive)

4 changes: 3 additions & 1 deletion src/changes-in-40.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,11 @@ type: activemq5

[Features](features) > [New Features](new-features) > [Changes in 4.0](changes-in-40)

{% include inclusive-terminology-notice.html %}

### New Features in 4.0

* [MasterSlave](masterslave) provides support for continuous availability and fault tolerance of brokers to be able to handle catastrophic hardware failure and not loose a message (or get duplicates).
* [ActivePassive](activepassive) provides support for continuous availability and fault tolerance of brokers to be able to handle catastrophic hardware failure and not loose a message (or get duplicates).
* A new [Exclusive Consumer](exclusive-consumer) feature allows you to pin message processing to a single consumer in a cluser of consumers.
* A new [Message Groups](message-groups) feaure allows you load balance messages accross a set of consumers but also garantee the message order for messages within a message group.
* A new [Total Ordering](total-ordering) feature to allow all consumers on a topic to see messages in the same order.
Expand Down
7 changes: 4 additions & 3 deletions src/clustering.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type: activemq5

[Features](features) > [Clustering](clustering)

{% include inclusive-terminology-notice.html %}

Clustering is a large topic and often means different things to different people. We'll try to list the various aspects of clustering and how they relate to ActiveMQ

Expand Down Expand Up @@ -50,17 +51,17 @@ Networks of brokers also allows us to scale up to a massive number of clients in

You can think of this as a cluster of clients connecting with a cluster of brokers with auto-failover and discovery, making a simple and easy to use messaging fabric.

Master Slave
Active Passive
------------

The problem with running lots of stand alone brokers or brokers in a network is that messages are owned by a single physical broker at any point in time. If that broker goes down, you have to wait for it to be restarted before the message can be delivered. (If you are using non-persistent messaging and a broker goes down you generally lose your message).

The idea behind [MasterSlave](masterslave) is that messages are replicated to a slave broker so that even if you have a catastrophic hardware failure of the master's machine, file system or data centre, you get immediate failover to the slave with no message loss.
The idea behind [ActivePassive](activepassive) is that messages are replicated to a passive broker so that even if you have a catastrophic hardware failure of the active broker's machine, file system or data centre, you get immediate failover to the passive broker with no message loss.

Replicated Message Stores
-------------------------

An alternative to [MasterSlave](masterslave) is to have some way to replicate the message store; so for the disk files to be shared in some way. For example using a SAN or shared network drive you can share the files of a broker so that if it fails another broker can take over straight away.
An alternative to [ActivePassive](activepassive) is to have some way to replicate the message store; so for the disk files to be shared in some way. For example using a SAN or shared network drive you can share the files of a broker so that if it fails another broker can take over straight away.

So by supporting a [Replicated Message Store](replicated-message-store) you can reduce the risk of message loss to provide either a HA backup or a full [DR](dr) solution capable of surviving a data centre failure.

3 changes: 2 additions & 1 deletion src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ type: activemq5

[Using ActiveMQ](using-activemq) > [Examples](examples)

{% include inclusive-terminology-notice.html %}

Since version **5.12.0**, Apache ActiveMQ comes with the new tool that can be used to produce and consume messages from the broker.

Expand Down Expand Up @@ -41,7 +42,7 @@ activemq:consumer
Options
-------

For all options on the commands, run them with `--help` parameter. The up to date, options for [producer](https://github.com/apache/activemq/blob/master/activemq-console/src/main/resources/org/apache/activemq/console/command/producer.txt) and [consumer](https://github.com/apache/activemq/blob/master/activemq-console/src/main/resources/org/apache/activemq/console/command/consumer.txt) can be found in the source.
For all options on the commands, run them with `--help` parameter. The up to date, options for [producer](https://github.com/apache/activemq/blob/main/activemq-console/src/main/resources/org/apache/activemq/console/command/producer.txt) and [consumer](https://github.com/apache/activemq/blob/main/activemq-console/src/main/resources/org/apache/activemq/console/command/consumer.txt) can be found in the source.

Examples
--------
Expand Down
Loading