Skip to content

Commit

Permalink
Update stable version for documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Aug 21, 2023
1 parent 00b1750 commit bc2f047
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 17 deletions.
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/includes/attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:quarkus-version: 3.1.2.Final
:quarkus-artemis-version: 3.0.1
:quarkus-version: 3.3.0
:quarkus-artemis-version: 3.1.0

:quarkus-org-url: https://github.com/quarkusio
:quarkus-base-url: {quarkus-org-url}/quarkus
Expand Down
75 changes: 60 additions & 15 deletions docs/modules/ROOT/pages/includes/quarkus-artemis-core.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@ h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.enabled]]`link:#quarkus-artemis-core_quarkus.artemis.enabled[quarkus.artemis.enabled]`


[.description]
--
Whether to enable this configuration.
Whether to enable this configuration.

Is enabled by default.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -29,6 +31,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.enabled]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.enabled[quarkus.artemis.devservices.enabled]`


[.description]
--
Enable or disable Dev Services explicitly. Dev Services are automatically enabled unless `quarkus.artemis.url` is set.
Expand All @@ -45,9 +48,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.port]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.port[quarkus.artemis.devservices.port]`


[.description]
--
Optional fixed port the dev service will listen to.
Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -62,9 +67,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.image-name]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.image-name[quarkus.artemis.devservices.image-name]`


[.description]
--
The ActiveMQ Artemis container image to use.
The ActiveMQ Artemis container image to use.

Defaults to @++{++code quay.io/artemiscloud/activemq-artemis-broker:1.0.18++}++

ifdef::add-copy-button-to-env-var[]
Expand All @@ -79,10 +86,13 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.shared]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.shared[quarkus.artemis.devservices.shared]`


[.description]
--
Indicates if the ActiveMQ Artemis broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for ActiveMQ Artemis starts a new container. Is activated by default when not set.
The discovery uses the `quarkus-dev-service-artemis` label. The value is configured using the `service-name` property.
Indicates if the ActiveMQ Artemis broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for ActiveMQ Artemis starts a new container. Is activated by default when not set.

The discovery uses the `quarkus-dev-service-artemis` label. The value is configured using the `service-name` property.

Container sharing is only used in dev mode.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -97,9 +107,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.service-name]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.service-name[quarkus.artemis.devservices.service-name]`


[.description]
--
The value of the `quarkus-dev-service-artemis` label attached to the started container. This property is used when `shared` is set to `true`. It defaults to `artemis` when not set. In this case, before starting a container, Dev Services for ActiveMQ Artemis looks for a container with the `quarkus-dev-service-artemis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-artemis` label set to the specified value.
The value of the `quarkus-dev-service-artemis` label attached to the started container. This property is used when `shared` is set to `true`. It defaults to `artemis` when not set. In this case, before starting a container, Dev Services for ActiveMQ Artemis looks for a container with the `quarkus-dev-service-artemis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-artemis` label set to the specified value.

This property is used when you need multiple shared ActiveMQ Artemis brokers.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -114,6 +126,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.user]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.user[quarkus.artemis.devservices.user]`


[.description]
--
User to start artemis broker. Defaults to `admin` if not set.
Expand All @@ -130,6 +143,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.password]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.password[quarkus.artemis.devservices.password]`


[.description]
--
Password to start artemis broker. Defaults to `admin` whne not set.
Expand All @@ -146,6 +160,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.devservices.extra-args]]`link:#quarkus-artemis-core_quarkus.artemis.devservices.extra-args[quarkus.artemis.devservices.extra-args]`


[.description]
--
The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container. Defaults to `--no-autotune --mapped --no-fsync` when not set.
Expand All @@ -162,9 +177,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.health-exclude]]`link:#quarkus-artemis-core_quarkus.artemis.health-exclude[quarkus.artemis.health-exclude]`


[.description]
--
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled.
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled.

By default, the health check includes all configured data sources (if it is enabled).

ifdef::add-copy-button-to-env-var[]
Expand All @@ -179,6 +196,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.xa-enabled]]`link:#quarkus-artemis-core_quarkus.artemis.xa-enabled[quarkus.artemis.xa-enabled]`


[.description]
--
Support to expose `jakarta.jms.XAConnectionFactory`. Is not activated by default.
Expand All @@ -195,9 +213,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.health.enabled]]`link:#quarkus-artemis-core_quarkus.artemis.health.enabled[quarkus.artemis.health.enabled]`


[.description]
--
Whether a health check is published in case the smallrye-health extension is present.
Whether a health check is published in case the smallrye-health extension is present.

This is a global setting and is not specific to a datasource.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -212,6 +232,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-artemis-core_quarkus.artemis.url]]`link:#quarkus-artemis-core_quarkus.artemis.url[quarkus.artemis.url]`


[.description]
--
Artemis connection url
Expand All @@ -228,6 +249,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-artemis-core_quarkus.artemis.username]]`link:#quarkus-artemis-core_quarkus.artemis.username[quarkus.artemis.username]`


[.description]
--
Username for authentication, only used with JMS
Expand All @@ -244,6 +266,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-artemis-core_quarkus.artemis.password]]`link:#quarkus-artemis-core_quarkus.artemis.password[quarkus.artemis.password]`


[.description]
--
Password for authentication, only used with JMS
Expand All @@ -260,6 +283,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-artemis-core_quarkus.artemis.health.external.enabled]]`link:#quarkus-artemis-core_quarkus.artemis.health.external.enabled[quarkus.artemis.health.external.enabled]`


[.description]
--
Whether configurations (`org.apache.activemq.artemis.api.core.client.ServerLocator`s in case of the `artemis-core` extension, `jakarta.jms.ConnectionFactory`s in case of the `artemis-jms` extension) should be included in the health check. Defaults to `true` if not set.
Expand All @@ -281,9 +305,11 @@ h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.enabled]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.enabled[quarkus.artemis."configuration-name".enabled]`


[.description]
--
Whether to enable this configuration.
Whether to enable this configuration.

Is enabled by default.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -298,6 +324,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.enabled]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.enabled[quarkus.artemis."configuration-name".devservices.enabled]`


[.description]
--
Enable or disable Dev Services explicitly. Dev Services are automatically enabled unless `quarkus.artemis.url` is set.
Expand All @@ -314,9 +341,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.port]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.port[quarkus.artemis."configuration-name".devservices.port]`


[.description]
--
Optional fixed port the dev service will listen to.
Optional fixed port the dev service will listen to.

If not defined, the port will be chosen randomly.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -331,9 +360,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.image-name]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.image-name[quarkus.artemis."configuration-name".devservices.image-name]`


[.description]
--
The ActiveMQ Artemis container image to use.
The ActiveMQ Artemis container image to use.

Defaults to @++{++code quay.io/artemiscloud/activemq-artemis-broker:1.0.18++}++

ifdef::add-copy-button-to-env-var[]
Expand All @@ -348,10 +379,13 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.shared]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.shared[quarkus.artemis."configuration-name".devservices.shared]`


[.description]
--
Indicates if the ActiveMQ Artemis broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for ActiveMQ Artemis starts a new container. Is activated by default when not set.
The discovery uses the `quarkus-dev-service-artemis` label. The value is configured using the `service-name` property.
Indicates if the ActiveMQ Artemis broker managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for ActiveMQ Artemis starts a new container. Is activated by default when not set.

The discovery uses the `quarkus-dev-service-artemis` label. The value is configured using the `service-name` property.

Container sharing is only used in dev mode.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -366,9 +400,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.service-name]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.service-name[quarkus.artemis."configuration-name".devservices.service-name]`


[.description]
--
The value of the `quarkus-dev-service-artemis` label attached to the started container. This property is used when `shared` is set to `true`. It defaults to `artemis` when not set. In this case, before starting a container, Dev Services for ActiveMQ Artemis looks for a container with the `quarkus-dev-service-artemis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-artemis` label set to the specified value.
The value of the `quarkus-dev-service-artemis` label attached to the started container. This property is used when `shared` is set to `true`. It defaults to `artemis` when not set. In this case, before starting a container, Dev Services for ActiveMQ Artemis looks for a container with the `quarkus-dev-service-artemis` label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise it starts a new container with the `quarkus-dev-service-artemis` label set to the specified value.

This property is used when you need multiple shared ActiveMQ Artemis brokers.

ifdef::add-copy-button-to-env-var[]
Expand All @@ -383,6 +419,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.user]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.user[quarkus.artemis."configuration-name".devservices.user]`


[.description]
--
User to start artemis broker. Defaults to `admin` if not set.
Expand All @@ -399,6 +436,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.password]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.password[quarkus.artemis."configuration-name".devservices.password]`


[.description]
--
Password to start artemis broker. Defaults to `admin` whne not set.
Expand All @@ -415,6 +453,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.extra-args]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.devservices.extra-args[quarkus.artemis."configuration-name".devservices.extra-args]`


[.description]
--
The value of the `AMQ_EXTRA_ARGS` environment variable to pass to the container. Defaults to `--no-autotune --mapped --no-fsync` when not set.
Expand All @@ -431,9 +470,11 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.health-exclude]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.health-exclude[quarkus.artemis."configuration-name".health-exclude]`


[.description]
--
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled.
Whether this particular data source should be excluded from the health check if the general health check for data sources is enabled.

By default, the health check includes all configured data sources (if it is enabled).

ifdef::add-copy-button-to-env-var[]
Expand All @@ -448,6 +489,7 @@ endif::add-copy-button-to-env-var[]

a|icon:lock[title=Fixed at build time] [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.xa-enabled]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.xa-enabled[quarkus.artemis."configuration-name".xa-enabled]`


[.description]
--
Support to expose `jakarta.jms.XAConnectionFactory`. Is not activated by default.
Expand All @@ -469,6 +511,7 @@ h|Default

a| [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.url]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.url[quarkus.artemis."configuration-name".url]`


[.description]
--
Artemis connection url
Expand All @@ -485,6 +528,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.username]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.username[quarkus.artemis."configuration-name".username]`


[.description]
--
Username for authentication, only used with JMS
Expand All @@ -501,6 +545,7 @@ endif::add-copy-button-to-env-var[]

a| [[quarkus-artemis-core_quarkus.artemis.-configuration-name-.password]]`link:#quarkus-artemis-core_quarkus.artemis.-configuration-name-.password[quarkus.artemis."configuration-name".password]`


[.description]
--
Password for authentication, only used with JMS
Expand Down

0 comments on commit bc2f047

Please sign in to comment.