diff --git a/Makefile b/Makefile index 93d0c8da7..b33e17530 100644 --- a/Makefile +++ b/Makefile @@ -44,7 +44,7 @@ attributes: prepare > "${managed_partials}/attributes.adoc" docs/bin/version.sh | xargs -0 printf ":akka-javasdk-version: %s" \ > "${managed_partials}/attributes.adoc" - echo ":akka-cli-version: 3.0.8" >> "${managed_partials}/attributes.adoc" + echo ":akka-cli-version: 3.0.10" >> "${managed_partials}/attributes.adoc" echo ":akka-cli-min-version: 3.0.4" >> "${managed_partials}/attributes.adoc" # see https://adoptium.net/marketplace/ echo ":java-version: 21" \ diff --git a/docs/src/modules/concepts/images/geo-c.svg b/docs/src/modules/concepts/images/geo-c.svg index bf735f660..eccf84f9a 100644 --- a/docs/src/modules/concepts/images/geo-c.svg +++ b/docs/src/modules/concepts/images/geo-c.svg @@ -1,191 +1,93 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/geo-d.svg b/docs/src/modules/concepts/images/geo-d.svg index 65f4ebf18..7f307696d 100644 --- a/docs/src/modules/concepts/images/geo-d.svg +++ b/docs/src/modules/concepts/images/geo-d.svg @@ -1,222 +1,94 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/geo-e.svg b/docs/src/modules/concepts/images/geo-e.svg new file mode 100644 index 000000000..faae05440 --- /dev/null +++ b/docs/src/modules/concepts/images/geo-e.svg @@ -0,0 +1,93 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/steps-1.svg b/docs/src/modules/concepts/images/steps-1.svg new file mode 100644 index 000000000..f31eff7fc --- /dev/null +++ b/docs/src/modules/concepts/images/steps-1.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/steps-2.svg b/docs/src/modules/concepts/images/steps-2.svg new file mode 100644 index 000000000..6681d8d2f --- /dev/null +++ b/docs/src/modules/concepts/images/steps-2.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/steps-3.svg b/docs/src/modules/concepts/images/steps-3.svg new file mode 100644 index 000000000..d6438f67c --- /dev/null +++ b/docs/src/modules/concepts/images/steps-3.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/steps-4.svg b/docs/src/modules/concepts/images/steps-4.svg new file mode 100644 index 000000000..d82d4ecb1 --- /dev/null +++ b/docs/src/modules/concepts/images/steps-4.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/steps-5.svg b/docs/src/modules/concepts/images/steps-5.svg new file mode 100644 index 000000000..97150066f --- /dev/null +++ b/docs/src/modules/concepts/images/steps-5.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/images/steps-6.svg b/docs/src/modules/concepts/images/steps-6.svg new file mode 100644 index 000000000..eb9d6f93f --- /dev/null +++ b/docs/src/modules/concepts/images/steps-6.svg @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/src/modules/concepts/pages/multi-region.adoc b/docs/src/modules/concepts/pages/multi-region.adoc index 2b2091478..f7d995fe2 100644 --- a/docs/src/modules/concepts/pages/multi-region.adoc +++ b/docs/src/modules/concepts/pages/multi-region.adoc @@ -16,40 +16,48 @@ Multi-region operations are ideal for: * Low latency global reads * Low latency global writes -== Examples +== Replicated reads -The two main replication strategies that Akka offers are replicated reads, and replicated writes. - -=== Replicated reads - -With replicated reads, an entity has its "home" in one primary region, while being replicated to multiple other regions. +Akka's replicated reads offers full data replication across regions and even cloud providers, without any changes to the service implementation: an entity has its "home" in one _primary region_, while being replicated to multiple other regions. image:geo-a.svg[Geo data replication, width=600] -In the example above, the entity representing Alice has its primary region in Los Angeles (USA). When a user in the primary region performs a read request, the request is handled locally, and the response sent straight back. +In the image above, the entity representing Alice has its primary region in Los Angeles. When a user A in the primary region performs a read request image:steps-1.svg[width=20], the request is handled locally, and the response sent straight back image:steps-2.svg[width=20]. + +When the user in the primary region performs a write request image:steps-1.svg[width=20], that request is also handled locally, and a response sent directly back image:steps-2.svg[width=20]. After that write request completes, that write is replicated to other regions image:steps-3.svg[width=20], such as in London (UK). -When the user in the primary region performs a write request, that request is also handled locally, and a response sent directly back. After that write request completes, that write is replicated to other regions, such as in London (UK). A user in London, when they perform a read, that read operation will happen locally, and a response sent immediately back. +A user B in London, when they perform a read image:steps-4.svg[width=20], that read operation will happen locally, and a response sent immediately back image:steps-5.svg[width=20]. A user can also perform write operations on entities in non-primary regions. image:geo-b.svg[Geo data replication, width=600] -In this scenario, a user in London (UK) is performing a write operation on the Alice entity. Since London is not the primary region for the Alice entity, Akka will automatically forward that request to the primary region, in this case, Los Angeles (USA). That request will be handled in the USA, and a response sent directly back to the user. - -Akka has a configurable primary selection mode. The two main modes are static, and dynamic. In the static primary selection mode, the primary region for an entity is selected statically as part of the deployment, so all entities have the same primary region. This is useful for scenarios where you want one primary region, with the ability to failover to another region in the case of a regional outage. - -In the dynamic primary selection mode, each entity can have a different region that is considered its primary region. This is selected based on whichever region the entity was first written in. This is useful for scenarios where you want to have the primary region for you data close to the users who use the data. A user, Alice, in the USA, will have her data in the USA, while a user Bob, in the UK, will have his data, in the UK. +In this scenario, the user B in London (UK) is performing a write operation on the Alice entity image:steps-1.svg[width=20]. Since London is not the primary region for the Alice entity, Akka will automatically forward that request to the primary region image:steps-2.svg[width=20], in this case, Los Angeles (USA). That request will be handled in the USA, and a response sent directly back to the user image:steps-3.svg[width=20]. image:geo-c.svg[Geo data replication, width=600] -When Bob makes a request in the UK on his data, that request is handled locally, and replicated to the US, while Alice's requests in the USA with her data are handled locally in the USA, and replicated to the UK. +When Bob makes a request in the UK on his data image:steps-1.svg[width=20], that request is handled locally image:steps-2.svg[width=20], and replicated to the US image:steps-3.svg[width=20]. Exactly the same as Alice's requests in the USA with her data are handled locally in the USA, and replicated to the UK. -The data however is still available in all regions. If Bob travels to the USA, he can still access his data. +The data however is still available in all regions. If Bob travels to the USA, he can access his data in the Los Angeles region. image:geo-d.svg[Geo data replication, width=600] -When Bob travels to the USA, read requests that Bob makes on his data are handled locally, while write requests are forwarded to the UK. Meanwhile, write requests made by Alice on her data is all handled locally, with writes being replicated to the UK. +When Bob travels to the USA, read requests that Bob makes on his data are handled locally image:steps-1.svg[width=20] and getting an immediate reply image:steps-3.svg[width=20]. Write requests, on the other hand, are forwarded to the UK image:steps-2.svg[width=20], before the reply is sent image:steps-3.svg[width=20]. + +image:geo-e.svg[Geo data replication, width=600] + +Meanwhile, all requests made by Alice on her data are handled locally image:steps-1.svg[width=20] and get an immediate reply image:steps-2.svg[width=20]. The write operations are being replicated to the UK image:steps-3.svg[width=20]. + +=== Primary selection + +How Akka assigns the primary region to an entity is configurable. The two main modes are **static**, and **dynamic**. + +In the **static primary selection** mode (which is the default), the primary region for an entity is selected statically as part of the deployment, so all entities have the same primary region. This is useful for scenarios where you want one primary region, with the ability to fail over to another region in the case of a regional outage. + +In the **dynamic primary selection** mode, each entity can have a different region that is considered its primary region. This is selected based on whichever region the entity was first written in. This is useful for scenarios where you want to have the primary region for you data close to the users who use the data. A user, Alice, in the USA, will have her data in the USA, while a user Bob, in the UK, will have his data, in the UK. + +The Operating section explains more details about xref:operations:regions/index.adoc#selecting-primary[configuring the primary selection mode]. -=== Replicated writes +== Replicated writes The replicated write replication strategy allows every region to be capable of handling writes for all entities. This is done through the use of CRDTs, which can be modified concurrently in different regions, and their changes safely merged without conflict. diff --git a/docs/src/modules/operations/pages/regions/index.adoc b/docs/src/modules/operations/pages/regions/index.adoc index 4cc7959c3..041b6aa19 100644 --- a/docs/src/modules/operations/pages/regions/index.adoc +++ b/docs/src/modules/operations/pages/regions/index.adoc @@ -38,7 +38,7 @@ When you deploy a service it will run in all regions of the project. When you ad [[selecting-primary]] === Selecting primary for stateful components -Stateful components like Event Sourced Entities or Workflow can be replicated to other regions. For each stateful component instance there is a primary region, which handles all write requests. Read requests can be served from any region. See xref:java:event-sourced-entities.adoc#_replication[Event Sourced Entity replication] and xref:java:workflows.adoc#_replication[Workflow replication] for more information about read and write requests. +Stateful components like Event Sourced Entities and Workflows can be replicated to other regions. For each stateful component instance there is a primary region, which handles all write requests. Read requests can be served from any region. See xref:java:event-sourced-entities.adoc#_replication[Event Sourced Entity replication] and xref:java:workflows.adoc#_replication[Workflow replication] for more information about read and write requests. There are two operational choices for deciding where the primary is located: diff --git a/docs/src/modules/operations/pages/services/deploy-service.adoc b/docs/src/modules/operations/pages/services/deploy-service.adoc index 6f3f880f5..9cba4046d 100644 --- a/docs/src/modules/operations/pages/services/deploy-service.adoc +++ b/docs/src/modules/operations/pages/services/deploy-service.adoc @@ -30,7 +30,7 @@ The docker build output in maven will print something similar to the following: ---- DOCKER> Tagging image shopping-cart:1.0-SNAPSHOT-20241028102843 successful! ---- - +[#_deploying_a_service] == Deploying a service Services can be deployed via the Akka CLI. @@ -171,16 +171,17 @@ For further details, see xref:operations:projects/external-container-registries. [#apply] == Using service descriptors -Akka services can also be described and managed with *YAML service descriptors*. +Akka services can also be described and managed with *YAML service descriptors*. See xref:reference:descriptors/service-descriptor.adoc[]. -First, <<_build_container_image>> and then push the image: +You can deploy your service using a service descriptor. +For this you need at least the image, which you can get by <<_build_container_image, building the container image>> and then <<_pushing_to_acr, pushing it to the container registry>>: [source, command line] ---- akka container-registry push container-name:tag-name ---- -Example of service descriptor: +Once pushed, you need to use the suggested image from the command's output in your service descriptor, for example: [source, yaml] ---- @@ -192,7 +193,7 @@ spec: value: some value ---- -NOTE: You must add the primary region image tag. See `akka container-registry push` command's output. +NOTE: You must add the primary region image tag from `akka container-registry push` output. To apply this descriptor, run: @@ -216,6 +217,15 @@ After editing the service descriptor (e.g., `my-service.yaml`), redeploy it with akka service apply -f my-service.yaml ---- +=== Editing the service descriptor in place + +Once you have <<_deploying_a_service, deployed your service>>, you can also modify it by editing its service descriptor: + +[source, command line] +---- +akka service edit my-service +---- + == Removing a deployed service To delete a service and free its resources, run the following command, replacing `my-service` with the name of the service you want to remove: @@ -245,3 +255,4 @@ You now know how to deploy, verify, update, and remove Akka services using the A == Related documentation - xref:reference:cli/akka-cli/akka_services.adoc[`akka service` CLI commands] +- xref:reference:descriptors/service-descriptor.adoc[Akka Service Descriptor] diff --git a/docs/src/modules/reference/pages/release-notes.adoc b/docs/src/modules/reference/pages/release-notes.adoc index 2d60cdf59..9ae3d2b83 100644 --- a/docs/src/modules/reference/pages/release-notes.adoc +++ b/docs/src/modules/reference/pages/release-notes.adoc @@ -10,6 +10,16 @@ Current versions * Akka CLI {akka-cli-version} * A glance of all Akka libraries and their current versions is presented at https://doc.akka.io/libraries/akka-dependencies/current[Akka library versions]. +== January 2025 + +* Akka CLI 3.0.9 + - Fixes listing of user role bindings + +* Platform update 2025-01-13 + - updates to internal libraries for security fixes + - switch of internal framework to apply environment configuration + - minor updates to the Console + == December 2024 * Akka CLI 3.0.8 diff --git a/docs/supplemental_ui/bundle/akka-theme-ui-001-bundle.zip b/docs/supplemental_ui/bundle/akka-theme-ui-001-bundle.zip index 53724210f..0954b53f2 100644 Binary files a/docs/supplemental_ui/bundle/akka-theme-ui-001-bundle.zip and b/docs/supplemental_ui/bundle/akka-theme-ui-001-bundle.zip differ diff --git a/docs/supplemental_ui/partials/drop-down-developers.hbs b/docs/supplemental_ui/partials/drop-down-developers.hbs index e5e816ea9..de6a3473a 100644 --- a/docs/supplemental_ui/partials/drop-down-developers.hbs +++ b/docs/supplemental_ui/partials/drop-down-developers.hbs @@ -4,23 +4,23 @@

Docs

- SDK - Libraries + SDK + Libraries
{{!--
--}}

Resources

- - Blog - Release Notes - Support + + Blog + Release Notes + Support
{{!--
--}}

Architecture

- Principles - Free Training - Certification + Principles + Free Training + Certification
diff --git a/docs/supplemental_ui/partials/drop-down-get-started.hbs b/docs/supplemental_ui/partials/drop-down-get-started.hbs new file mode 100644 index 000000000..690947d72 --- /dev/null +++ b/docs/supplemental_ui/partials/drop-down-get-started.hbs @@ -0,0 +1,27 @@ + + Get Started +
+
+
+ +

+ Try Akka for free +

+

Deploy and scale a multi-region app
No credit card required

+ + +

+ Develop your own Akka app +

+

Akka account not required
Free and open SDK for offline dev

+ + +

+ Request demo +

+

Personalized demo
Akka app design consultation

+ +
+
+
+ diff --git a/docs/supplemental_ui/partials/drop-down-sdk.hbs b/docs/supplemental_ui/partials/drop-down-sdk.hbs index cde2c7651..f1a22ef36 100644 --- a/docs/supplemental_ui/partials/drop-down-sdk.hbs +++ b/docs/supplemental_ui/partials/drop-down-sdk.hbs @@ -4,14 +4,14 @@

SDK

- Key Value Entities - Event Sourced Entities - Views + Key Value Entities + Event Sourced Entities + Views
- Timers - Workflows + Timers + Workflows