gtully commented on code in PR #4297: URL: https://github.com/apache/activemq-artemis/pull/4297#discussion_r1188786028
########## artemis-image/README.md: ########## @@ -0,0 +1,97 @@ +###What is in the image + +An _empty_, _open_ broker with a default acceptor on port 61616 + + - by empty: has no addresses or queues but will auto create on demand + - by open: has no security; authentication or authorization, users or roles + +###How will the image behave + + 1) the image will use or create `/app/data` for persistence of data + + 2) the image will use any [.properties files](https://activemq.apache.org/components/artemis/documentation/latest/configuration-index.html#broker_properties) from `/app/etc` to augment configuration + + 3) the image will use `/app/etc/broker.xml` if present, to bootstrap configuration, the 'bring your own config' use case + +###Build and Use + +First build an OCI image tar file from this artemis project using mvn: + + `$> mvn install` + +An OCI image is created as a tar file. + +> *Note that any OCI compatible container runtime and registry can be used for the next steps, eg: docker, podman... I have used podman.* + +To load the image tar into a registry, use: + + `$> podman image load --input target/jib-image.tar` + +To run the image with host network access, localhost:61616 will be visible, use: + + `$> podman run --net=host localhost/target/activemq-artemis-image:<...>` + +Execute the artemis producer/consumer command line tools from a `local distribution` to validate: +Note: there is a `local distribution` in ../artemis-distribution/target/apache-artemis-<version>-bin/apache-artemis-<version>/ Review Comment: agree, will remove the suggestion to use the local distro. ########## artemis-image/README.md: ########## @@ -0,0 +1,93 @@ +###What is in the image + +An _empty_, _open_ broker with a default acceptor on port 61616 + + - by empty: has no addresses or queues but will auto create on demand + - by open: has no security; authentication or authorization, users or roles + +###How will the image behave + + 1) the image will use or create `/app/data` for persistence of data + + 2) the image will use any [.properties files](https://activemq.apache.org/components/artemis/documentation/latest/configuration-index.html#broker_properties) from `/app/etc` to augment configuration + + 3) the image will use `/app/etc/broker.xml` if present, to bootstrap configuration, the 'bring your own config' use case + +###Build and Use + +First build an OCI image tar file from this artemis project using mvn: + + `$> mvn install` + +An OCI image is created as a tar file, that tar can be loaded into a registry, eg: + + `$> podman image load --input target/jib-image.tar` + +To run the image with host network access, localhost:61616 will be visible, use: + + `$> podman run --net=host localhost/target/activemq-artemis-image:<...>` + +Execute the artemis producer/consumer command line tools from a `local distribution` to validate: +Note: there is a `local distribution` in ../artemis-distribution/target/apache-artemis-<version>-bin/apache-artemis-<version>/ + + `$> ./bin/artemis producer --url tcp://127.0.0.1:61616` + + `$> ./bin/artemis consumer --url tcp://127.0.0.1:61616` + +###Intent + +The intent is that this image is useful as is. If one can trust users, having no access control or limits can work fine. + +If not, then this image can be configured by mounting an `/app/etc` directory with property files that augment default configuration. +This image could also be the base for a derived jib image, by simply adding more property files to the `src/main/resources` directory. + +###Examples Review Comment: will sort. thanks -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
