Merge pull request #53 from akka/main

Merge main to docs-current (3.0.1)
akka · Dec 3, 2024 · 14a4e86 · 14a4e86
2 parents ec8c855 + 732c76c
commit 14a4e86
Show file tree

Hide file tree

Showing 37 changed files with 157 additions and 44 deletions.
diff --git a/.github/workflows/docs-prod.yml b/.github/workflows/docs-prod.yml
@@ -1,9 +1,9 @@
 name: Documentation to doc.akka.io
 on:
   workflow_dispatch:
-#  push:
-#    branches:
-#      - 'docs-current'
+  push:
+    branches:
+      - 'docs-current'
 
 permissions:
   contents: read

diff --git a/.github/workflows/update-sdk-version.yml b/.github/workflows/update-sdk-version.yml
@@ -68,8 +68,8 @@ jobs:
           ./updateSdkVersions.sh all
           BRANCH=bump-sdk-versions-${SDK_VERSION}
           git checkout -b ${BRANCH}
-          git config user.name "Kalix Bot"
-          git config user.email "kalix.github@lightbend.com"
+          git config user.name "Akka Bot"
+          git config user.email "github[email protected].com"
           git commit . -m "chore: bump SDK versions to ${SDK_VERSION}"
           git remote add origin-rw https://${GH_TOKEN}@github.com/akka/akka-sdk
           git push --set-upstream origin-rw ${BRANCH}

diff --git a/LICENSE b/LICENSE
@@ -3,10 +3,10 @@ Business Source License 1.1
 Parameters
 
 Licensor:             Lightbend, Inc.
-Licensed Work:        Akka SDK for Java v 3.0.0
+Licensed Work:        Akka SDK for Java v 3.0.1
                       The Licensed Work is (c) 2024 Lightbend Inc.
 
-Change Date:          2027-11-08
+Change Date:          2027-12-03
 
 Change License:       Apache License, Version 2.0
 

diff --git a/Makefile b/Makefile
@@ -88,7 +88,7 @@ antora-local:
 		-v ${ROOT_DIR}:/antora \
 		--rm \
 		-t ${antora_docker_image}:${antora_docker_image_tag} \
-		--cache-dir=.cache/antora --stacktrace --log-failure-level=fatal \
+		--cache-dir=.cache/antora --stacktrace --log-failure-level=error \
 		docs/antora-playbook-local.yml
 
 antora-prod:

diff --git a/akka-javasdk-maven/akka-javasdk-archetype/pom.xml b/akka-javasdk-maven/akka-javasdk-archetype/pom.xml
@@ -2,12 +2,12 @@
     <modelVersion>4.0.0</modelVersion>
 
     <artifactId>akka-javasdk-archetype</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
     <packaging>maven-archetype</packaging>
     <parent>
         <groupId>io.akka</groupId>
         <artifactId>akka-javasdk-maven</artifactId>
-        <version>3.0.0</version>
+        <version>3.0.1</version>
     </parent>
 
     <name>Akka SDK for Java Maven Archetype</name>

diff --git a/akka-javasdk-maven/akka-javasdk-parent/pom.xml b/akka-javasdk-maven/akka-javasdk-parent/pom.xml
@@ -7,12 +7,12 @@
     <parent>
         <groupId>io.akka</groupId>
         <artifactId>akka-javasdk-maven</artifactId>
-        <version>3.0.0</version>
+        <version>3.0.1</version>
     </parent>
 
     <groupId>io.akka</groupId>
     <artifactId>akka-javasdk-parent</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
     <packaging>pom</packaging>
 
 
@@ -34,7 +34,7 @@
 
         <maven.build.timestamp.format>yyyyMMddHHmmss</maven.build.timestamp.format>
 
-        <akka-javasdk.version>3.0.0</akka-javasdk.version>
+        <akka-javasdk.version>3.0.1</akka-javasdk.version>
 
         <!-- These are dependent on runtime environment and cannot be customized by users -->
         <maven.compiler.release>21</maven.compiler.release>

diff --git a/akka-javasdk-maven/pom.xml b/akka-javasdk-maven/pom.xml
@@ -5,7 +5,7 @@
 
   <groupId>io.akka</groupId>
   <artifactId>akka-javasdk-maven</artifactId>
-  <version>3.0.0</version>
+  <version>3.0.1</version>
   <packaging>pom</packaging>
 
   <name>Akka SDK for Java Maven</name>

diff --git a/docs/src/modules/ROOT/partials/include.adoc b/docs/src/modules/ROOT/partials/include.adoc
@@ -1,5 +1,7 @@
 // global attributes
 
 :sample-base-url: https://github.com/akka/akka-sdk/blob/main/samples
+// Docker Registry HTTP API Version
+:docker_registry_http_api_version: v1
 
 include::partial$attributes.adoc[]
diff --git a/docs/src/modules/java/pages/http-endpoints.adoc b/docs/src/modules/java/pages/http-endpoints.adoc
@@ -131,7 +131,7 @@ include::example$shopping-cart-quickstart/src/main/java/shoppingcart/api/Shoppin
 <3> GET endpoint path is combined with a path parameter name, e.g. `/carts/123`.
 <4> The component client can be used to interact with other components.
 <5> Result of a request to a component is a `CompletionStage<T>`, it can be returned directly to let Akka serialize it.
-<6> Use path parameter `{cartId}` in combination with request body `ShoppingCart.LineItem`.
+<6> Use path parameter `+{cartId}+` in combination with request body `ShoppingCart.LineItem`.
 <7> Result of request mapped to a more suitable response, in this case, `200 Ok` with an empty body.
 
 For more details see xref:component-and-service-calls.adoc[]

diff --git a/docs/src/modules/java/pages/shopping-cart-quickstart.adoc b/docs/src/modules/java/pages/shopping-cart-quickstart.adoc
@@ -126,7 +126,7 @@ include::example$shopping-cart-quickstart/src/main/java/shoppingcart/api/Shoppin
 <3> GET endpoint path is combined with a path parameter name, e.g. `/carts/123`.
 <4> `ComponentClient` calling a command handler on an Event Sourced Entity from inside an Endpoint.
 <5> Result of request is a `CompletionStage<T>`, in this case a `CompletionStage<ShoppingCart>`.
-<6> Use path parameter `{cartId}` in combination with request body `ShoppingCart.LineItem`.
+<6> Use path parameter `+{cartId}+` in combination with request body `ShoppingCart.LineItem`.
 <7> Map request to a more suitable response, in this case an `HTTP 200 OK` response.
 
 

diff --git a/...odules/operations/pages/observability-and-monitoring/observability-exports.adoc b/...odules/operations/pages/observability-and-monitoring/observability-exports.adoc
@@ -59,6 +59,7 @@ This will open the observability descriptor in a text editor. After saving and e
 After updating your observability configuration, you will need to restart a service to apply the new configuration. Akka automatically makes that a rolling restart.
 ====
 
+[#activating_tracing]
 === Activating tracing (Beta)
 
 The generation of traces is disabled by default. To enable it you need to set xref:reference:descriptors/service-descriptor.adoc#_servicespec[telemetry/tracing/enabled] to `true` in the service descriptor. Like the following:

diff --git a/docs/src/modules/operations/pages/observability-and-monitoring/traces.adoc b/docs/src/modules/operations/pages/observability-and-monitoring/traces.adoc
@@ -1,6 +1,6 @@
 = View traces 
 
-Akka projects have the traces dashboard built-in as part of the Control Tower in the Akka Console. This is available out-of-the-box. You can find your traces here as long as you have xref:operations:observability-and-monitoring/observability-exports.adoc#_activating_tracing_beta[enabled the traces] in your service.
+Akka projects have the traces dashboard built-in as part of the Control Tower in the Akka Console. This is available out-of-the-box. You can find your traces here as long as you have xref:operations:observability-and-monitoring/observability-exports.adoc#activating_tracing[enabled the traces] in your service.
 
 In the top panel you have the list of traces you can inspect. When you click on one of them, the contents of the trace are displayed in the panel below. As shown in the figure. 
 

diff --git a/docs/src/modules/operations/pages/observability-and-monitoring/view-logs.adoc b/docs/src/modules/operations/pages/observability-and-monitoring/view-logs.adoc
@@ -1,5 +1,6 @@
 = View logs
 include::ROOT:partial$include.adoc[]
+
 :page-supergroup-browser-cli: Interface
 
 Akka provides logs that you can view in the Console or access with the CLI. For each service instance we aggregate a maximum of 1MB of log data. You can capture all log output by attaching a logging provider, such as Google Cloud's operations suite (formerly Stackdriver), as described xref:observability-and-monitoring/observability-exports.adoc#_google_cloud[here].
@@ -31,7 +32,7 @@ Logs can be exported for searching, reporting, alerting and long term storage by
 
 == Correlating logs
 
-You can correlate your log statements, those that you write in your application, by adding the MDC pattern `%mdc{trace_id}` to your log file when tracing is xref:operations:observability-and-monitoring/observability-exports.adoc#_activating_tracing_beta[enabled]. Like the following:
+You can correlate your log statements, those that you write in your application, by adding the MDC pattern `%mdc{trace_id}` to your log file when tracing is xref:operations:observability-and-monitoring/observability-exports.adoc#activating_tracing[enabled]. Like the following:
 
 [source,xml]
 .logback.xml

diff --git a/docs/src/modules/operations/pages/organizations/manage-users.adoc b/docs/src/modules/operations/pages/organizations/manage-users.adoc
@@ -44,7 +44,7 @@ fd21044c-b973-4220-8f65-0f7d317bb23b   superuser   jane.citizen   jane.citizen@e
 
 You can grant a role to a user in two ways:
 
-==== 1. Invite a User by Email
+=== 1. Invite a User by Email
 Send an email invitation with the following command:
 
 [source,command window]
@@ -56,7 +56,7 @@ akka organizations invitations create --organization <organization name> \
 The user will receive an email to join the organization. Once accepted, the role binding will be created.
 
 
-==== 2. Add a Role Directly
+=== 2. Add a Role Directly
 
 If the user is already a member, you can assign roles directly:
 

diff --git a/docs/src/modules/operations/pages/projects/external-container-registries.adoc b/docs/src/modules/operations/pages/projects/external-container-registries.adoc
@@ -6,6 +6,8 @@ To use an external container registry with Akka, you need to give Akka permissio
 [NOTE]
 If the container registry you're using does not require authentication, you don't have to add any credentials. Akka will automatically pull the container image using the URL you use to deploy your service.
 
+External container registries are configured by creating an Akka secret, and then configuring your Akka project to use that secret as docker registry credentials. The secret, and project configuration, are both managed by the `akka docker` command.
+
 There are four parameters you need to specify, depending on the registry you want to connect to:
 
 - Server: The first part of the container image URL. For example, if your image is at `us.gcr.io/my-project/my-image`, the server is `\https://us.gcr.io` (_mandatory_).
@@ -28,6 +30,12 @@ akka docker add-credentials --docker-server <my-server> \ <1>
 <3> Email
 <4> Password
 
+If you wish to specify the name of the secret that you want to use, that can be done using the `--secret-name` parameter. By default, if not specified, the name of the secret will be `docker-credentials`.
+
+== Updating credentials
+
+The `add-credentials` command can also be used to update existing credentials. Simply ensure that the `--secret-name` argument matches the secret name used when the credentials were added, if it was specified then.
+
 == Listing credentials
 
 To list all container registry credentials for your Akka project, you can use the Akka CLI or the Akka Console. For security purposes, neither the CLI nor the Console will show the password of the configured registry.
@@ -42,19 +50,26 @@ akka docker list-credentials
 The results should look something like:
 
 ----
-ID                                     SERVER              USERNAME    EMAIL
-xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx   https://us.gcr.io   _json_key   [email protected]
+NAME                STATUS  SERVER             EMAIL             USERNAME
+docker-credentials  OK      https://us.gcr.io  [email protected]  _json_key
 ----
 
 == Removing credentials
 
 To remove container registry credentials from your Akka project, you can use the Akka CLI or the Akka Console.
 
-Use the 'ID' returned from the `akka docker list-credentials` command as the `ID` in the `akka docker delete-credentials` command:
+If you specified a `--secret-name` when creating the credentials, this is the name that you must pass to the command to remove. Otherwise, you should pass the default secret name of `docker-credentials`. The name of the secret appears in the `NAME` column when listing credentials.
+
+[source, command line]
+----
+akka docker delete-credentials docker-credentials
+----
+
+Note that this will only remove the credentials from the configuration for the project, it will not delete the underlying secret. To delete the secret as well, run:
 
 [source, command line]
 ----
-akka docker delete-credentials <credentials-id>
+akka secrets delete docker-credentials
 ----
 
 == Supported external registries

diff --git a/docs/src/modules/operations/pages/projects/manage-project-access.adoc b/docs/src/modules/operations/pages/projects/manage-project-access.adoc
@@ -59,7 +59,7 @@ akka config set project <project name>
 
 You can grant a project role to a user in two ways:
 
-==== 1. Invite a user to the project by e-mail
+=== 1. Invite a user to the project by e-mail
 Invite a user to join the project and assign them a role by using the following command:
 
 [source,command window]
@@ -69,7 +69,7 @@ akka roles invitations invite-user <email address> --role <role>
 
 The user will receive an email inviting them to join the project. Upon acceptance, the role binding will be created.
 
-==== 2. Add a role directly
+=== 2. Add a role directly
 If the user is already a member of the project, or the project is part of an organization and the user belongs to that organization, you can assign roles directly without sending an invitation.
 
 * By e-mail:

diff --git a/docs/src/modules/reference/pages/release-notes.adoc b/docs/src/modules/reference/pages/release-notes.adoc
@@ -10,8 +10,27 @@ 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].
 
+== December 2024
+
+* https://github.com/akka/akka-sdk/releases/tag/v3.0.1[Akka SDK 3.0.1]
+    - Minor improvements
+
 == November 2024
 
+* https://github.com/akka/akka-projection/releases/tag/v1.6.5[Akka Projections 1.6.5]
+
+* https://github.com/akka/akka-projection/releases/tag/v1.6.4[Akka Projections 1.6.4]
+
+* https://github.com/akka/akka-projection/releases/tag/v1.6.3[Akka Projections 1.6.3]
+
+* https://github.com/akka/akka-persistence-dynamodb/releases/tag/v2.0.3[Akka DynamoDB 2.0.3]
+
+* https://github.com/akka/akka-persistence-dynamodb/releases/tag/v2.0.2[Akka DynamoDB 2.0.2]
+
+* Akka CLI 3.0.6
+    - Automatically retry calls
+    - Improved help texts
+
 * https://github.com/akka/akka-projection/releases/tag/v1.6.2[Akka Projections 1.6.2]
 
 * https://github.com/akka/akka-persistence-dynamodb/releases/tag/v2.0.1[Akka DynamoDB 2.0.1]

diff --git a/samples/choreography-saga-quickstart/pom.xml b/samples/choreography-saga-quickstart/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.akka</groupId>
     <artifactId>akka-javasdk-parent</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
   </parent>
 
   <groupId>com.example</groupId>

diff --git a/samples/doc-snippets/pom.xml b/samples/doc-snippets/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.akka</groupId>
     <artifactId>akka-javasdk-parent</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
   </parent>
 
   <groupId>com.example</groupId>

diff --git a/samples/doc-snippets/src/main/java/com/example/acl/UserEndpoint.java b/samples/doc-snippets/src/main/java/com/example/acl/UserEndpoint.java
@@ -29,7 +29,9 @@ public record CreateUser(String username, String email) { }
   // tag::checking-principals[]
   @Get
   public String checkingPrincipals() {
+    // tag::request-context[]
     var principals = requestContext().getPrincipals();
+    // end::request-context[]
     if (principals.isInternet()) {
       return "accessed from the Internet";
     } else if (principals.isSelf()) {

diff --git a/samples/endpoint-jwt/.idea/runConfigurations/Run_locally.xml b/samples/endpoint-jwt/.idea/runConfigurations/Run_locally.xml
diff --git a/samples/endpoint-jwt/pom.xml b/samples/endpoint-jwt/pom.xml
@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.akka</groupId>
     <artifactId>akka-javasdk-parent</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
   </parent>
 
   <groupId>com.example</groupId>

diff --git a/samples/event-sourced-counter-brokers/.idea/runConfigurations/Run_locally.xml b/samples/event-sourced-counter-brokers/.idea/runConfigurations/Run_locally.xml
diff --git a/samples/event-sourced-counter-brokers/pom.xml b/samples/event-sourced-counter-brokers/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.akka</groupId>
     <artifactId>akka-javasdk-parent</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
   </parent>
 
   <groupId>com.example</groupId>

diff --git a/samples/event-sourced-customer-registry-subscriber/pom.xml b/samples/event-sourced-customer-registry-subscriber/pom.xml
@@ -5,7 +5,7 @@
   <parent>
     <groupId>io.akka</groupId>
     <artifactId>akka-javasdk-parent</artifactId>
-    <version>3.0.0</version>
+    <version>3.0.1</version>
   </parent>
 
   <groupId>customer</groupId>