feature: Customer Registry quickstart bootstrap#203
feature: Customer Registry quickstart bootstrap#203patriknw merged 11 commits intolightbend:mainfrom ennru:ennru-init-quickstart
Conversation
I can start having a look tomorrow. I see one of the open tasks is to add an integration test. Is there anything else you'd like to be done here? |
Hi @raboof! I'm not sure. I know that one goal was to separate out the event sourced entity because this initial Quickstart is to demonstrate a Value entity and a View. When I finish today, I will create a draft PR with what I have written so far for the Quickstart so that you can get an idea of where its going. |
Kept README grpcurl examples for this project
Fixes the problem filed as #202
rstento
left a comment
There was a problem hiding this comment.
I know this readme was probably inserted from the codegen template. That template also needs some of these changes.
|
|
||
| ## Designing | ||
|
|
||
| While designing your service it is useful to read [designing services](https://developer.lightbend.com/docs/akka-serverless/designing/index.html) |
There was a problem hiding this comment.
| While designing your service it is useful to read [designing services](https://developer.lightbend.com/docs/akka-serverless/designing/index.html) | |
| To understand the Akka Serverless concepts that are a basis for this example, see [Designing services](https://developer.lightbend.com/docs/akka-serverless/designing/index.html) in the documentation. |
|
|
||
| ## Developing | ||
|
|
||
| This project has a bare-bones skeleton service ready to go, but in order to adapt and |
There was a problem hiding this comment.
| This project has a bare-bones skeleton service ready to go, but in order to adapt and | |
| This project demonstrates use of Value Entity and View components. |
| ## Developing | ||
|
|
||
| This project has a bare-bones skeleton service ready to go, but in order to adapt and | ||
| extend it it may be useful to read up on [developing services](https://developer.lightbend.com/docs/akka-serverless/developing/index.html) |
There was a problem hiding this comment.
| extend it it may be useful to read up on [developing services](https://developer.lightbend.com/docs/akka-serverless/developing/index.html) | |
| To understand more about these components, see |
|
|
||
| This project has a bare-bones skeleton service ready to go, but in order to adapt and | ||
| extend it it may be useful to read up on [developing services](https://developer.lightbend.com/docs/akka-serverless/developing/index.html) | ||
| and in particular the [Java section](https://developer.lightbend.com/docs/akka-serverless/java-services/index.html) |
|
|
||
| ## Building | ||
|
|
||
| To build, at a minimum you need to generate and process sources, particularly when using an IDE. |
There was a problem hiding this comment.
Not sure this sentence makes sense in the context of this sample, but I'm not sure how to change it?
There was a problem hiding this comment.
I agree this is a confusing sentence. Maybe just let's say "You can use Maven to build your project, which will also take care of generating code based on the .proto definitions:"?
(this should probably be updated everywhere)
|
|
||
| ## Running Locally | ||
|
|
||
| In order to run your application locally, you must run the Akka Serverless proxy. The included `docker-compose` file contains the configuration required to run the proxy for a locally running application. |
There was a problem hiding this comment.
| In order to run your application locally, you must run the Akka Serverless proxy. The included `docker-compose` file contains the configuration required to run the proxy for a locally running application. | |
| To run the example locally, you must run the Akka Serverless proxy. The included `docker-compose` file contains the configuration required to run the proxy. |
| [Setting up a local development environment](https://developer.lightbend.com/docs/akka-serverless/getting-started/set-up-development-env.html) | ||
| and configure a Docker Registry to upload your docker image to. | ||
|
|
||
| You will need to update the `akkasls.dockerImage` property in the `pom.xml` and refer to |
There was a problem hiding this comment.
It looks to me like the property is dockerImage not akkasls.dockerImage?
| [Configuring registries](https://developer.lightbend.com/docs/akka-serverless/deploying/registries.html) | ||
| for more information on how to make your docker image available to Akka Serverless. | ||
|
|
||
| Finally you can or use the [Akka Serverless Console](https://console.akkaserverless.com) |
There was a problem hiding this comment.
| Finally you can or use the [Akka Serverless Console](https://console.akkaserverless.com) | |
| Finally you can use `akkasls` or the [Akka Serverless Console](https://console.akkaserverless.com) |
|
|
||
| Finally you can or use the [Akka Serverless Console](https://console.akkaserverless.com) | ||
| to create a project and then deploy your service into the project either by using `mvn deploy`, | ||
| through the `akkasls` CLI or via the web interface. When using `mvn deploy`, Maven will also |
There was a problem hiding this comment.
The way this sentence reads, it sounds like they can use mvn deploy in the web interface. It needs to be rewritten because if they use the console, they still need to package and publish the image. Is there a separate mvn target for that that doesn't deploy? If not, we should just tell them to use the CLI.
There was a problem hiding this comment.
that is a great question that I don't know the answer to offhand. let's ticketify, #211
| .setEmail("foo@example.com") | ||
| .build()) | ||
| .toCompletableFuture() | ||
| .get(); |
There was a problem hiding this comment.
I think we should always have a timeout on such get()
| loglevel = "DEBUG" | ||
| logging-filter = "akka.event.slf4j.Slf4jLoggingFilter" | ||
| } | ||
| } No newline at end of file |
|
I think I covered all the feedback and this is ready to merge now |
This adds a copy of relevant parts of the
java-customer-registrysample as a base for the quickstart sources.Discovered #202
Refs https://github.com/lightbend/akkaserverless-framework/issues/738