{"id":2314,"date":"2017-01-04T17:39:32","date_gmt":"2017-01-04T17:39:31","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=2314"},"modified":"2023-08-10T23:41:25","modified_gmt":"2023-08-11T06:41:25","slug":"microservices-wildfly-swarm-docker-couchbase","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/microservices-wildfly-swarm-docker-couchbase\/","title":{"rendered":"Microservices using WildFly Swarm, Docker and Couchbase"},"content":{"rendered":"

Containers, Microsoervices, and NoSQL provide an awesome threesome for building your modern applications. These applications\u00a0need to be agile, meet\u00a0constantly evolving customer demands, be pervasive, and should work across mobile, web and IoT platforms.<\/p>\n

This blog will\u00a0explain a simple microservices stack using WildFly Swarm<\/a>, Docker<\/a>, and Couchbase<\/a>. Complete code and instructions in this blog are documented at:\u00a0github.com\/arun-gupta\/wildfly-swarm-couchbase<\/a>.<\/p>\n

Let’s\u00a0understand the key components of this stack first!<\/p>\n

\"wildfly-swarm-logo\"<\/a>WildFly Swarm<\/a> allows\u00a0to package and run JavaEE applications by packaging them with just enough of the server runtime to java -jar<\/code> your application. With built-in service discovery, single sign-on using Keycloak<\/a>, monitoring using Hawkular<\/a>, and many more features, WildFly Swarm provides all the necessary components to\u00a0develop your\u00a0microservice.<\/p>\n

\"docker-for-mac\"<\/a><\/p>\n

Docker for Mac<\/a> provides native support for running Docker containers on Mac OSX. It relies upon Hypervisor.framework<\/code>\u00a0in OSX.\u00a0Docker engine runs in an Alpine Linux distribution on top of an xhyve<\/code> Virtual Machine, and even the VM is managed by Docker.\u00a0There is no need for\u00a0Docker Machine or VirtualBox, and it integrates with OSX security sandbox model.\u00a0DockerCon 2016\u00a0removed the private beta restriction from\u00a0Docker for Mac, and so its available for everybody now. \"Couchbase<\/p>\n

NoSQL<\/a> provides the\u00a0agility and flexibility of\u00a0schema-less databases. This allows the application to evolve independently and rapidly\u00a0without going through cumbersome\u00a0database migrations. Couchbase offers true horizontal scaling with homogenous architecture<\/a>, as opposed to\u00a0non-scalable master\/slave architecture. It also offers auto-sharding, SQL-like query language for JSON<\/a> (N1QL), mobile database<\/a>\u00a0and synchronization with the backend server, and much more. The complete sample application in this blog is at:\u00a0github.com\/arun-gupta\/wildfly-swarm-couchbase<\/a>.<\/p>\n

WildFly Swarm Application<\/h2>\n

Let’s look at the Java\u00a0EE\u00a0REST endpoint:<\/p>\n

package com.couchbase.wildfly.swarm;\r\n\r\n. . .\r\n\r\n@Path(\"airline\")\r\npublic class AirlineResource {\r\n\r\n    @Inject Database database;\r\n        \r\n    @GET\r\n    public String getAll() {\r\n        N1qlQuery query = N1qlQuery.simple(\"SELECT * FROM `travel-sample` LIMIT 10\");\r\n        N1qlQueryResult result = database.getBucket().query(query);\r\n        return result.allRows().toString();\r\n    }\r\n    \r\n. . .\r\n}<\/pre>\n
It uses standard JAX-RS annotation to convert a POJO into a REST endpoint.\u00a0Couchbase Java API<\/a>\u00a0provide a fluent API and used N1QL statement to query the\u00a0documents and return the results. The N1QL statement returns the first 10 elements from\u00a0the query result. Learn more about N1QL syntax in this interactive tutorial<\/a>. Database\u00a0abstraction is defined as:<\/p>\n
package com.couchbase.wildfly.swarm;\r\n\r\n. . .\r\n\r\n@Singleton\r\n@Startup\r\npublic class Database {\r\n    \r\n    CouchbaseCluster cluster;\r\n    Bucket bucket;\r\n        \r\n    public CouchbaseCluster getCluster() {\r\n        if (null == cluster) {\r\n            String couchbaseURI = System.getenv(\"COUCHBASE_URI\");\r\n            if (null == couchbaseURI) {\r\n                System.err.println(\"WARING: No COUCHBASE_URI specified, defaulting to localhost\");\r\n                couchbaseURI = \"localhost:8093\";\r\n            }\r\n            System.out.println(\"Couchbase endpoint: \" + System.getenv(\"COUCHBASE_URI\"));\r\n            cluster = CouchbaseCluster.create(couchbaseURI);\r\n        }\r\n        return cluster;\r\n    }\r\n    \r\n    public Bucket getBucket() {\r\n        if (null == bucket) {\r\n            bucket = getCluster().openBucket(\"travel-sample\");\r\n        }\r\n        return bucket;\r\n    }\r\n}<\/pre>\n
This is a singleton EJB that is eagerly initialized. It uses Couchbase Java SDK<\/a> to connect to Couchbase.\u00a0Database endpoint can be specified using the\u00a0COUCHBASE_URI<\/code> environment variable. Next up is\u00a0pom.xml<\/code>\u00a0for configuring\u00a0the\u00a0WildFly Swarm and Couchbase Java Client<\/a>:<\/p>\n
        \r\n            \r\n                org.wildfly.swarm\r\n                bom\r\n                ${version.wildfly-swarm}\r\n                pom\r\n                import\r\n            \r\n        \r\n    \r\n    \r\n        \r\n            javax\r\n            javaee-web-api\r\n            7.0\r\n            provided\r\n        \r\n        \r\n            org.wildfly.swarm\r\n            jaxrs-cdi\r\n        \r\n        \r\n            org.wildfly.swarm\r\n            ejb\r\n        \r\n        \r\n            com.couchbase.client\r\n            java-client\r\n            2.2.5\r\n        \r\n<\/pre>\n
It uses WildFly Swarm “bill of materials” to pull in all the dependencies. Only the specific\u00a0dependencies needed for the build are specified in <\/code>. These are then packaged in the “fat jar”. WildFly Swarm Maven plugin is used to package and run the application:<\/p>\n
                org.wildfly.swarm\r\n                wildfly-swarm-plugin\r\n                ${version.wildfly-swarm}\r\n                \r\n                    \r\n                        \r\n                            package\r\n                        \r\n                    \r\n                \r\n                \r\n                    \r\n                        ${COUCHBASE_URI}\r\n                    \r\n                \r\n<\/pre>\n
COUCHBASE_URI<\/code> is used to read the\u00a0host of where Couchbase database server is running.<\/p>\n
Run Couchbase Server<\/h2>\n
Run the Couchbase server using Docker for Mac:<\/p>\n
docker run -d --name db -p 8091-8093:8091-8093 -p 11210:11210 arungupta\/couchbase<\/pre>\n
The arungupta\/couchbase<\/code>\u00a0is built upon the standard Couchbase image<\/a>\u00a0and uses Couchbase REST API<\/a> to configure the server. Wait for a couple of minutes for the sample bucket to be populated with the JSON documents. Invoke the Couchbase CLI tool cbq<\/a>\u00a0create a primary index on the sample bucket:<\/p>\n
docker run -it --link db:db arungupta\/couchbase cbq -u Administrator -p password -engine https:\/\/db:8093 -s \"create primary index `travel-sample-primary-index` on `travel-sample`;\"<\/pre>\n
This will show the output as:<\/p>\n
 Connected to : https:\/\/db:8093\/. Type Ctrl-D or QUIT to exit.\r\n\r\n Path to history file for the shell : \/root\/.cbq_history \r\n{\r\n    \"requestID\": \"d0b2e4dd-b702-49e2-971c-a4c640ddb498\",\r\n    \"signature\": null,\r\n    \"results\": [\r\n    ],\r\n    \"status\": \"success\",\r\n    \"metrics\": {\r\n        \"elapsedTime\": \"3.154540272s\",\r\n        \"executionTime\": \"3.154493281s\",\r\n        \"resultCount\": 0,\r\n        \"resultSize\": 0\r\n    }\r\n}<\/pre>\n
This output shows that result of creating index was successful. One of the advantages of running Docker for Mac is that all the containers are accessible at localhost<\/code>. This means Couchbase\u00a0Web Console<\/a> can be accessed at\u00a0localhost:8091<\/a>. \"couchbase-web-console-docker-mac-wildfly-swarm-microsoervice\"<\/a><\/p>\n
This screen ensures that\u00a0Couchbase is configured \u00a0correctly.<\/p>\n
Run WildFly Swarm Microservice<\/h2>\n
Package and run the\u00a0self-contained microservice as:<\/p>\n
mvn wildfly-swarm:run<\/pre>\n
If Couchbase is running on a different host, then the command will change to:<\/p>\n
mvn -DCOUCHBASE_URI= wildfly-swarm:run<\/pre>\n
It shows the output as:<\/p>\n
[INFO] Scanning for projects...\r\n[INFO]                                                                         \r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Building nosql-microservices 1.0-SNAPSHOT\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] \r\n\r\n. . . \r\n\r\n2016-06-27 22:21:47,170 WARN  [org.jboss.as.dependency.private] (MSC service thread 1-6) WFLYSRV0018: Deployment \"deployment.nosql-microservices.war\" is using a private module (\"org.jboss.jts:main\") which may be changed or removed in future versions without notice.\r\n2016-06-27 22:21:47,203 INFO  [org.jboss.weld.deployer] (MSC service thread 1-1) WFLYWELD0003: Processing weld deployment nosql-microservices.war\r\n2016-06-27 22:21:47,542 INFO  [org.hibernate.validator.internal.util.Version] (MSC service thread 1-1) HV000001: Hibernate Validator 5.2.3.Final\r\n2016-06-27 22:21:47,600 INFO  [org.jboss.as.ejb3.deployment] (MSC service thread 1-1) WFLYEJB0473: JNDI bindings for session bean named 'Database' in deployment unit 'deployment \"nosql-microservices.war\"' are as follows:\r\n\r\n java:global\/nosql-microservices\/Database!com.couchbase.wildfly.swarm.Database\r\n java:app\/nosql-microservices\/Database!com.couchbase.wildfly.swarm.Database\r\n java:module\/Database!com.couchbase.wildfly.swarm.Database\r\n java:global\/nosql-microservices\/Database\r\n java:app\/nosql-microservices\/Database\r\n java:module\/Database\r\n\r\n2016-06-27 22:21:47,731 INFO  [org.jboss.weld.deployer] (MSC service thread 1-3) WFLYWELD0006: Starting Services for CDI deployment: nosql-microservices.war\r\n2016-06-27 22:21:47,758 INFO  [org.jboss.weld.Version] (MSC service thread 1-3) WELD-000900: 2.3.2 (Final)\r\n2016-06-27 22:21:47,780 INFO  [org.wildfly.extension.undertow] (MSC service thread 1-1) WFLYUT0018: Host default-host starting\r\n2016-06-27 22:21:47,788 INFO  [org.jboss.weld.deployer] (MSC service thread 1-8) WFLYWELD0009: Starting weld service for deployment nosql-microservices.war\r\n2016-06-27 22:21:48,180 INFO  [stdout] (ServerService Thread Pool -- 10) Couchbase endpoint: \r\n2016-06-27 22:21:48,275 INFO  [com.couchbase.client.core.CouchbaseCore] (ServerService Thread Pool -- 10) CouchbaseEnvironment: {sslEnabled=false, sslKeystoreFile='null', sslKeystorePassword='null', queryEnabled=false, queryPort=8093, bootstrapHttpEnabled=true, bootstrapCarrierEnabled=true, bootstrapHttpDirectPort=8091, bootstrapHttpSslPort=18091, bootstrapCarrierDirectPort=11210, bootstrapCarrierSslPort=11207, ioPoolSize=8, computationPoolSize=8, responseBufferSize=16384, requestBufferSize=16384, kvServiceEndpoints=1, viewServiceEndpoints=1, queryServiceEndpoints=1, searchServiceEndpoints=1, ioPool=NioEventLoopGroup, coreScheduler=CoreScheduler, eventBus=DefaultEventBus, packageNameAndVersion=couchbase-jvm-core\/1.2.5 (git: 1.2.5), dcpEnabled=false, retryStrategy=BestEffort, maxRequestLifetime=75000, retryDelay=ExponentialDelay{growBy 1.0 MICROSECONDS, powers of 2; lower=100, upper=100000}, reconnectDelay=ExponentialDelay{growBy 1.0 MILLISECONDS, powers of 2; lower=32, upper=4096}, observeIntervalDelay=ExponentialDelay{growBy 1.0 MICROSECONDS, powers of 2; lower=10, upper=100000}, keepAliveInterval=30000, autoreleaseAfter=2000, bufferPoolingEnabled=true, tcpNodelayEnabled=true, mutationTokensEnabled=false, socketConnectTimeout=1000, dcpConnectionBufferSize=20971520, dcpConnectionBufferAckThreshold=0.2, queryTimeout=75000, viewTimeout=75000, kvTimeout=2500, connectTimeout=5000, disconnectTimeout=25000, dnsSrvEnabled=false}\r\n2016-06-27 22:21:48,829 INFO  [com.couchbase.client.core.node.Node] (cb-io-1-1) Connected to Node localhost\r\n2016-06-27 22:21:49,035 INFO  [com.couchbase.client.core.config.ConfigurationProvider] (cb-computations-1) Opened bucket travel-sample\r\n2016-06-27 22:21:49,415 INFO  [org.jboss.resteasy.resteasy_jaxrs.i18n] (ServerService Thread Pool -- 10) RESTEASY002225: Deploying javax.ws.rs.core.Application: class com.couchbase.wildfly.swarm.MyApplication\r\n2016-06-27 22:21:49,438 INFO  [org.wildfly.extension.undertow] (ServerService Thread Pool -- 10) WFLYUT0021: Registered web context: \/\r\n2016-06-27 22:21:49,457 INFO  [org.jboss.as.server] (main) WFLYSRV0010: Deployed \"nosql-microservices.war\" (runtime-name : \"nosql-microservices.war\")<\/pre>\n
Now the application can be accessed as:<\/p>\n
curl https:\/\/localhost:8080\/webresources\/airline<\/pre>\n
And\u00a0a formatted output looks like:<\/p>\n
[\r\n  {\r\n    \"travel-sample\": {\r\n      \"country\": \"United States\",\r\n      \"iata\": \"Q5\",\r\n      \"callsign\": \"MILE-AIR\",\r\n      \"name\": \"40-Mile Air\",\r\n      \"icao\": \"MLA\",\r\n      \"id\": 10,\r\n      \"type\": \"airline\"\r\n    }\r\n  },\r\n\r\n  . . .\r\n\r\n  {\r\n    \"travel-sample\": {\r\n      \"country\": \"France\",\r\n      \"iata\": \"A5\",\r\n      \"callsign\": \"AIRLINAIR\",\r\n      \"name\": \"Airlinair\",\r\n      \"icao\": \"RLA\",\r\n      \"id\": 1203,\r\n      \"type\": \"airline\"\r\n    }\r\n  }\r\n]<\/pre>\n
So you built a simple microservice using WildFly Swarm accessing a Couchbase database running as a Docker container. Now, ideally this WildFly Swarm\u00a0service should be packaged as a Docker image and then that Docker image would serve as the service.\u00a0A\u00a0Maven profile with the name docker<\/code> is already added to pom.xml<\/code> but issue #3<\/a> is\u00a0making that scenario fail.<\/p>\n
Microservices References<\/h2>\n