This is an automated email from the ASF dual-hosted git repository. robbie pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/activemq-website.git
commit e14a8a4547e70751f23cdbf4e6302a64fbb23051 Author: Robbie Gemmell <[email protected]> AuthorDate: Wed Oct 9 09:50:28 2024 +0100 various fixups and improvements for new artemis-console additions - Fix various broken URLs. - Use a public Release Notes link. - Expand detail for adding a connection, give text example and note on finding details at startup. - Tweak outline of different views and add link to skip to the matching content. - Move Broker Diagram section heading outside of prior note box. - Make link to Management via JMX go directly there. - Delete the duplicate TOC-only getting-started page, update breadcrumb links to reflect current page. --- .../artemis-console/documentation/console.md | 74 ++++++++++------------ .../artemis-console/documentation/deploying.md | 18 +++--- .../documentation/getting-started.md | 18 ------ .../artemis-console/documentation/index.md | 19 +++--- src/components/artemis-console/download/index.md | 4 +- src/components/artemis-console/index.md | 4 +- 6 files changed, 57 insertions(+), 80 deletions(-) diff --git a/src/components/artemis-console/documentation/console.md b/src/components/artemis-console/documentation/console.md index b5b33ec45..f28f79b6b 100644 --- a/src/components/artemis-console/documentation/console.md +++ b/src/components/artemis-console/documentation/console.md @@ -4,30 +4,43 @@ title: ActiveMQ Artemis Console Documentation title-class: page-title-artemis type: artemis --- -[Documentation](index) > [Getting Started](getting-started) +[Documentation](index) > [Using The Console](console) <a id="connecting-to-the-broker"></a> ## Connecting To the Broker ### Adding A Connection -Once you have navigated to the *connect* page click on the *Add connection* button and fill in the Jolokia endpoint configuration -of your broker. You will be able to test the connection before creating: +Once you have navigated to the *Connect* page click on the *Add connection* button and fill in the Jolokia endpoint configuration +of your broker. +The endpoint details will depend on your specific broker configuration, but can be easily found in a message printed to +the console during broker startup. For instance, a fresh broker instance displaying startup message: + + AMQ241002: Artemis Jolokia REST API available at http://localhost:8161/console/jolokia + +Would yield connection details of: + + Host: localhost + Port: 8161 + Path: /console/jolokia + +Configure these as needed for your specific broker instance. You can test the connection with the *Test connection* button before clicking *Add* to save the connection: <img src= "connect.png" width="1200" alt="Edit Connection Image" style="border: 2px solid grey;"> -Once the connection is added simply click the *Connect* button of your broker and this should open up a new tab and prompt for a login attempt. -Login and ypu should see the console to 2 Artemis Menu items. +Once the connection is added simply click the *Connect* button for your broker and this should open up a new tab and prompt for a login attempt. +Once logged in you should see the console with two Artemis menu items. <img src= "connected.png" width="1200" alt="Connection Image" style="border: 2px solid grey;"> <a id="navigating-theartemis-views"></a> ## Navigating the Artemis Views -There are 2 Artemis views that are available from the left hand menu the **Artemis** View and the **Artemis JMX** view. -The former navigates around resources using a JMX tree and exposes the JMX Attributes and Operations of each MBean as well as -functionality exposed. The second is a set of tabs that exposes similar functionality but in tabular gviews and is not -related to specific mbeans. +There are two Artemis views that are available from the left hand menu the **Artemis** view and the **Artemis JMX** view. + +The [**Artemis JMX**](#artemis-jmx-view) view navigates around resources using a JMX tree and presents the JMX Attributes and Operations of each specific MBean as well as functionality exposed. + +The [**Artemis**](#artemis-view) view is a set of tabs that exposes functionality in tabular views for paginating over broker resources such as Addresses and Queues. <a id="artemis-jmx-view"></a> ### Artemis JMX View @@ -44,7 +57,7 @@ MBean is selected in the tree a set of related tabs become visible #### Default Tabs -All MBeans will show the following tabs by default which are exposed on all Mbeans. +All MBeans will show the following tabs by default which are exposed on all MBeans. ##### Attributes @@ -68,7 +81,7 @@ If the MBean selected is an Address MBean which are found under the *addresses* ##### Create Queue This tab will allow the user to create queues that are bound to the address that is selected. It exposes the ability to -configure a sub set of available paramaters on the queue, however extra configuration not exposed can be configured +configure a sub set of available parameters on the queue, however extra configuration not exposed can be configured using a set of key/value pairs, for instance delay-before-dispatch or auto-delete. ##### Delete Address @@ -88,9 +101,9 @@ It allows message headers to be added and a body. Note that the message type cre #### Queue Tabs -If the MBean selected is a *Queue* MBean then teh following tabs are displayed. +If the MBean selected is a *Queue* MBean then the following tabs are displayed. -> NOTE: Queue MBeans are found under the *Address* Mbean it is bound to. +> NOTE: Queue MBeans are found under the *Address* MBean it is bound to. > #### Browse Messages @@ -234,7 +247,7 @@ value to filter on by clicking the *Search* button. Clicking on the *Queue Count* value will navigate to the **Address** tab and filter on that address -The 3 dots on teh right of each Address will allow the user to perform the following operations. +The 3 dots on the right of each Address will allow the user to perform the following operations. ##### Show in Artemis JMX @@ -246,7 +259,7 @@ This will open up a dialog showing all the Queues MBean attributes and allow edi ##### Operations -This will open up a dialog showing all the Queues Mbean operations and allow execution of permissions allow. +This will open up a dialog showing all the Queues MBean operations and allow execution of permissions allow. ##### Delete Address @@ -267,7 +280,7 @@ It allows message headers to be added and a body. Note that the message type cre ##### Create Queue This will open up a dialog which will allow the user to create queues that are bound to the address that is selected. It exposes the ability to -configure a sub set of available paramaters on the queue, however extra configuration not exposed can be configured +configure a sub set of available parameters on the queue, however extra configuration not exposed can be configured using a set of key/value pairs, for instance delay-before-dispatch or auto-delete. @@ -296,11 +309,12 @@ This will then change the view to: <img src= "browse2.png" width="1200" alt="browse2 Image" style="border: 2px solid grey;"> -> NOTE: you can navigate to and from each view by using the *Queues* and the *Browse * button at th ebottom left hand corner. -> +> NOTE: You can navigate to and from each view by using the *Queues* and the *Browse * button at the bottom left hand corner. + + #### Broker Diagram -The **Broker Diagram** tab shows a visual representation of the Broker, its Addresses and Queue and any othe Broker that +The **Broker Diagram** tab shows a visual representation of the Broker, its Addresses and Queue and any other Broker that may be in the Cluster. You can choose which Nodes to show by clicking on the *Node Options* dropdown. Clicking on the node will also fetch up the Attributes of the MBean associated with the node. @@ -318,7 +332,7 @@ By default the console is locked down to 'localhost', pay particular attention t #### MBean Access -Access to MBeans is configured in ActiveMQ Artemis, see the [Management via JMX](https://activemq.apache.org/components/artemis/documentation/) chapter. +Access to MBeans is configured in ActiveMQ Artemis, see the [Management via JMX](https://activemq.apache.org/components/artemis/documentation/latest/management.html#management-via-jmx) chapter. Certain screen and tab visibility is controlled by the access to a specific JMX Operation, for instance the **Create Queue** tab is only shown if the user has access to the create queue JMX operation. @@ -327,23 +341,3 @@ tab is only shown if the user has access to the create queue JMX operation. Please refer to the [HawtIO Documentation](https://hawt.io/docs/oidc.html) - - - - - - - - - - - - - - - - - - - - diff --git a/src/components/artemis-console/documentation/deploying.md b/src/components/artemis-console/documentation/deploying.md index 669b9f214..6f4afa6d9 100644 --- a/src/components/artemis-console/documentation/deploying.md +++ b/src/components/artemis-console/documentation/deploying.md @@ -4,12 +4,14 @@ title: ActiveMQ Artemis Console Documentation title-class: page-title-artemis type: artemis --- -[Documentation](index) > [Getting Started](getting-started) +[Documentation](index) > [Deploying](deploying) ## Deploying embedded in ActiveMQ Artemis -Currently not supported. This will arrive in ActiveMQ Artemis 3.0. This is because the new console requires changes to use jakarta and other -possible breaking changes +Currently not supported. This will arrive in ActiveMQ Artemis 3.0. This is because the new console requires changes to use Jakarta APIs for the embedded +web server and other possible breaking changes not suited to make in Artemis 2.x releases. + +Prior to Artemis 3.0 the new console is aimed at deployment in standalone server, e.g as outlined below for Jetty and Tomcat. ## Deploying in Jetty @@ -36,9 +38,9 @@ java -Dhawtio.authenticationEnabled=false -jar $JETTY_HOME/start.jar > **_NOTE:_** Since this is only running the Connect plugin Hawtio > authentication is disabled. Authentication will take place on connection to > the Artemis Broker. -Connect a browser to [http:/localhost:8080/console](http:/localhost:8080/console) or the URL you configured for Jetty. +Connect a browser to [http://localhost:8080/console](http://localhost:8080/console) or the URL you configured for Jetty. -The [connecting](connecting) chapter explains how to connect to a running broker +The [connecting](console.html#connecting-to-the-broker) chapter explains how to connect to a running broker. For full information on deploying Applications in Jetty see [The Operations Guide](https://jetty.org/docs/jetty/12/operations-guide/index.html) @@ -47,7 +49,7 @@ For full information on deploying Applications in Jetty see [The Operations Guid Firstly you will need to install [Tomcat Version 10](https://tomcat.apache.org/download-10.cgi). -There are many ways to deploy a *WAR* file using Tomcat. The [Tomcat Documentation]{https://tomcat.apache.org/tomcat-10.1-doc) explains this in detail. +There are many ways to deploy a *WAR* file using Tomcat. The [Tomcat Documentation](https://tomcat.apache.org/tomcat-10.1-doc) explains this in detail. You will need to make sure that the context path for the console is configured to be */console*, if the war were configured in the tomcat *server.xml* this would look like: @@ -63,6 +65,6 @@ you can disable authentication by setting the property: export CATALINA_OPTS="-Dhawtio.authenticationEnabled=false" ``` -Once Tomcat is started connect a browser to [http:/localhost:8080/console](http:/localhost:8080/console) or the URL you configured for tomcat. +Once Tomcat is started connect a browser to [http://localhost:8080/console](http://localhost:8080/console) or the URL you configured for tomcat. -The [connecting](connecting) chapter explains how to connect to a running broker +The [connecting](console.html#connecting-to-the-broker) chapter explains how to connect to a running broker diff --git a/src/components/artemis-console/documentation/getting-started.md b/src/components/artemis-console/documentation/getting-started.md deleted file mode 100644 index a7ecc4c1d..000000000 --- a/src/components/artemis-console/documentation/getting-started.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: default_md -title: ActiveMQ Artemis Console Documentation -title-class: page-title-artemis -type: artemis ---- -[Documentation](index) - -* [Deploying](deploying) - * [Deploying in Artemis](deploying#Deploying-embedded in-ActiveMQ-Artemis) - * [Deploying in Jetty](deploying#deploying-in-jetty) - * [Deploying in Tomcat](deploying#deploying-in-tomcat) -* [Using the Console](console) - * [Connecting to the Broker](console#connecting-to-the-broker) - * [Navigating the Artemis Views](console#navigating-theartemis-views) - * [The Artemis JMX View](console#artemis-jmx-view) - * [The Artemis View](console#artemis-view) - diff --git a/src/components/artemis-console/documentation/index.md b/src/components/artemis-console/documentation/index.md index efdd0e379..1cf27383a 100644 --- a/src/components/artemis-console/documentation/index.md +++ b/src/components/artemis-console/documentation/index.md @@ -5,15 +5,14 @@ title-class: page-title-artemis type: artemis --- -* [Getting Started](getting-started) - * [Deploying](deploying) - * [Deploying in Artemis](deploying#Deploying-embedded in-ActiveMQ-Artemis) - * [Deploying in Jetty](deploying#deploying-in-jetty) - * [Deploying in Tomcat](deploying#deploying-in-tomcat) - * [Using the Console](console) - * [Connecting to the Broker](console#connecting-to-the-broker) - * [Navigating the Artemis Views](console#navigating-theartemis-views) - * [The Artemis JMX View](console#artemis-jmx-view) - * [The Artemis View](console#artemis-view) +* [Deploying](deploying) + * [Deploying in Artemis](deploying#Deploying-embedded in-ActiveMQ-Artemis) + * [Deploying in Jetty](deploying#deploying-in-jetty) + * [Deploying in Tomcat](deploying#deploying-in-tomcat) +* [Using the Console](console) + * [Connecting to the Broker](console#connecting-to-the-broker) + * [Navigating the Artemis Views](console#navigating-theartemis-views) + * [The Artemis JMX View](console#artemis-jmx-view) + * [The Artemis View](console#artemis-view) diff --git a/src/components/artemis-console/download/index.md b/src/components/artemis-console/download/index.md index 10f387c39..733574fd0 100644 --- a/src/components/artemis-console/download/index.md +++ b/src/components/artemis-console/download/index.md @@ -9,14 +9,14 @@ This is the current ActiveMQ Artemis Console release. ## ActiveMQ Artemis Console 1.0.0 (8th October 2024) -[Release Notes](https://issues.apache.org/jira/projects/ARTEMIS/versions/12354639) \| [Documentation](../documentation) +[Release Notes](https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=12315920&version=12354639) \| [Documentation](../documentation) |----------------------|--------------------------------------------------------|------------|-------------------| | tar.gz | [apache-artemis-console-1.0.0-bin.tar.gz](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-bin.tar.gz) | [SHA512](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-bin.tar.gz.sha512) | [GPG Signature](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-bin.tar.gz.asc) | | ZIP | [apache-artemis-console-1.0.0-bin.zip](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-bin.zip) | [SHA512](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-bin.zip.sha512) | [GPG Signature](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-bin.zip.asc) | | Source tar.gz | [apache-artemis-console-1.0.0-source-release.tar.gz](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.tar.gz) | [SHA512](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.tar.gz.sha512) | [GPG Signature](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.tar.gz.asc) | -| Source zip | [apache-artemis-console-1.0.0-source-release.zip](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.zip) | [SHA512](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.zip.sha512) | [GPG Signature](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.zip.asc) | +| Source ZIP | [apache-artemis-console-1.0.0-source-release.zip](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.zip) | [SHA512](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.zip.sha512) | [GPG Signature](https://downloads.apache.org/activemq/activemq-artemis-console/1.0.0/apache-artemis-console-1.0.0-source-release.zip.asc) | #### Verify the Integrity of Downloads diff --git a/src/components/artemis-console/index.md b/src/components/artemis-console/index.md index 5397966fb..677261fb7 100644 --- a/src/components/artemis-console/index.md +++ b/src/components/artemis-console/index.md @@ -1,14 +1,14 @@ --- layout: project_default_md project_name: ActiveMQ Artemis Console -project_info: The next Generation Artemis Console built on HawtIO 4 +project_info: The Next Generation Artemis Console built on HawtIO 4 project_class: artemis project_color: purple --- Apache ActiveMQ® Artemis Console is the next generation console for ActiveMQ Artemis that is built on top of [HawtIO](https://hawt.io/) and written using [React](https://react.dev/) and [Patternfly](https://www.patternfly.org/). -The console connects to the [Jolokia]() endpoint and allows the management of Artemis resources. +The console connects to the [Jolokia](https://jolokia.org/) endpoint and allows the management of Artemis resources. --- --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected] For further information, visit: https://activemq.apache.org/contact
