To understand the Kalix concepts that are the basis for this example, see Designing services in the documentation.
This project contains the framework to create a Kalix application by adding Kalix components. To understand more about these components, see Developing services. Spring-SDK is an experimental feature and so far there is no official documentation. Examples can be found here in the folders with "spring" in their name.
Use Maven to build your project:
mvn compileTo run the example locally, you must run the Kalix proxy. The included docker-compose file contains the configuration required to run the proxy for a locally running application.
It also contains the configuration to start a local Google Pub/Sub emulator that the Kalix proxy will connect to.
To start the proxy, run the following command from this directory:
docker-compose upTo start the application locally, the exec-maven-plugin is used. Use the following command:
mvn spring-boot:runWith both the proxy and your application running, once you have defined endpoints they should be available at http://localhost:9000.
To deploy your service, install the kalix CLI as documented in
Setting up a local development environment
and configure a Docker Registry to upload your docker image to.
You will need to update the dockerImage property in the pom.xml and refer to
Configuring registries
for more information on how to make your docker image available to Kalix.
Finally, you can use the Kalix Console
to create a project and then deploy your service into the project either by using mvn deploy which
will also conveniently package and publish your docker image prior to deployment, or by first packaging and
publishing the docker image through mvn clean package docker:push -DskipTests and then deploying the image
through the kalix CLI.