user-registry

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 service. To understand more about these components, see Developing services and check Spring-SDK official documentation. Examples can be found here in the folders with "spring" in their name.

Use Maven to build your project:

mvn compile

When running a Kalix service locally, we need to have its companion Kalix Proxy running alongside it.

To start your service locally, run:

mvn kalix:runAll

This command will start your Kalix service and a companion Kalix Proxy as configured in docker-compose.yml file.

With both the proxy and your service 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 kalix:deploy which will conveniently package, publish your docker image, and deploy your service to Kalix, or by first packaging and publishing the docker image through mvn deploy and then deploying the image through the kalix CLI.