Skip to content

feature: Customer Registry quickstart bootstrap#203

Merged
patriknw merged 11 commits intolightbend:mainfrom
ennru:ennru-init-quickstart
Aug 18, 2021
Merged

feature: Customer Registry quickstart bootstrap#203
patriknw merged 11 commits intolightbend:mainfrom
ennru:ennru-init-quickstart

Conversation

@ennru
Copy link
Copy Markdown
Member

@ennru ennru commented Aug 10, 2021

This adds a copy of relevant parts of the java-customer-registry sample as a base for the quickstart sources.

Discovered #202

Refs https://github.com/lightbend/akkaserverless-framework/issues/738

@ennru ennru added the team-runtime Runtime and SDKs sub-team label Aug 10, 2021
@rstento
Copy link
Copy Markdown
Contributor

rstento commented Aug 12, 2021

@raboof @patriknw, @ennru mentioned that one of you would be moving this PR forward while he is on vacation, do you need anything from me?

@raboof
Copy link
Copy Markdown
Contributor

raboof commented Aug 12, 2021

mentioned that one of you would be moving this PR forward while he is on vacation, do you need anything from me?

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?

@rstento
Copy link
Copy Markdown
Contributor

rstento commented Aug 12, 2021

mentioned that one of you would be moving this PR forward while he is on vacation, do you need anything from me?

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.

@raboof
Copy link
Copy Markdown
Contributor

raboof commented Aug 13, 2021

I've brought the sample more in line with the codegen and fixed a few issues (#202, #206), now running into #207 while creating the integrationtests (WIP in dd836eb)

@raboof raboof marked this pull request as ready for review August 17, 2021 10:52
@rstento rstento requested a review from patriknw August 17, 2021 15:11
Copy link
Copy Markdown
Contributor

@rstento rstento left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


## Building

To build, at a minimum you need to generate and process sources, particularly when using an IDE.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this sentence makes sense in the context of this sample, but I'm not sure how to change it?

Copy link
Copy Markdown
Contributor

@raboof raboof Aug 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@raboof raboof Aug 18, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

that is a great question that I don't know the answer to offhand. let's ticketify, #211

Copy link
Copy Markdown
Contributor

@patriknw patriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good. @raboof is this ready for merge? Pls apply Ruth's suggestions.

.setEmail("foo@example.com")
.build())
.toCompletableFuture()
.get();
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created issue #210 for this

@raboof
Copy link
Copy Markdown
Contributor

raboof commented Aug 18, 2021

I think I covered all the feedback and this is ready to merge now

Copy link
Copy Markdown
Contributor

@patriknw patriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@patriknw patriknw merged commit 916fd89 into lightbend:main Aug 18, 2021
@ennru ennru deleted the ennru-init-quickstart branch August 19, 2021 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

team-runtime Runtime and SDKs sub-team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants