You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2023/04/18 22:42:28 UTC
[incubator-pekko-grpc] branch main updated: pekko naming (#57)
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-grpc.git
The following commit(s) were added to refs/heads/main by this push:
new 1af8eef7 pekko naming (#57)
1af8eef7 is described below
commit 1af8eef7173595c0a24cfd2a7258d62438b54c05
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Wed Apr 19 00:42:23 2023 +0200
pekko naming (#57)
* pekko naming
* Update build.sbt
---
CONTRIBUTING.md | 2 +-
README.md | 2 +-
RELEASING.md | 50 ----------------
build.sbt | 22 +++----
docs/release-train-issue-template-patch.md | 58 -------------------
docs/release-train-issue-template.md | 64 ---------------------
docs/src/main/paradox/.htaccess | 2 -
docs/src/main/paradox/apidesign.md | 6 +-
docs/src/main/paradox/assets/intro-video.png | Bin 558414 -> 0 bytes
docs/src/main/paradox/binary-compatibility.md | 24 ++++----
docs/src/main/paradox/buildtools/gradle.md | 7 ++-
docs/src/main/paradox/buildtools/maven.md | 6 +-
docs/src/main/paradox/buildtools/sbt.md | 10 ++--
docs/src/main/paradox/client/configuration.md | 8 +--
docs/src/main/paradox/client/walkthrough.md | 8 +--
docs/src/main/paradox/deploy.md | 8 +--
docs/src/main/paradox/getting-started.md | 9 ++-
docs/src/main/paradox/index.md | 2 +-
docs/src/main/paradox/overview.md | 19 +++---
docs/src/main/paradox/proto.md | 2 +-
docs/src/main/paradox/server/details.md | 2 +-
docs/src/main/paradox/server/grpc-web.md | 12 ++--
docs/src/main/paradox/server/index.md | 4 +-
docs/src/main/paradox/server/kubernetes.md | 2 +-
.../paradox/server/{akka-http.md => pekko-http.md} | 20 +++----
docs/src/main/paradox/server/reflection.md | 12 ++--
docs/src/main/paradox/server/walkthrough.md | 26 ++++-----
docs/src/main/paradox/whygrpc.md | 10 ++--
gradle-plugin/build.gradle | 2 +-
project/Common.scala | 2 +-
project/plugins.sbt | 2 +-
project/project-info.conf | 20 ++++---
scripts/create-release-issue.sh | 10 ----
scripts/link-validator.conf | 3 +-
34 files changed, 127 insertions(+), 309 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 3ee998ea..16e5f5bb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -94,7 +94,7 @@ However, once we declare the project stable, we will adhere to the following
rules:
Our binary compatibility guarantees are described in depth in the
-[Binary Compatibility](https://doc.akka.io/docs/akka-grpc/current/binary-compatibility.html)
+[Binary Compatibility](https://pekko.apache.org/docs/pekko-grpc/current/binary-compatibility.html)
section of the documentation.
Pekko gRPC uses [Lightbend MiMa](https://github.com/lightbend/mima) to
diff --git a/README.md b/README.md
index d449f8bc..6a72d30b 100644
--- a/README.md
+++ b/README.md
@@ -8,7 +8,7 @@ toolkit.
## Documentation
-- [Akka gRPC reference](https://doc.akka.io/docs/akka-grpc/current/) documentation
+- [Pekko gRPC reference](https://pekko.apache.org/docs/pekko-grpc/current/) documentation
## Project Status
diff --git a/RELEASING.md b/RELEASING.md
deleted file mode 100644
index b6ace91d..00000000
--- a/RELEASING.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# Releasing
-
-## When to release
-
-Akka gRPC is released when there is a need for it.
-
-If you want to test an improvement that is not yet released, you can use a
-snapshot version: we release all commits to master to the snapshot repository
-on [Sonatype](https://oss.sonatype.org/content/repositories/snapshots/com/lightbend/akka/grpc).
-
-## How to release
-
-Create a new issue from the [Release Train Issue Template](docs/release-train-issue-template.md):
-
-```
-$ sh ./scripts/create-release-issue.sh 0.x.y
-```
-
-or:
-
-```
-$ sh ./scripts/create-release-issue.sh 0.x.y -patch
-```
-
-## Gradle plugin release details
-
-The Gradle plugin goes directly to the Gradle Plugin Portal. Publishing keys are stored as Github Action secrets and
-referred to in the Github Action job.
-
-### Releasing only updated docs
-
-It is possible to release a revised documentation to the already existing release.
-
-1. Create a new branch from a release tag. If a revised documentation is for the `v0.3` release, then the name of the new branch should be `docs/v0.3`.
-1. Add and commit `version.sbt` file that pins the version to the one, that is being revised. Also set `isSnapshot` to `false` for the stable documentation links. For example:
- ```scala
- ThisBuild / version := "0.6.1"
- ThisBuild / isSnapshot := false
- ```
-1. Make all of the required changes to the documentation.
-1. Build documentation locally with:
- ```sh
- sbt akka-grpc-docs/previewSite
- ```
-1. If the generated documentation looks good, send it to Gustav:
- ```sh
- rm -r docs/target/site
- sbt akka-grpc-docs/publishRsync
- ```
-1. Do not forget to push the new branch back to GitHub.
diff --git a/build.sbt b/build.sbt
index 1d955537..1b5b4367 100644
--- a/build.sbt
+++ b/build.sbt
@@ -185,7 +185,7 @@ lazy val docs = Project(id = "docs", base = file("docs"))
name := s"$pekkoPrefix-docs",
publish / skip := true,
makeSite := makeSite.dependsOn(LocalRootProject / ScalaUnidoc / doc).value,
- pekkoParadoxGithub := "https://github.com/apache/incubator-pekko-grpc",
+ pekkoParadoxGithub := Some("https://github.com/apache/incubator-pekko-grpc"),
previewPath := (Paradox / siteSubdirName).value,
Preprocess / siteSubdirName := s"api/akka-grpc/${projectInfoVersion.value}",
Preprocess / sourceDirectory := (LocalRootProject / ScalaUnidoc / unidoc / target).value,
@@ -197,17 +197,17 @@ lazy val docs = Project(id = "docs", base = file("docs"))
"pekko.version" -> Dependencies.Versions.pekko,
"pekko-http.version" -> Dependencies.Versions.pekkoHttp,
"grpc.version" -> Dependencies.Versions.grpc,
- "project.url" -> "https://doc.akka.io/docs/akka-grpc/current/",
- "canonical.base_url" -> "https://doc.akka.io/docs/akka-grpc/current",
+ "project.url" -> "https://pekko.apache.org/docs/pekko-grpc/current/",
+ "canonical.base_url" -> "https://pekko.apache.org/docs/pekko-grpc/current",
"scaladoc.scala.base_url" -> s"https://www.scala-lang.org/api/current/",
- // Akka
- "extref.akka.base_url" -> s"https://doc.akka.io/docs/akka/${Dependencies.Versions.akkaBinary}/%s",
- "scaladoc.akka.base_url" -> s"https://doc.akka.io/api/akka/${Dependencies.Versions.akkaBinary}",
- "javadoc.akka.base_url" -> s"https://doc.akka.io/japi/akka/${Dependencies.Versions.akkaBinary}/",
- // Akka HTTP
- "extref.akka-http.base_url" -> s"https://doc.akka.io/docs/akka-http/${Dependencies.Versions.akkaHttpBinary}/%s",
- "scaladoc.akka.http.base_url" -> s"https://doc.akka.io/api/akka-http/${Dependencies.Versions.akkaHttpBinary}/",
- "javadoc.akka.http.base_url" -> s"https://doc.akka.io/japi/akka-http/${Dependencies.Versions.akkaHttpBinary}/",
+ // Apache Pekko
+ "extref.pekko.base_url" -> s"https://pekko.apache.org/docs/pekko-grpc/current/%s",
+ "scaladoc.pekko.base_url" -> "https://pekko.apache.org/docs/pekko-grpc/current/",
+ "javadoc.pekko.base_url" -> "https://pekko.apache.org/docs/pekko-grpc/current/",
+ // Apache Pekko HTTP
+ "extref.pekko-http.base_url" -> s"https://doc.akka.io/docs/akka-http/${Dependencies.Versions.akkaHttpBinary}/%s",
+ "scaladoc.pekko-http.base_url" -> s"https://doc.akka.io/api/akka-http/${Dependencies.Versions.akkaHttpBinary}/",
+ "javadoc.pekko-http.base_url" -> s"https://doc.akka.io/japi/akka-http/${Dependencies.Versions.akkaHttpBinary}/",
// Apache Pekko gRPC
"scaladoc.akka.grpc.base_url" -> s"/${(Preprocess / siteSubdirName).value}/",
"javadoc.akka.grpc.base_url" -> "" // @apidoc links to Scaladoc
diff --git a/docs/release-train-issue-template-patch.md b/docs/release-train-issue-template-patch.md
deleted file mode 100644
index 257c6d13..00000000
--- a/docs/release-train-issue-template-patch.md
+++ /dev/null
@@ -1,58 +0,0 @@
-Release Akka gRPC $VERSION$
-
-<!--
-
-(Liberally copied and adopted from Scala itself https://github.com/scala/scala-dev/blob/b11cd2e4a4431de7867db6b39362bea8fa6650e7/notes/releases/template.md)
-
-For every release, make a copy of this file named after the release, and expand the variables.
-Ideally replacing variables could become a script you can run on your local machine.
-
-Variables to be expanded in this template:
-- $VERSION$=???
-
--->
-
-### Before the release
-
-- [ ] Make sure all important / big PRs have been merged by now
-
-### Cutting the release
-
-- [ ] Make sure the [Github Actions build](https://github.com/akka/akka-grpc/actions?query=branch%3Amain) for the commit you would like to release has completed.
-- [ ] Tag the release `git tag -a -m 'Release v$VERSION$' v$VERSION$` and push the tag `git push --tags`
-- [ ] Check that the GitHub Actions release build has executed successfully (it should publish artifacts to Sonatype and documentation to Gustav)
-
-### Check availability
-
-- [ ] Check [reference](https://doc.akka.io/docs/akka-grpc/$VERSION$/) documentation
-- [ ] Check the release on [Maven central](https://repo1.maven.org/maven2/com/lightbend/akka/grpc/akka-grpc-scalapb-protoc-plugin_2.12/$VERSION$/)
-
-### When everything is on maven central
- - [ ] `ssh akkarepo@gustav.akka.io`
- - [ ] update the `current` links on `repo.akka.io` to point to the latest version with
- ```
- ln -nsf $VERSION$ www/docs/akka-grpc/current
- ln -nsf $VERSION$ www/api/akka-grpc/current
- ```
- - [ ] check changes and commit the new version to the local git repository
- ```
- cd ~/www
- git add docs/akka-grpc/current docs/akka-grpc/$VERSION$
- git add api/akka-grpc/current api/akka-grpc/$VERSION$
- git commit -m "Akka gRPC $VERSION$"
- ```
- - [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io)
- ```
- cd ~/www
- git push origin master
- ```
-
-### Announcements
-
-- [ ] Edit the [release draft](https://github.com/akka/akka-grpc/releases) with the next tag version `v$VERSION$`, title and release description.
-- [ ] Tweet using the akkateam account (or ask someone to) about the new release
-- [ ] Announce on [Gitter akka/akka](https://gitter.im/akka/akka)
-
-### Afterwards
-
-- Close this issue
diff --git a/docs/release-train-issue-template.md b/docs/release-train-issue-template.md
deleted file mode 100644
index 61d870b6..00000000
--- a/docs/release-train-issue-template.md
+++ /dev/null
@@ -1,64 +0,0 @@
-Release Akka gRPC $VERSION$
-
-<!--
-
-(Liberally copied and adopted from Scala itself https://github.com/scala/scala-dev/blob/b11cd2e4a4431de7867db6b39362bea8fa6650e7/notes/releases/template.md)
-
-For every release, make a copy of this file named after the release, and expand the variables.
-Ideally replacing variables could become a script you can run on your local machine.
-
-Variables to be expanded in this template:
-- $VERSION$=???
-
--->
-
-### Before the release
-
-- [ ] Make sure all important / big PRs have been merged by now
-- [ ] Create a news item draft PR on [akka.github.com](https://github.com/akka/akka.github.com), using the [draft release](https://github.com/akka/akka-grpc/releases)
-
-### Cutting the release
-
-- [ ] Make sure the [Github Actions build](https://github.com/akka/akka-grpc/actions?query=branch%3Amain) for the commit you would like to release has completed.
-- [ ] Tag the release `git tag -a -m 'Release v$VERSION$' v$VERSION$` and push the tag `git push --tags`
-- [ ] Check that the GitHub Actions release build has executed successfully (it should publish artifacts to Sonatype and documentation to Gustav)
-
-### Check availability
-
-- [ ] Check [reference](https://doc.akka.io/docs/akka-grpc/$VERSION$/) documentation
-- [ ] Check the release on [Maven central](https://repo1.maven.org/maven2/com/lightbend/akka/grpc/akka-grpc-scalapb-protoc-plugin_2.12/$VERSION$/)
-
-### When everything is on maven central
- - [ ] `ssh akkarepo@gustav.akka.io`
- - [ ] update the `current` links on `repo.akka.io` to point to the latest version with
- ```
- ln -nsf $VERSION$ www/docs/akka-grpc/current
- ln -nsf $VERSION$ www/api/akka-grpc/current
- ```
- - [ ] check changes and commit the new version to the local git repository
- ```
- cd ~/www
- git add docs/akka-grpc/current docs/akka-grpc/$VERSION$
- git add api/akka-grpc/current api/akka-grpc/$VERSION$
- git commit -m "Akka gRPC $VERSION$"
- ```
- - [ ] push changes to the [remote git repository](https://github.com/akka/doc.akka.io)
- ```
- cd ~/www
- git push origin master
- ```
-
-### Announcements
-
-- [ ] Merge draft news item for [akka.io](https://github.com/akka/akka.github.com)
-- [ ] Edit the [release draft](https://github.com/akka/akka-grpc/releases) with the next tag version `v$VERSION$`, title and release description.
-- [ ] Send a release notification to [Lightbend discuss](https://discuss.akka.io)
-- [ ] Tweet using the akkateam account (or ask someone to) about the new release
-- [ ] Announce on [Gitter akka/akka](https://gitter.im/akka/akka)
-- [ ] Announce internally
-- [ ] Update to the released version [here](https://github.com/lightbend/lightbend-technology-intro-doc/blob/master/docs/modules/getting-help/examples/project/akka-grpc.sbt)
-- [ ] For minor releases, record it [here](https://github.com/lightbend/together-portal/blob/master/app/models/Product.scala#L48)
-
-### Afterwards
-
-- Close this issue
diff --git a/docs/src/main/paradox/.htaccess b/docs/src/main/paradox/.htaccess
deleted file mode 100644
index 9a9f2bb8..00000000
--- a/docs/src/main/paradox/.htaccess
+++ /dev/null
@@ -1,2 +0,0 @@
-# Sample redirect when renaming pages
-# RedirectMatch 301 ^/docs/akka-grpc/([^/]+)/release-notes/1.0.html https://doc.akka.io/docs/akka-grpc/$1/release-notes/1.0.x.html
diff --git a/docs/src/main/paradox/apidesign.md b/docs/src/main/paradox/apidesign.md
index 45f42c39..588ceced 100644
--- a/docs/src/main/paradox/apidesign.md
+++ b/docs/src/main/paradox/apidesign.md
@@ -26,7 +26,7 @@ Validators for Java stubs are provided by [the project itself](https://github.co
Follow the instructions there for Maven and Gradle. If your are using sbt, you can get
`validate.proto` into the include path and run the protoc plugin generating the validators
-through `sbt-protoc` (@ref[used by Akka gRPC](buildtools/sbt.md#sbt-protoc-settings)) by adding
+through `sbt-protoc` (@ref[used by Pekko gRPC](buildtools/sbt.md#sbt-protoc-settings)) by adding
to your `build.sbt`:
```scala
val pgvVersion = "0.4.1" // latest at the time of writing
@@ -48,9 +48,9 @@ Compile / compile / javacOptions ++= Seq("-source", "8", "-target", "8"),
Validators for ScalaPB stubs are provided by [scalapb-validate](https://github.com/scalapb/scalapb-validate).
Follow the [documentation](https://scalapb.github.io/docs/validation) to update `project/build.sbt`
-in order to generate the validators using `sbt-protoc` (@ref[used by Akka gRPC](buildtools/sbt.md#sbt-protoc-settings)).
+in order to generate the validators using `sbt-protoc` (@ref[used by Pekko gRPC](buildtools/sbt.md#sbt-protoc-settings)).
-With the default parameters and target set by Akka gRPC, additions to your `build.sbt` should be:
+With the default parameters and target set by Pekko gRPC, additions to your `build.sbt` should be:
@@snip[build.sbt](/sbt-plugin/src/sbt-test/gen-scala-server/10-scalapb-validate/build.sbt) { #setup }
diff --git a/docs/src/main/paradox/assets/intro-video.png b/docs/src/main/paradox/assets/intro-video.png
deleted file mode 100644
index 811c7090..00000000
Binary files a/docs/src/main/paradox/assets/intro-video.png and /dev/null differ
diff --git a/docs/src/main/paradox/binary-compatibility.md b/docs/src/main/paradox/binary-compatibility.md
index 299b1002..e21344df 100644
--- a/docs/src/main/paradox/binary-compatibility.md
+++ b/docs/src/main/paradox/binary-compatibility.md
@@ -1,19 +1,19 @@
# Binary compatibility
-If possible we recommend using Akka gRPC directly from your downstream projects,
+If possible we recommend using Pekko gRPC directly from your downstream projects,
and share protocols among projects by distributing the .proto service definition rather
than creating libraries that contain generated code. However, in some cases it can be
-convenient to use Akka gRPC in a library project.
+convenient to use Pekko gRPC in a library project.
Conflicting versions in transitive dependencies can make upgrading a painful exercise.
-To make this easier, starting with version 1.0.0 Akka gRPC provides binary compatibility
+To make this easier, starting with version 1.0.0 Pekko gRPC provides binary compatibility
for the runtime library within each major version.
-This means if you use a library that in turn uses Akka gRPC, it should be possible to use
-that library with any newer version of Akka gRPC as well (with the exceptions listed below).
+This means if you use a library that in turn uses Pekko gRPC, it should be possible to use
+that library with any newer version of Pekko gRPC as well (with the exceptions listed below).
-This is especially relevant if you depend on one library that depends on Akka gRPC
-version 'A', and another library that depends on Akka gRPC version 'B': due to
-binary compatibility, you can simply choose the latest version of Akka gRPC and
+This is especially relevant if you depend on one library that depends on Pekko gRPC
+version 'A', and another library that depends on Pekko gRPC version 'B': due to
+binary compatibility, you can simply choose the latest version of Pekko gRPC and
use both libraries with that.
## Limitations
@@ -22,8 +22,8 @@ No binary compatibility is guaranteed between major versions.
### New features
-Features introduced in later versions of Akka gRPC may not work with code generated
-with a previous version of Akka gRPC.
+Features introduced in later versions of Pekko gRPC may not work with code generated
+with a previous version of Pekko gRPC.
### Deprecations
@@ -34,7 +34,7 @@ may disappear in version `x.(y+1).z`.
Internal API's (designated by the `org.apache.pekko.grpc.internal` package or with the `@InternalApi` annotation) and API's that are still marked `@ApiMayChange` are not guaranteed to remain binary compatible.
-Libraries that use such methods may not work in applications that depend on a newer version of Akka gRPC.
+Libraries that use such methods may not work in applications that depend on a newer version of Pekko gRPC.
## Upstream libraries
@@ -43,4 +43,4 @@ binary compatibility, such as [ScalaPB](https://scalapb.github.io/) (when
generating Scala code) and [grpc-java](https://github.com/grpc/grpc-java/).
When updates to those libraries introduce incompatibilities it will be decided
on a case-by-case basis, based on the expected impact of the change,
-whether the update requires a new major Akka gRPC version.
+whether the update requires a new major Pekko gRPC version.
diff --git a/docs/src/main/paradox/buildtools/gradle.md b/docs/src/main/paradox/buildtools/gradle.md
index 716ef67f..83a2013c 100644
--- a/docs/src/main/paradox/buildtools/gradle.md
+++ b/docs/src/main/paradox/buildtools/gradle.md
@@ -1,6 +1,6 @@
# Gradle
-To get started with Akka gRPC read the @ref[client](../client/index.md) or @ref[server](../server/index.md) introductions.
+To get started with Pekko gRPC read the @ref[client](../client/index.md) or @ref[server](../server/index.md) introductions.
## Configuring plugin
@@ -74,9 +74,10 @@ This is supported by `protobuf-gradle-plugin` and explained [here](https://githu
## JDK 8 support
-If you want to use TLS-based negotiation on JDK 8, Akka gRPC requires JDK 8 update 252 or later. JVM support for ALPN has been backported to JDK 8u252 which is now widely available. Support for using the Jetty ALPN agent has been [dropped in Akka HTTP 10.2.0](https://doc.akka.io/docs/akka-http/current/migration-guide/migration-guide-10.2.x.html#http-2-support-requires-jdk-8-update-252-or-later), and therefore is not supported by Akka gRPC.
+If you want to use TLS-based negotiation on JDK 8, Pekko gRPC requires JDK 8 update 252 or later. JVM support for ALPN has been backported to JDK 8u252 which is now widely available.
+Support for using the Jetty ALPN agent has been in Pekko HTTP, and therefore is not supported by Pekko gRPC.
-## Starting your Akka gRPC server from gradle
+## Starting your Pekko gRPC server from gradle
Build script needs a custom task
diff --git a/docs/src/main/paradox/buildtools/maven.md b/docs/src/main/paradox/buildtools/maven.md
index dda59a21..01b66304 100644
--- a/docs/src/main/paradox/buildtools/maven.md
+++ b/docs/src/main/paradox/buildtools/maven.md
@@ -1,6 +1,6 @@
# Maven
-To get started with Akka gRPC read the @ref[client](../client/index.md) or @ref[server](../server/index.md) introductions.
+To get started with Pekko gRPC read the @ref[client](../client/index.md) or @ref[server](../server/index.md) introductions.
## Configuring what to generate
@@ -84,9 +84,9 @@ it is tracked in issue [#152](https://github.com/akka/akka-grpc/issues/152).
## JDK 8 support
-If you want to use TLS-based negotiation on JDK 8, Akka gRPC requires JDK 8 update 252 or later. JVM support for ALPN has been backported to JDK 8u252 which is now widely available. Support for using the Jetty ALPN agent has been [dropped in Akka HTTP 10.2.0](https://doc.akka.io/docs/akka-http/current/migration-guide/migration-guide-10.2.x.html#http-2-support-requires-jdk-8-update-252-or-later), and therefore is not supported by Akka gRPC.
+If you want to use TLS-based negotiation on JDK 8, Pekko gRPC requires JDK 8 update 252 or later. JVM support for ALPN has been backported to JDK 8u252 which is now widely available. Support for using the Jetty ALPN agent has been dropped in Pekko HTTP and therefore is not supported by Pekko gRPC.
-## Starting your Akka gRPC server from Maven
+## Starting your Pekko gRPC server from Maven
You can start your gRPC application as usual with:
diff --git a/docs/src/main/paradox/buildtools/sbt.md b/docs/src/main/paradox/buildtools/sbt.md
index 2634f9e4..271db8e1 100644
--- a/docs/src/main/paradox/buildtools/sbt.md
+++ b/docs/src/main/paradox/buildtools/sbt.md
@@ -1,6 +1,6 @@
# sbt
-To get started with Akka gRPC read the @ref[client](../client/index.md) or @ref[server](../server/index.md) introductions.
+To get started with Pekko gRPC read the @ref[client](../client/index.md) or @ref[server](../server/index.md) introductions.
## Configuring what to generate
@@ -37,7 +37,7 @@ pekkoGrpcCodeGeneratorSettings += "server_power_apis"
## Passing parameters to the generators
-The sbt plugin for Akka-gRPC uses [ScalaPB](https://scalapb.github.io) and `sbt-protoc`. It is possible to tune these libraries if the provided defaults
+The sbt plugin for Pekko-gRPC uses [ScalaPB](https://scalapb.github.io) and `sbt-protoc`. It is possible to tune these libraries if the provided defaults
don't suit your needs.
### ScalaPB settings
@@ -52,7 +52,7 @@ pekkoGrpcCodeGeneratorSettings += "single_line_to_proto_string"
#### Using a local `protoc` command
-Akka gRPC uses the `protoc` tool to pass `.proto` definitions
+Pekko gRPC uses the `protoc` tool to pass `.proto` definitions
to various code generation components,
via [ScalaPB](https://scalapb.github.io)'s
[sbt-protoc](https://github.com/thesamet/sbt-protoc) and
@@ -121,9 +121,9 @@ libraryDependencies += "com.example" %% "my-grpc-service" % "1.0.0" % "protobuf"
## JDK 8 support
-If you want to use TLS-based negotiation on JDK 8, Akka gRPC requires JDK 8 update 252 or later. JVM support for ALPN has been backported to JDK 8u252 which is now widely available. Support for using the Jetty ALPN agent has been [dropped in Akka HTTP 10.2.0](https://doc.akka.io/docs/akka-http/current/migration-guide/migration-guide-10.2.x.html#http-2-support-requires-jdk-8-update-252-or-later), and therefore is not supported by Akka gRPC.
+If you want to use TLS-based negotiation on JDK 8, Pekko gRPC requires JDK 8 update 252 or later. JVM support for ALPN has been backported to JDK 8u252 which is now widely available. Support for using the Jetty ALPN agent has been dropped in Pekko HTTP, and therefore is not supported by Pekko gRPC.
-## Starting your Akka gRPC server from sbt
+## Starting your Pekko gRPC server from sbt
You can start your gRPC application as usual with:
diff --git a/docs/src/main/paradox/client/configuration.md b/docs/src/main/paradox/client/configuration.md
index 84cf575e..d5dc3b9b 100644
--- a/docs/src/main/paradox/client/configuration.md
+++ b/docs/src/main/paradox/client/configuration.md
@@ -36,14 +36,14 @@ Clients defined in configuration pick up defaults from `reference.conf`:
`reference.conf`
: @@snip [reference](/runtime/src/main/resources/reference.conf) { #defaults }
-## Using Akka Discovery for Endpoint Discovery
+## Using Pekko Discovery for Endpoint Discovery
The examples above all use a hard coded host and port for the location of the gRPC service which is the default if you do not configure a `service-discovery-mechanism`.
-Alternatively @extref[Akka Discovery](akka:discovery/index.html) can be used.
+Alternatively @extref[Pekko Discovery](pekko:discovery/index.html) can be used.
This allows a gRPC client to switch between discovering services via DNS, config, Kubernetes and Consul and others by just changing
-the configuration (see [Discovery methods in Akka Management](https://doc.akka.io/docs/akka-management/current/discovery/index.html)).
+the configuration (see [Discovery methods in Pekko Management](https://pekko.apache.org/docs/pekko-management/current/discovery/index.html)).
-To see how to config a particular service discovery mechanism see the @extref[Akka Discovery docs](akka:discovery/index.html).
+To see how to config a particular service discovery mechanism see the @extref[Pekko Discovery docs](pekko:discovery/index.html).
Once it is configured a service discovery mechanism name can either be passed into settings or put in the client's configuration.
Scala
diff --git a/docs/src/main/paradox/client/walkthrough.md b/docs/src/main/paradox/client/walkthrough.md
index 4194d744..23acecb5 100644
--- a/docs/src/main/paradox/client/walkthrough.md
+++ b/docs/src/main/paradox/client/walkthrough.md
@@ -94,7 +94,7 @@ For a complete overview of the configuration options see the chapter for your bu
### Dependencies
-The Akka gRPC plugin makes your code depend on the `pekko-grpc-runtime` library.
+The Pekko gRPC plugin makes your code depend on the `pekko-grpc-runtime` library.
The table below shows direct dependencies of it and the second tab shows all libraries it depends on transitively. Be aware that the `io.grpc.grpc-api` library depends on Guava.
@@ -110,7 +110,7 @@ For example, this is the definition of a Hello World service:
@@snip [helloworld.proto](/plugin-tester-scala/src/main/protobuf/helloworld.proto) { #walkthrough filterLabels=true }
-From this definition, Akka gRPC generates interfaces that look like this:
+From this definition, Pekko gRPC generates interfaces that look like this:
Scala
: @@snip [helloworld.proto](/plugin-tester-scala/target/scala-2.12/src_managed/main/example/myapp/helloworld/grpc/GreeterService.scala)
@@ -121,7 +121,7 @@ Java
and model @scala[case ]classes for `HelloRequest` and `HelloResponse`.
The service interface is the same for the client and the server side. On the server side, the service implements the interface,
-on the client side the Akka gRPC infrastructure implements a stub that will connect to the remote service when called.
+on the client side the Pekko gRPC infrastructure implements a stub that will connect to the remote service when called.
There are 4 different types of calls:
@@ -152,7 +152,7 @@ Gradle
Maven
: ```
-mvn akka-grpc:generate
+mvn pekko-grpc:generate
```
A main program that calls the server with the `GreeterService` looks like this:
diff --git a/docs/src/main/paradox/deploy.md b/docs/src/main/paradox/deploy.md
index 528078cd..1d088104 100644
--- a/docs/src/main/paradox/deploy.md
+++ b/docs/src/main/paradox/deploy.md
@@ -1,15 +1,15 @@
# Deployment
-You can deploy an Akka gRPC application just like you would any other JVM-based project. For some general pointers on this topic, see [the deployment section of the Akka documentation](https://doc.akka.io/docs/akka/current/additional/deploying.html).
+You can deploy a Pekko gRPC application just like you would any other JVM-based project. For some general pointers on this topic, see @extref[the deployment section of the Pekko documentation](pekko:additional/deploying.html)
Remember that the cleartext HTTP/2 "h2c with prior knowledge" protocol is not compatible with HTTP/1.1, so if your infrastructure uses any proxies they must either understand this protocol or support generic TCP connections.
## Serve gRPC over HTTPS
-To deploy your gRPC service over a HTTPS connection you will have to use an @apidoc[HttpsConnectionContext] as described in the [Akka-HTTP documentation](https://doc.akka.io/docs/akka-http/10.1/server-side/server-https-support.html).
+To deploy your gRPC service over a HTTPS connection you will have to use an @apidoc[HttpsConnectionContext] as described in the @extref[Pekko-HTTP documentation](pekko-http:server-side/server-https-support.html).
-When using HTTPS and running your application on a JDK 8 prior to version 1.8.0_251 you also need to provide an external ALPN implementation. Follow the [section on ALPN](https://doc.akka.io/docs/akka-http/10.1/server-side/http2.html#application-layer-protocol-negotiation-alpn-) in the Akka-HTTP docs for more details.
+When using HTTPS and running your application on a JDK 8 prior to version 1.8.0_251 you also need to provide an external ALPN implementation. Follow the @extref[section on ALPN](pekko-http:server-side/http2.html#application-layer-protocol-negotiation-alpn-) in the Pekko-HTTP docs for more details.
## Example: Kubernetes
-As an example, [here](https://developer.lightbend.com/start/?group=akka&project=akka-grpc-sample-kubernetes-scala) is a complete project consisting of two applications (a gRPC service and an HTTP service that consumes the gRPC service) that can be deployed together in Kubernetes.
+As an example, [akka-grpc-sample-kubernetes-scala](https://developer.lightbend.com/start/?group=akka&project=akka-grpc-sample-kubernetes-scala) is a complete project consisting of two applications (a gRPC service and an HTTP service that consumes the gRPC service) that can be deployed together in Kubernetes.
diff --git a/docs/src/main/paradox/getting-started.md b/docs/src/main/paradox/getting-started.md
index 0cc65822..3b9b49dc 100644
--- a/docs/src/main/paradox/getting-started.md
+++ b/docs/src/main/paradox/getting-started.md
@@ -1,11 +1,10 @@
# Getting started
-## Akka gRPC Quickstart
+## Apache Pekko gRPC Quickstart
-To try out Akka gRPC and understand how the development process might work out, try the [Akka gRPC Quickstart with Scala](https://developer.lightbend.com/guides/akka-grpc-quickstart-scala/) or the [Akka gRPC Quickstart with Java](https://developer.lightbend.com/guides/akka-grpc-quickstart-java/).
+To try out Pakko gRPC and understand how the development process might work out, try the [Akka gRPC Quickstart with Scala](https://developer.lightbend.com/guides/akka-grpc-quickstart-scala/) or the [Akka gRPC Quickstart with Java](https://developer.lightbend.com/guides/akka-grpc-quickstart-java/).
## Video Introduction
-This short video on YouTube shows how easy it is to create a gRPC server with Akka gRPC.
-
-[](https://www.youtube.com/watch?v=kXN30ttsf-I "Watch video on YouTube")
+The Akka team have a [video](https://doc.akka.io/docs/akka-grpc/current/getting-started.html#video-introduction).
+Much of what is discussed is relevant to Pekko gRPC.
diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md
index af305050..f8e72479 100644
--- a/docs/src/main/paradox/index.md
+++ b/docs/src/main/paradox/index.md
@@ -1,4 +1,4 @@
-# Akka gRPC
+# Pekko gRPC
@@toc
diff --git a/docs/src/main/paradox/overview.md b/docs/src/main/paradox/overview.md
index 504f4bcb..971d8745 100644
--- a/docs/src/main/paradox/overview.md
+++ b/docs/src/main/paradox/overview.md
@@ -7,20 +7,20 @@
gRPC APIs are useful instead of (or as a complement to) JSON/REST-based API.
-## Akka gRPC
+## Pekko gRPC
-Akka gRPC provides support for building streaming gRPC servers and clients on top
-of @extref[Akka Streams](akka:stream/) and @extref[Akka HTTP](akka-http:).
+Pekko gRPC provides support for building streaming gRPC servers and clients on top
+of @extref[Pekko Streams](pekko:stream/) and @extref[Pekko HTTP](pekko-http:).
It features:
* A generator, that starts from a protobuf service definitions, for:
- Model classes
- - The service API as a @scala[Scala trait]@java[Java interface] using Akka Stream `Source`s
- - On the @ref[server side](server/index.md), code to create an Akka HTTP route based on your implementation of the service
+ - The service API as a @scala[Scala trait]@java[Java interface] using Pekko Stream `Source`s
+ - On the @ref[server side](server/index.md), code to create a Pekko HTTP route based on your implementation of the service
- On the @ref[client side](client/index.md) side, a client for the service
* gRPC Runtime implementation that uses
- - @extref[Akka HTTP/2 support](akka-http:server-side/http2.html) for the server side and
+ - @extref[Pekko HTTP/2 support](pekko-http:server-side/http2.html) for the server side and
- `grpc-netty-shaded` for the client side.
* Support for @ref[sbt](buildtools/sbt.md), @ref[gradle](buildtools/gradle.md), @ref[Maven](buildtools/maven.md),
and the [Play Framework](https://developer.lightbend.com/docs/play-grpc/current/).
@@ -31,11 +31,10 @@ It features:
## Project Status
-Akka gRPC is [Supported](https://developer.lightbend.com/docs/introduction/getting-help/support-terminology.html)
-as part of a [Lightbend Subscription](https://www.lightbend.com/lightbend-subscription).
+Pekko gRPC is still under development.
-Both client- and server-side APIs are based on Akka Streams.
+Both client- and server-side APIs are based on Pekko Streams.
The client side is currently implemented on top of [io.grpc:grpc-netty-shaded](https://mvnrepository.com/artifact/io.grpc/grpc-netty-shaded).
-Later versions may replace this by [io.grpc:grpc-core](https://mvnrepository.com/artifact/io.grpc/grpc-core) and Akka HTTP, when Akka HTTP offers HTTP/2 client support.
+Later versions may replace this by [io.grpc:grpc-core](https://mvnrepository.com/artifact/io.grpc/grpc-core) and Pekko HTTP, when Pekko HTTP offers HTTP/2 client support.
diff --git a/docs/src/main/paradox/proto.md b/docs/src/main/paradox/proto.md
index 132b5063..4da9c593 100644
--- a/docs/src/main/paradox/proto.md
+++ b/docs/src/main/paradox/proto.md
@@ -29,7 +29,7 @@ There are a number of options that can be set in the `.proto` definition that in
The (optional) [`package`](https://developers.google.com/protocol-buffers/docs/proto3#packages)
in the `.proto` is used to resolve references from one `.proto` file to another.
It can also be used for the package name in the generated code, but it is
-common to use the separate `java_package` option to override it. In the Akka gRPC
+common to use the separate `java_package` option to override it. In the Pekko gRPC
examples the convention is to choose a `java_package` ending in `.grpc` to
easily distinguish between generated and regular code.
diff --git a/docs/src/main/paradox/server/details.md b/docs/src/main/paradox/server/details.md
index 0daa257e..1a4b4da2 100644
--- a/docs/src/main/paradox/server/details.md
+++ b/docs/src/main/paradox/server/details.md
@@ -4,7 +4,7 @@
By default the generated service interfaces don't provide access to the request metadata, only to the request
body (via the RPC method input parameter). If your methods require access to the request @apidoc[Metadata], you can configure
-Akka gRPC to generate server "power APIs" that extend the base service interfaces to provide an additional
+Pekko gRPC to generate server "power APIs" that extend the base service interfaces to provide an additional
request metadata parameter to each service method. See the detailed chapters on @ref[sbt](../buildtools/sbt.md), @ref[Gradle](../buildtools/gradle.md)
and @ref[Maven](../buildtools/maven.md) for how to set this build option. Note that this option doesn't effect the
generated client stubs.
diff --git a/docs/src/main/paradox/server/grpc-web.md b/docs/src/main/paradox/server/grpc-web.md
index 94f1050c..4b2b1f82 100644
--- a/docs/src/main/paradox/server/grpc-web.md
+++ b/docs/src/main/paradox/server/grpc-web.md
@@ -5,12 +5,12 @@
This feature is **experimental**.
The Java/Scala API's to enable this feature may still change in further
-versions of Akka gRPC, and future versions of this feature may not work with
-services generated with older versions of Akka gRPC.
+versions of Pekko gRPC, and future versions of this feature may not work with
+services generated with older versions of Pekko gRPC.
There may be missing features and bugs in the current implementation. If you
encounter any, you are welcome to share a reproducer in our
-[issue tracker](https://github.com/akka/akka-grpc/issues).
+[issue tracker](https://github.com/apache/incubator-pekko-grpc/issues).
@@@
@@ -24,12 +24,12 @@ into native gRPC calls.
The most common deployment model of gRPC-Web is to use a proxy such
as [Envoy](https://www.envoyproxy.io/docs/envoy/latest/configuration/http/http_filters/grpc_web_filter)
to translate between the gRPC-Web frontend and a native gRPC back-end.
-This is a great choice with Akka gRPC services.
+This is a great choice with Pekko gRPC services.
However, in some situations it may be operationally simpler if your service
-supports gRPC-Web directly. This is now possible with Akka gRPC as well.
+supports gRPC-Web directly. This is now possible with Pekko gRPC as well.
-To serve a gRPC service with Akka gRPC, it is recommended to serve the
+To serve a gRPC service with Pekko gRPC, it is recommended to serve the
native gRPC protocol on a different port than gRPC-Web, as the two protocols
will likely require a different security story. You can use
@apidoc[WebHandler.grpcWebHandler](WebHandler$) to serve your
diff --git a/docs/src/main/paradox/server/index.md b/docs/src/main/paradox/server/index.md
index ebf42ee9..b30af6b7 100644
--- a/docs/src/main/paradox/server/index.md
+++ b/docs/src/main/paradox/server/index.md
@@ -1,7 +1,5 @@
# Providing Services (Server)
-Get our Quickstart project (available for [Scala](https://developer.lightbend.com/start/?group=akka&project=akka-grpc-quickstart-scala) and [Java](https://developer.lightbend.com/start/?group=akka&project=akka-grpc-quickstart-java)) to get started quickly.
-
@@ toc
@@@ index
@@ -9,7 +7,7 @@ Get our Quickstart project (available for [Scala](https://developer.lightbend.co
* [Walkthrough](walkthrough.md)
* [gRPC-Web](grpc-web.md)
* [Server Reflection](reflection.md)
- * [Akka HTTP interop](akka-http.md)
+ * [Pekko HTTP interop](pekko-http.md)
* [Details](details.md)
* [Kubernetes](kubernetes.md)
diff --git a/docs/src/main/paradox/server/kubernetes.md b/docs/src/main/paradox/server/kubernetes.md
index 7e0c8491..6ba8625c 100644
--- a/docs/src/main/paradox/server/kubernetes.md
+++ b/docs/src/main/paradox/server/kubernetes.md
@@ -1,6 +1,6 @@
# Kubernetes
-An Akka gRPC service can be deployed to a Kubernetes cluster just like any other HTTP-based application,
+An Pekko gRPC service can be deployed to a Kubernetes cluster just like any other HTTP-based application,
but if you want to make sure HTTP/2 is used across the board there are some things to consider.
There are 3 ways to use HTTP/2:
diff --git a/docs/src/main/paradox/server/akka-http.md b/docs/src/main/paradox/server/pekko-http.md
similarity index 94%
rename from docs/src/main/paradox/server/akka-http.md
rename to docs/src/main/paradox/server/pekko-http.md
index b379e6fa..945b6d65 100644
--- a/docs/src/main/paradox/server/akka-http.md
+++ b/docs/src/main/paradox/server/pekko-http.md
@@ -1,7 +1,7 @@
-# Akka HTTP interop
+# Pekko HTTP interop
-Akka gRPC is built on top of [Akka HTTP](https://doc.akka.io/docs/akka-http).
-This means it is possible to leverage the Akka HTTP API's to create more
+Pekko gRPC is built on top of [Pekko HTTP](https://pekko.apache.org/docs/pekko-http).
+This means it is possible to leverage the Pekko HTTP API's to create more
complicated services, for example serving non-gRPC endpoints next to
gRPC endpoints or adding additional behavior around your gRPC routes.
@@ -14,9 +14,9 @@ HTTP API that users can use to obtain a token, and want to
secure your gRPC routes to only accept calls that include this
token.
-### Akka HTTP authentication route
+### Pekko HTTP authentication route
-This route could be any arbitrary Akka HTTP route. For this example
+This route could be any arbitrary Pekko HTTP route. For this example
we just provide a hint in the response body:
Scala
@@ -25,9 +25,9 @@ Scala
Java
: @@snip [AuthenticatedGreeterServer.java](/plugin-tester-java/src/main/java/example/myapp/helloworld/AuthenticatedGreeterServer.java) { #http-route }
-### Akka gRPC route
+### Pekko gRPC route
-We create the Akka gRPC service implementation, and convert it to a @apidoc[Route$] as well:
+We create the Pekko gRPC service implementation, and convert it to a @apidoc[Route$] as well:
Scala
: @@snip [AuthenticatedGreeterServer.scala](/plugin-tester-scala/src/main/scala/example/myapp/helloworld/AuthenticatedGreeterServer.scala) { #grpc-route }
@@ -35,7 +35,7 @@ Scala
Java
: @@snip [AuthenticatedGreeterServer.java](/plugin-tester-java/src/main/java/example/myapp/helloworld/AuthenticatedGreeterServer.java) { #grpc-route }
-### Securing the Akka gRPC route
+### Securing the Pekko gRPC route
We can wrap the gRPC route just like any @apidoc[Route$], applying the authorization:
@@ -198,9 +198,9 @@ java.util.NoSuchElementException: next on empty iterator
## Future work
-For in-depth akka-grpc/akka-http integration we currently need to pass information from the Akka HTTP route
+For in-depth pekko-grpc/pekko-http integration we currently need to pass information from the Pekko HTTP route
into the service implementation constructor, and construct a new Handler for each request.
This pattern is shown in an example above.
In the future we plan to provide a nicer API for this, for example we could pass the
-Akka HTTP attributes (introduced in 10.2.0) as Metadata when using the PowerApi.
+Pekko HTTP attributes (introduced in 10.2.0) as Metadata when using the PowerApi.
diff --git a/docs/src/main/paradox/server/reflection.md b/docs/src/main/paradox/server/reflection.md
index 3c079968..d869d919 100644
--- a/docs/src/main/paradox/server/reflection.md
+++ b/docs/src/main/paradox/server/reflection.md
@@ -7,12 +7,12 @@ This feature is **experimental** (@github[Issue #850](#850)).
It implements version v1alpha of the [upstream standard](https://github.com/grpc/grpc/blob/master/src/proto/grpc/reflection/v1alpha/reflection.proto),
so we might expect subsequent versions of the service to emerge. Also,
the Java/Scala API's to enable this feature may still change in further
-versions of Akka gRPC, and future versions of this feature may not work with
-services generated with older versions of Akka gRPC.
+versions of Pekko gRPC, and future versions of this feature may not work with
+services generated with older versions of Pekko gRPC.
There may be missing features and bugs in the current implementation. If you
encounter any, you are welcome to share a reproducer in our
-[issue tracker](https://github.com/akka/akka-grpc/issues).
+[issue tracker](https://github.com/apache/incubator-pekko-grpc/issues).
@@@
@@ -27,7 +27,7 @@ can be used to query this information.
## Providing
-The generated service handler includes a convenience method to create an Akka HTTP
+The generated service handler includes a convenience method to create a Pekko HTTP
handler with your service together with Server Reflection:
Scala
@@ -59,8 +59,8 @@ the service with [grpc_cli](https://github.com/grpc/grpc/blob/master/doc/command
$ ./bins/opt/grpc_cli call localhost:8080 helloworld.GreeterService.SayHello "name:\"foo\""
connecting to localhost:8080
Received initial metadata from server:
-date : Wed, 08 Jan 2020 16:57:56 GMT
-server : akka-http/10.1.10
+date : Wed, 08 Jan 2022 16:57:56 GMT
+server : pekko-http/1.0.0
message: "Hello, foo"
Received trailing metadata from server:
diff --git a/docs/src/main/paradox/server/walkthrough.md b/docs/src/main/paradox/server/walkthrough.md
index 382a6052..6814d9c1 100644
--- a/docs/src/main/paradox/server/walkthrough.md
+++ b/docs/src/main/paradox/server/walkthrough.md
@@ -6,7 +6,7 @@ To get started, you must obtain or write the @ref[`.proto`](../proto.md) file(s)
to your project. Add `.proto` files to your project's @sbt[`src/main/protobuf`]@gradle[`src/main/proto`]@maven[`src/main/proto`] directory.
(See the detailed chapters on @ref[sbt](../buildtools/sbt.md), @ref[Gradle](../buildtools/gradle.md) and @ref[Maven](../buildtools/maven.md) for information on taking .proto definitions from dependencies)
-Then add the Akka gRPC plugin to your build:
+Then add the Pekko gRPC plugin to your build:
sbt
: @@@vars
@@ -92,7 +92,7 @@ For a complete overview of the configuration options see the chapter for your bu
### Dependencies
-The Akka gRPC plugin makes your code depend on the `pekko-grpc-runtime` library.
+The Pekko gRPC plugin makes your code depend on the `pekko-grpc-runtime` library.
The table below shows direct dependencies of it and the second tab shows all libraries it depends on transitively. Be aware that the `io.grpc.grpc-api` library depends on Guava.
@@ -126,7 +126,7 @@ Maven
mvn akka-grpc:generate
```
-From the above definition, Akka gRPC generates interfaces that look like this:
+From the above definition, Pekko gRPC generates interfaces that look like this:
Scala
: @@snip [helloworld.proto](/plugin-tester-scala/target/scala-2.12/src_managed/main/example/myapp/helloworld/grpc/GreeterService.scala)
@@ -137,7 +137,7 @@ Java
and model @scala[case ]classes for `HelloRequest` and `HelloResponse`.
The service interface is the same for the client and the server side. On the server side, the service implements the interface,
-on the client side the Akka gRPC infrastructure implements a stub that will connect to the remote service when called.
+on the client side the Pekko gRPC infrastructure implements a stub that will connect to the remote service when called.
There are 4 different types of calls:
@@ -162,14 +162,14 @@ Scala
Java
: @@snip [GreeterServiceImpl.java](/plugin-tester-java/src/main/java/example/myapp/helloworld/GreeterServiceImpl.java) { #full-service-impl }
-## Serving the service with Akka HTTP
+## Serving the service with Pekko HTTP
Note, how the implementation we just wrote is free from any gRPC related boilerplate. It only uses the generated model and interfaces
-from your domain and basic Akka streams classes. We now need to connect this implementation class to the web server to
+from your domain and basic Pekko streams classes. We now need to connect this implementation class to the web server to
offer it to clients.
-Akka gRPC servers are implemented with Akka HTTP. In addition to the above `GreeterService`, a @scala[`GreeterServiceHandler`]@java[`GreeterServiceHandlerFactory`]
-was generated that wraps the implementation with the gRPC functionality to be plugged into an existing Akka HTTP server
+Pekko gRPC servers are implemented with Pekko HTTP. In addition to the above `GreeterService`, a @scala[`GreeterServiceHandler`]@java[`GreeterServiceHandlerFactory`]
+was generated that wraps the implementation with the gRPC functionality to be plugged into an existing Pekko HTTP server
app.
You create the request handler by calling @scala[`GreeterServiceHandler(yourImpl)`]@java[`GreeterServiceHandlerFactory.create(yourImpl, ...)`].
@@ -182,7 +182,7 @@ about safely implementing servers with state see the advice about [stateful](#st
@@@
-A complete main program that starts an Akka HTTP server with the `GreeterService` looks like this:
+A complete main program that starts a Pekko HTTP server with the `GreeterService` looks like this:
Scala
: @@snip [GreeterServiceImpl.scala](/plugin-tester-scala/src/main/scala/example/myapp/helloworld/GreeterServer.scala) { #full-server }
@@ -192,7 +192,7 @@ Java
@@@ note
-It's important to enable HTTP/2 in Akka HTTP in the configuration of the `ActorSystem` by setting
+It's important to enable HTTP/2 in Pekko HTTP in the configuration of the `ActorSystem` by setting
```
pekko.http.server.preview.enable-http2 = on
@@ -222,10 +222,10 @@ methods to create partial functions that are combined by `concatOrNotFound`.]
## Running the server
To run the server with HTTP/2 using HTTPS on a JVM prior to version 1.8.0_251, you will likely have to configure the Jetty ALPN
-agent as described [in the Akka HTTP documentation](https://doc.akka.io/docs/akka-http/10.1/server-side/http2.html#application-layer-protocol-negotiation-alpn-). Later JVM versions have this support built-in.
+agent as described @extref[in the Pekko HTTP documentation](pekko-http:server-side/http2.html#application-layer-protocol-negotiation-alpn-). Later JVM versions have this support built-in.
-See the detailed chapters on @ref[sbt](../buildtools/sbt.md#starting-your-akka-grpc-server-from-sbt), @ref[Gradle](../buildtools/gradle.md#starting-your-akka-grpc-server-from-gradle)
-and @ref[Maven](../buildtools/maven.md#starting-your-akka-grpc-server-from-maven) for details on adding the agent.
+See the detailed chapters on @ref[sbt](../buildtools/sbt.md#starting-your-pekko-grpc-server-from-sbt), @ref[Gradle](../buildtools/gradle.md#starting-your-pekko-grpc-server-from-gradle)
+and @ref[Maven](../buildtools/maven.md#starting-your-pekko-grpc-server-from-maven) for details on adding the agent.
## Stateful services
diff --git a/docs/src/main/paradox/whygrpc.md b/docs/src/main/paradox/whygrpc.md
index b4faddbe..3a15e394 100644
--- a/docs/src/main/paradox/whygrpc.md
+++ b/docs/src/main/paradox/whygrpc.md
@@ -37,13 +37,13 @@ That makes it well-suited for:
* While built on an efficient non-blocking implementation, gRPC is still 'synchronous' in the sense that it requires both 'sides' of the communication to be available at the same time. When using a (persistent) message bus, only the producer and the bus must be up, the consumer does not need to be available, leading to a higher degree of decoupling.
* While gRPC supports bidirectional streaming for each request, when using a message bus the streams are decoupled.
-## gRPC vs Akka Remoting
+## gRPC vs Pekko Remoting
-* While Akka Remoting allows exchanging messages between Akka ActorSystems transparently, it still requires significant effort to support efficient and compatible message serialization.
+* While Pekko Remoting allows exchanging messages between Pekko ActorSystems transparently, it still requires significant effort to support efficient and compatible message serialization.
Large messages can clog the message transport. In contrast to gRPC, streaming is not first-class but needs to be built on top of message passing (e.g. by using [StreamRefs](https://doc.akka.io/docs/akka/current/stream/stream-refs.html)).
-* Akka Remoting's wire protocol might change with Akka versions and configuration, so you need to make sure that all parts of your system run similar enough versions. gRPC on the other
+* Pekko Remoting's wire protocol might change with Pekko versions and configuration, so you need to make sure that all parts of your system run similar enough versions. gRPC on the other
hand guarantees longer-term stability of the protocol, so gRPC clients and services are more loosely coupled.
-* Where message passing as with Akka Remoting is fire-and-forget which decouples service execution, any kind of RPC requires waiting until the remote procedure call is answered.
- Waiting (even non-blocking) for a response which is needed for any case of RPC often binds significant resources. To be fair, (Akka) actor communication is often structured in a
+* Where message passing as with Pekko Remoting is fire-and-forget which decouples service execution, any kind of RPC requires waiting until the remote procedure call is answered.
+ Waiting (even non-blocking) for a response which is needed for any case of RPC often binds significant resources. To be fair, (Pekko) actor communication is often structured in a
request/response fashion which makes it very similar to more traditional RPC techniques and gives the same disadvantages
(like state that needs to be kept on the "client" side requiring timeouts while waiting for a response).
diff --git a/gradle-plugin/build.gradle b/gradle-plugin/build.gradle
index 8f3638b4..de337360 100644
--- a/gradle-plugin/build.gradle
+++ b/gradle-plugin/build.gradle
@@ -24,7 +24,7 @@ gradlePlugin {
}
pluginBundle {
- website = 'https://doc.akka.io/docs/akka-grpc/current/'
+ website = 'https://pekko.apache.org/docs/pekko-grpc/current/'
vcsUrl = 'https://github.com/apache/incubator-pekko-grpc'
description = 'Building streaming gRPC servers and clients on top of Apache Pekko Streams'
tags = ['pekko', 'streams', 'reactive']
diff --git a/project/Common.scala b/project/Common.scala
index b63c397d..a97c64c8 100644
--- a/project/Common.scala
+++ b/project/Common.scala
@@ -75,7 +75,7 @@ object Common extends AutoPlugin {
s"https://github.com/apache/incubator-pekko-grpc/tree/${branch}€{FILE_PATH_EXT}#L€{FILE_LINE}"
},
"-doc-canonical-base-url",
- "https://doc.akka.io/api/akka-grpc/current/"),
+ "https://pekko.aoache.org/api/pekko-grpc/current/"),
Compile / doc / scalacOptions -= "-Xfatal-warnings",
apiURL := Some(url(s"https://doc.akka.io/api/akka-grpc/${projectInfoVersion.value}/akka/grpc/index.html")),
(Test / testOptions) += Tests.Argument(TestFrameworks.ScalaTest, "-oDF"),
diff --git a/project/plugins.sbt b/project/plugins.sbt
index 8da9fc40..4d6d9444 100644
--- a/project/plugins.sbt
+++ b/project/plugins.sbt
@@ -26,7 +26,7 @@ libraryDependencySchemes += "org.scala-lang.modules" %% "scala-xml" % "always"
// We have to deliberately use older versions of sbt-paradox because current Pekko sbt build
// only loads on JDK 1.8 so we need to bring in older versions of parboiled which support JDK 1.8
-addSbtPlugin(("org.apache.pekko" % "pekko-sbt-paradox" % "0.0.0+28-a1dda63b-SNAPSHOT").excludeAll(
+addSbtPlugin(("org.apache.pekko" % "pekko-sbt-paradox" % "0.0.0+37-3df33944-SNAPSHOT").excludeAll(
"com.lightbend.paradox", "sbt-paradox",
"com.lightbend.paradox" % "sbt-paradox-apidoc",
"com.lightbend.paradox" % "sbt-paradox-project-info"))
diff --git a/project/project-info.conf b/project/project-info.conf
index 0c928dc4..6ca83b48 100644
--- a/project/project-info.conf
+++ b/project/project-info.conf
@@ -1,33 +1,37 @@
project-info {
version: "current"
shared-info {
- jdk-versions: ["Adopt OpenJDK 8", "Adopt OpenJDK 11"]
+ jdk-versions: ["OpenJDK 8", "OpenJDK 11", "OpenJDK 17"]
snapshots: {
url: "https://repository.apache.org/content/groups/snapshots/org/apache/pekko/grpc/"
text: "Snapshots are available from Apache Snapshots Repository"
}
issues: {
- url: "https://github.com/akka/akka-grpc/issues"
+ url: "https://github.com/apache/incubator-pekko-grpc/issues"
text: "GitHub issues"
}
release-notes: {
- url: "https://github.com/akka/akka-grpc/releases"
+ url: "https://github.com/apache/incubator-pekko-grpc/releases"
text: "GitHub releases"
}
api-docs: [
{
- url: "https://doc.akka.io/api/akka-grpc/"${project-info.version}"/akka/grpc/"
+ url: "https://pekko.apache.org/api/pekko-grpc/"${project-info.version}"/org/apache/pekko/grpc/"
text: "API (Scaladoc)"
}
]
forums: [
{
- text: "Lightbend Discuss"
- url: "https://discuss.lightbend.com/c/akka/akka-grpc"
+ text: "Apache Pekko User mailing list"
+ url: "https://lists.apache.org/list.html?user@pekko.apache.org"
}
{
- text: "akka/akka Gitter channel"
- url: "https://gitter.im/akka/akka"
+ text: "Apache Pekko Dev mailing list"
+ url: "https://lists.apache.org/list.html?dev@pekko.apache.org"
+ }
+ {
+ text: "Github Discussions"
+ url: "https://github.com/apache/incubator-pekko-management/discussions"
}
]
}
diff --git a/scripts/create-release-issue.sh b/scripts/create-release-issue.sh
deleted file mode 100755
index b199cb60..00000000
--- a/scripts/create-release-issue.sh
+++ /dev/null
@@ -1,10 +0,0 @@
-#!/bin/bash
-
-VERSION=$1
-if [ -z $VERSION ]
-then
- echo specify the version name to be released, eg. 1.0.0
-else
- sed -e 's/\$VERSION\$/'$VERSION'/g' docs/release-train-issue-template$2.md > /tmp/release-$VERSION.md
- echo Created $(hub issue create -F /tmp/release-$VERSION.md --browse)
-fi
diff --git a/scripts/link-validator.conf b/scripts/link-validator.conf
index 1eca7df8..cb64d108 100644
--- a/scripts/link-validator.conf
+++ b/scripts/link-validator.conf
@@ -6,7 +6,7 @@ site-link-validator {
# Resolves URLs with the given prefix as local files instead
link-mappings = [
{
- prefix = "https://doc.akka.io/docs/akka-grpc/snapshot/"
+ prefix = "https://pekko.apache.org/docs/pekko-grpc/snapshot/"
replace = "/docs/akka-grpc/snapshot/"
}
{
@@ -20,6 +20,7 @@ site-link-validator {
ignore-prefixes = [
# GitHub will block with "429 Too Many Requests"
"https://github.com/akka/akka-grpc/"
+ "https://github.com/apache/incubator-pekko-grpc/"
# MVN repository forbids access after a few requests
"https://mvnrepository.com/artifact/"
]
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org