Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to "Kalix Runtime" and version 1.1.26 #522

Closed
wants to merge 8 commits into from
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -919,7 +919,7 @@ jobs:
command: |
source /opt/circleci/.nvm/nvm.sh
nvm install v18
# Run proxy in background
# Run Kalix Runtime in background
sed -i docker-compose.yml -e "s/environment:/environment:\n VERSION_CHECK_ON_STARTUP: \"false\"/"
docker-compose up -d
# Run the service in background
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/---bug-report.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve
labels: kalix-proxy, bug
labels: kalix-runtime, bug
---
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/---feature-request.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
name: "\U0001F389 Feature request"
about: Suggest an idea for this project
labels: kalix-proxy
labels: kalix-runtime
---
4 changes: 2 additions & 2 deletions .github/release-issue-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

- [ ] Make sure all important PRs have been merged
- [ ] Check that the [latest build](https://app.circleci.com/pipelines/github/lightbend/kalix-javascript-sdk) successfully finished
- [ ] Make sure a version of the proxy that supports the protocol version the SDK expects has been deployed to production
- [ ] Make sure a version of the Kalix Runtime that supports the protocol version the SDK expects has been deployed to production

You can see the proxy version on prod [on grafana](https://lightbendcloud.grafana.net/d/nRHj4uwnk/prod-kalix-operations-dashboard?orgId=1) or using [various other methods](https://github.com/lightbend/kalix/wiki/Versioning-and-how-to-determine-what-version-is-running).
You can see the Runtime version on prod [on grafana](https://lightbendcloud.grafana.net/d/nRHj4uwnk/prod-kalix-operations-dashboard?orgId=1) or using [various other methods](https://github.com/lightbend/kalix/wiki/Versioning-and-how-to-determine-what-version-is-running).

### Cutting the release

Expand Down
2 changes: 1 addition & 1 deletion RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Create a release issue (using the [GitHub CLI](https://cli.github.com/))

```
gh issue create --title 'Release Kalix JavaScript SDK' --label kalix-proxy --body-file .github/release-issue-template.md -w
gh issue create --title 'Release Kalix JavaScript SDK' --label kalix-runtime --body-file .github/release-issue-template.md -w
````

and follow the instructions.
Expand Down
8 changes: 4 additions & 4 deletions bin/create-local-dependencies.sh
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
#!/usr/bin/env bash
## This script sets the dependencies for the `samples` so you can
## modify in local the SDK and test it on a sample.
## It can also include your local kalix-proxy if PROXY_SNAPSHOT_DIRECTORY is set
## It can also include your local kalix-runtime if PROXY_SNAPSHOT_DIRECTORY is set

if [[ "${PROXY_SNAPSHOT_DIRECTORY}" ]]; then
echo "PROXY_SNAPSHOT_DIRECTORY is set to [${PROXY_SNAPSHOT_DIRECTORY}]"
echo "using your local kalix-proxy project to generate the SDK"
echo "using your local kalix-runtime project to generate the SDK"
else
echo "PROXY_SNAPSHOT_DIRECTORY is not set"
echo "when set you can use your local kalix-proxy project to generate the SDK"
echo "when set you can use your local kalix-runtime project to generate the SDK"
cd sdk && framework_version=$(node --print 'require("./config.json").frameworkVersion') && cd ..
echo "you are downloading kalix-proxy [${framework_version}] to generate the SDK"
echo "you are downloading kalix-runtime [${framework_version}] to generate the SDK"
fi

export KALIXJSSDK=${PWD}
Expand Down
32 changes: 2 additions & 30 deletions bin/update-proxy-versions.sh
Original file line number Diff line number Diff line change
@@ -1,32 +1,4 @@
#!/usr/bin/env bash
# delegating from the old script name

# USAGE:
# > PROXY_VERSION=1.0.31 ./update-proxy-versions.sh

# this script is meant to be used after a new Proxy version is out
# to facilitate the update of all the places where we usually depend on the latest version

# provide the new proxy version you want the project to be updated to
if [[ -z "$PROXY_VERSION" ]]; then
echo "Must provide PROXY_VERSION in environment" 1>&2
exit 1
fi

cd ..

echo ">>> Updating docker image versions to $PROXY_VERSION"
PROJS=$(find . -type f -name "docker-compose.yml")
for i in ${PROJS[@]}
do
echo "Updating Dockerfile for: $i"
sed -i.bak "s/gcr.io\/kalix-public\/kalix-proxy:\(.*\)/gcr.io\/kalix-public\/kalix-proxy:$PROXY_VERSION/" $i
rm $i.bak
done

echo ">>> Updating application.conf"
sed -i.bak "s/gcr.io\/kalix-public\/kalix-proxy:\(.*\)\"/gcr.io\/kalix-public\/kalix-proxy:$PROXY_VERSION\"/" ./codegen/js-gen-cli/src/it/resources/application.conf
rm ./codegen/js-gen-cli/src/it/resources/application.conf.bak

echo ">>> Updating config.json"
sed -i.bak "s/\"frameworkVersion\": \"\(.*\)\"/\"frameworkVersion\": \"$PROXY_VERSION\"/" ./sdk/config.json
rm ./sdk/config.json.bak
$pwd/update-runtime-versions.sh
32 changes: 32 additions & 0 deletions bin/update-runtime-versions.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
#!/usr/bin/env bash

# USAGE:
# > RUNTIME_VERSION=1.0.31 ./update-runtime-versions.sh

# this script is meant to be used after a new Runtime version is out
# to facilitate the update of all the places where we usually depend on the latest version

# provide the new Runtime version you want the project to be updated to
if [[ -z "${RUNTIME_VERSION}" ]]; then
echo "Must provide RUNTIME_VERSION in environment" 1>&2
exit 1
fi

cd ..

echo ">>> Updating docker image versions to ${RUNTIME_VERSION}"
PROJS=$(find . -type f -name "docker-compose.yml")
for i in ${PROJS[@]}
do
echo "Updating Dockerfile for: $i"
sed -i.bak "s/gcr.io\/kalix-public\/kalix-runtime:\(.*\)/gcr.io\/kalix-public\/kalix-runtime:${RUNTIME_VERSION}/" $i
rm $i.bak
done

echo ">>> Updating application.conf"
sed -i.bak "s/gcr.io\/kalix-public\/kalix-runtime:\(.*\)\"/gcr.io\/kalix-public\/kalix-runtime:${RUNTIME_VERSION}\"/" ./codegen/js-gen-cli/src/it/resources/application.conf
rm ./codegen/js-gen-cli/src/it/resources/application.conf.bak

echo ">>> Updating config.json"
sed -i.bak "s/\"frameworkVersion\": \"\(.*\)\"/\"frameworkVersion\": \"${RUNTIME_VERSION}\"/" ./sdk/config.json
rm ./sdk/config.json.bak
2 changes: 1 addition & 1 deletion codegen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,6 @@ components may break as a result of changes made to codegen. Therefore, the inte
are provided as a tool to understand in advance what may break.

To be able to truly validate generated code, each language has a full integration test to generate and test the result in a dockerised environment.
These tests spin up a generated entity alongside the Kalix proxy in a Docker network, and then validate against the published service. These tests can take several minutes to run due to the overhead of installing dependencies in a containerised environment, so will only be run when necessary.
These tests spin up a generated entity alongside the Kalix Runtime in a Docker network, and then validate against the published service. These tests can take several minutes to run due to the overhead of installing dependencies in a containerised environment, so will only be run when necessary.

These tests are invoked with the `it:test` SBT task, either on the root project or within one of the subprojects that implements an integration test.
2 changes: 1 addition & 1 deletion codegen/js-gen-cli/src/it/resources/application.conf
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ kalix-npm-js {
}

kalix-proxy {
image = "gcr.io/kalix-public/kalix-proxy:1.1.24"
image = "gcr.io/kalix-public/kalix-runtime:1.1.25"
}
2 changes: 1 addition & 1 deletion docs/src/modules/javascript/pages/running-locally.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ To update the docker compose file to run multiple proxy instances, add the snipp
[source, yaml]
----
kalix-proxy: <1>
image: gcr.io/kalix-public/kalix-proxy:latest
image: gcr.io/kalix-public/kalix-runtime:latest
ports:
- "900x:900x" <2>
JAVA_TOOL_OPTIONS: >
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/javascript/pages/value-entity.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ include::example$valueentity-counter/proto/counter_api.proto[]

The following code creates the Value Entity with the link:{attachmentsdir}/api/classes/ValueEntity.html[`ValueEntity`{tab-icon}, window="new"] class. It passes in:

* The protobuf files, `counter_api.proto` and `counter_domain.proto`, define the service and the domain protocol. Kalix uses the service protobuf file to load and read the service. It uses the definitions in `counter_domain.proto` to serialize state it receives from the https://docs.kalix.io/reference/glossary.html#proxy[proxy].
* The protobuf files, `counter_api.proto` and `counter_domain.proto`, define the service and the domain protocol. Kalix uses the service protobuf file to load and read the service. It uses the definitions in `counter_domain.proto` to serialize state it receives from the https://docs.kalix.io/reference/glossary.html#runtime[Runtime].

* The fully qualified name of the service the Value Entity implements, `com.example.CounterService`. The `entityType` is used to namespace the state in the journal.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/js-customer-registry/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/js-doc-snippets/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/js-replicated-entity-example/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/js-shopping-cart-quickstart/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/js-valueentity-shopping-cart/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/js-views-example/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/js/valueentity-counter/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/ts/ts-customer-registry/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/ts/ts-replicated-entity-example/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/ts/ts-shopping-cart-quickstart/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/ts/ts-valueentity-counter/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/ts/ts-valueentity-shopping-cart/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion samples/ts/ts-views-example/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "3"
services:
kalix-proxy:
image: gcr.io/kalix-public/kalix-proxy:1.1.24
image: gcr.io/kalix-public/kalix-runtime:1.1.25
command: -Dconfig.resource=dev-mode.conf -Dlogback.configurationFile=logback-dev-mode.xml -Dkalix.proxy.eventing.support=google-pubsub-emulator
ports:
- "9000:9000"
Expand Down
2 changes: 1 addition & 1 deletion sdk/config.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"frameworkVersion": "1.1.24"
"frameworkVersion": "1.1.25"
}
8 changes: 4 additions & 4 deletions testkit/src/integration-testkit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import {
} from '@kalix-io/kalix-javascript-sdk';
import { GenericContainer, TestContainers, Wait } from 'testcontainers';

const defaultDockerImage = `gcr.io/kalix-public/kalix-proxy:${settings.frameworkVersion.replace(
const defaultDockerImage = `gcr.io/kalix-public/kalix-runtime:${settings.frameworkVersion.replace(
'-SNAPSHOT',
'',
)}`;
Expand Down Expand Up @@ -160,7 +160,7 @@ export class IntegrationTestkit {
const boundPort = await this.kalix.start({ port: 0 });

await TestContainers.exposeHostPorts(boundPort);
console.log('Starting Kalix Proxy');
console.log('Starting Kalix Runtime');
const proxyContainer = await new GenericContainer(this.options.dockerImage!)
.withExposedPorts(9000)
.withEnv('USER_FUNCTION_HOST', 'host.testcontainers.internal')
Expand All @@ -175,7 +175,7 @@ export class IntegrationTestkit {
'VERSION_CHECK_ON_STARTUP',
process.env.VERSION_CHECK_ON_STARTUP || 'true',
)
.withWaitStrategy(Wait.forLogMessage('Starting Kalix Proxy'))
.withWaitStrategy(Wait.forLogMessage('Kalix Runtime started'))
ennru marked this conversation as resolved.
Show resolved Hide resolved
.start();
this.proxyPort = proxyContainer.getMappedPort(9000);
// sdk needs to know how to call itself for cross component calls,
Expand All @@ -185,7 +185,7 @@ export class IntegrationTestkit {
this.proxyContainer = proxyContainer;

// wait for discovery to complete
console.log('Proxy started, waiting for discovery to complete');
console.log('Kalix Runtime started, waiting for discovery to complete');
while (!this.kalix.discoveryCompleted) {
await new Promise((resolve) => setTimeout(resolve, 300));
}
Expand Down