From 6b6d7c0a00a6f7b136c3f0564325ade5ba4a7571 Mon Sep 17 00:00:00 2001 From: Till Rohrmann Date: Tue, 28 Nov 2023 22:33:48 +0100 Subject: [PATCH] Replace ghcr.io/restatedev/restate-dist with docker.io/restatedev/restate --- docs/quickstart.mdx | 4 +- docs/restate/deployment.md | 3 +- docs/restate/tracing.md | 10 +- docs/services/deployment/lambda.md | 4 +- docs/tour.mdx | 10 +- docusaurus.config.js | 146 ++++++++++++++--------------- 6 files changed, 88 insertions(+), 89 deletions(-) diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx index f8f02792..aaa6ff1b 100644 --- a/docs/quickstart.mdx +++ b/docs/quickstart.mdx @@ -52,7 +52,7 @@ This starts the greeter service on port 9080. Run the Restate Docker container: ```shell -docker run --name restate_dev --rm -d --network=host ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d --network=host docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` Register the service: @@ -74,7 +74,7 @@ After executing this curl request, you should see the discovered services and me Run the Restate Docker container: ```shell -docker run --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` Register the services: diff --git a/docs/restate/deployment.md b/docs/restate/deployment.md index ba3c8961..92b2ebbf 100644 --- a/docs/restate/deployment.md +++ b/docs/restate/deployment.md @@ -50,7 +50,7 @@ spec: - name: github containers: - name: restate - image: ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION + image: docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION env: - name: RESTATE_TRACING__LOG_FORMAT value: Json @@ -104,4 +104,3 @@ You will also need to create an image pull secret using a classic github persona ```bash $ kubectl create secret docker-registry github --docker-server=ghcr.io --docker-username= --docker-password= ``` - diff --git a/docs/restate/tracing.md b/docs/restate/tracing.md index 991c3017..a4f1ad68 100644 --- a/docs/restate/tracing.md +++ b/docs/restate/tracing.md @@ -48,14 +48,14 @@ Then launch Restate with the tracing endpoint defined as an environment variable ```shell -docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://localhost:4317 --network=host ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://localhost:4317 --network=host docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` ```shell -docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://host.docker.internal:4317 -p 8080:8080 -p 9070:9070 -p 9071:9071 ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://host.docker.internal:4317 -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` @@ -84,10 +84,10 @@ The traces contain detailed information about the context calls that were done d The initial `ingress_invoke` spans show when the gRPC/Connect HTTP request was received by Restate. The `invoke` span beneath it shows when Restate invoked the service endpoint to process the request. -The tags of the spans contain the metadata of the context calls (e.g. call arguments, invocation id). +The tags of the spans contain the metadata of the context calls (e.g. call arguments, invocation id). When a service invokes another service, the child invocation is linked automatically to the parent invocation, as you can see in the image. -Note that the spans of one-way calls are shown as separate traces. The parent invocation only shows that the one-way call was scheduled, not its entire tracing span. +Note that the spans of one-way calls are shown as separate traces. The parent invocation only shows that the one-way call was scheduled, not its entire tracing span. To see this information, search for the trace of the one-way call by filtering on the invocation id tag: ``` restate.invocation.id="T4pIkIJIGAsBiiGDV2dxK7PkkKnWyWHE" @@ -97,4 +97,4 @@ restate.invocation.id="T4pIkIJIGAsBiiGDV2dxK7PkkKnWyWHE" Traces export attributes and tags that correlate the trace with the service and/or invocation. For example, in the Jaeger UI, you can filter on the invocation id (`restate.invocation.id`) or any other tag: -![Jaeger invocation id search](/img/jaeger_invocationid_search_handler.png) \ No newline at end of file +![Jaeger invocation id search](/img/jaeger_invocationid_search_handler.png) diff --git a/docs/services/deployment/lambda.md b/docs/services/deployment/lambda.md index dd66f729..ec61809f 100644 --- a/docs/services/deployment/lambda.md +++ b/docs/services/deployment/lambda.md @@ -181,11 +181,11 @@ see https://github.com/awslabs/aws-sdk-rust/issues/703#issuecomment-1811480196. - On Linux ```shell -docker run -e AWS_PROFILE -v ~/.aws/:/root/.aws --name restate_dev --rm -d --network=host ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run -e AWS_PROFILE -v ~/.aws/:/root/.aws --name restate_dev --rm -d --network=host docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` - On macOS: ```shell -docker run -e AWS_PROFILE -v ~/.aws/:/root/.aws --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run -e AWS_PROFILE -v ~/.aws/:/root/.aws --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` Consult the runtime logs via `docker logs restate_dev`. diff --git a/docs/tour.mdx b/docs/tour.mdx index 67ffdb43..18be6fcd 100644 --- a/docs/tour.mdx +++ b/docs/tour.mdx @@ -37,7 +37,7 @@ As we go, you will discover how Restate can help you with some intricacies in th This guide is written for: - Typescript SDK version: `@restatedev/restate-sdk:VAR::TYPESCRIPT_SDK_VERSION` -- Restate runtime Docker image: `restate-dist:VAR::RESTATE_DIST_VERSION` +- Restate runtime Docker image: `restatedev/restate:VAR::RESTATE_DIST_VERSION` ## 🚀 Let's get started! @@ -65,14 +65,14 @@ Launch the runtime: ```shell -docker run --name restate_dev --rm -d --network=host ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d --network=host docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` ```shell -docker run --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` @@ -1332,14 +1332,14 @@ Then restart the runtime with the tracing endpoint defined as an environment var ```shell -docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://localhost:4317 --network=host ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://localhost:4317 --network=host docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` ```shell -docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://host.docker.internal:4317 -p 8080:8080 -p 9070:9070 -p 9071:9071 ghcr.io/restatedev/restate-dist:VAR::RESTATE_DIST_VERSION +docker run --name restate_dev --rm -d -e RESTATE_OBSERVABILITY__TRACING__ENDPOINT=http://host.docker.internal:4317 -p 8080:8080 -p 9070:9070 -p 9071:9071 docker.io/restatedev/restate:VAR::RESTATE_DIST_VERSION ``` diff --git a/docusaurus.config.js b/docusaurus.config.js index 207334ab..01365acf 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -1,55 +1,55 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion -const lightCodeTheme = require('prism-react-renderer/themes/github'); -const darkCodeTheme = require('prism-react-renderer/themes/dracula'); -const variableInjector = require('./src/plugins/variable-injector') -const variablesReplacements = require('./restate.config.json'); +const lightCodeTheme = require("prism-react-renderer/themes/github"); +const darkCodeTheme = require("prism-react-renderer/themes/dracula"); +const variableInjector = require("./src/plugins/variable-injector"); +const variablesReplacements = require("./restate.config.json"); const redocusaurus = [ - 'redocusaurus', + "redocusaurus", { - config: 'redocly.yaml', + config: "redocly.yaml", specs: [ { - id: 'meta-rest-api', - spec: 'static/schemas/openapi-meta.json', + id: "meta-rest-api", + spec: "static/schemas/openapi-meta.json", }, - ] + ], }, -] +]; /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'Restate documentation', - tagline: 'Distributed application development made simple', - favicon: '/img/logo_only.png', + title: "Restate documentation", + tagline: "Distributed application development made simple", + favicon: "/img/logo_only.png", // Set the production url of your site here - url: 'https://docs.restate.dev', + url: "https://docs.restate.dev", // Set the // pathname under which your site is served // For GitHub pages deployment, it is often '//' - baseUrl: '/', + baseUrl: "/", // GitHub pages deployment config. // If you aren't using GitHub pages, you don't need these. - organizationName: 'restatedev', // Usually your GitHub org/user name. - projectName: 'documentation', // Usually your repo name. + organizationName: "restatedev", // Usually your GitHub org/user name. + projectName: "documentation", // Usually your repo name. - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", // Even if you don't use internalization, you can use this field to set useful // metadata like html lang. For example, if your site is Chinese, you may want // to replace "en" with "zh-Hans". i18n: { - defaultLocale: 'en', - locales: ['en'], + defaultLocale: "en", + locales: ["en"], }, presets: [ [ - 'classic', + "classic", /** @type {import('@docusaurus/preset-classic').Options} */ ({ docs: { @@ -58,94 +58,94 @@ const config = { variableInjector, // replaces eg VAR::RESTATE_DIST_VERSION with config strings { replacements: variablesReplacements, - } - ] + }, + ], ], - routeBasePath: '/', // Set this value to '/'. - sidebarPath: require.resolve('./sidebars.js'), + routeBasePath: "/", // Set this value to '/'. + sidebarPath: require.resolve("./sidebars.js"), // Please change this to your repo. // Remove this to remove the "edit this page" links. }, blog: false, theme: { - customCss: require.resolve('./src/css/custom.css'), + customCss: require.resolve("./src/css/custom.css"), }, }), ], - redocusaurus + redocusaurus, ], themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ // Replace with your project's social card - image: 'img/docusaurus-social-card.jpg', + image: "img/docusaurus-social-card.jpg", navbar: { - title: '', + title: "", logo: { - alt: 'Restate Logo', - src: 'img/restate.png', - href: 'https://restate.dev', - target: '_self' + alt: "Restate Logo", + src: "img/restate.png", + href: "https://restate.dev", + target: "_self", }, items: [ { - href: 'https://discord.gg/skW3AZ6uGd', - html: "", - position: 'right', + href: "https://discord.gg/skW3AZ6uGd", + html: '', + position: "right", }, { - href: 'https://restate.discourse.group/', - html: "", - position: 'right', + href: "https://restate.discourse.group/", + html: '', + position: "right", }, { - href: 'https://twitter.com/restatedev', - html: "", - position: 'right', + href: "https://twitter.com/restatedev", + html: '', + position: "right", }, { - href: 'https://github.com/restatedev', - html: "", - position: 'right', + href: "https://github.com/restatedev", + html: '', + position: "right", }, ], }, footer: { - style: 'dark', + style: "dark", links: [ { - title: 'Restate', + title: "Restate", items: [ { - href: 'https://restate.dev', - label: 'Home', + href: "https://restate.dev", + label: "Home", }, ], }, { - title: 'Community', + title: "Community", items: [ { - label: 'Discord', - href: 'https://discord.gg/skW3AZ6uGd', + label: "Discord", + href: "https://discord.gg/skW3AZ6uGd", }, { - label: 'Discourse', - href: 'https://restate.discourse.group/', + label: "Discourse", + href: "https://restate.discourse.group/", }, { - label: 'Twitter', - href: 'https://twitter.com/restatedev', + label: "Twitter", + href: "https://twitter.com/restatedev", }, ], }, { - title: 'More', + title: "More", items: [ { - label: 'GitHub', - href: 'https://github.com/restatedev/restate-dist', + label: "GitHub", + href: "https://github.com/restatedev", }, ], }, @@ -155,28 +155,28 @@ const config = { prism: { theme: lightCodeTheme, darkTheme: darkCodeTheme, - additionalLanguages: ['protobuf', 'log'], + additionalLanguages: ["protobuf", "log"], magicComments: [ // Remember to extend the default highlight class name as well! { - className: 'theme-code-block-highlighted-line', - line: 'highlight-next-line', - block: { start: 'highlight-start', end: 'highlight-end' }, + className: "theme-code-block-highlighted-line", + line: "highlight-next-line", + block: { start: "highlight-start", end: "highlight-end" }, }, { - className: 'bad-code-block', - line: 'bad-code', - block: { start: 'bad-code-start', end: 'bad-code-end' }, + className: "bad-code-block", + line: "bad-code", + block: { start: "bad-code-start", end: "bad-code-end" }, }, { - className: 'good-code-block', - line: 'good-code', - block: { start: 'good-code-start', end: 'good-code-end' }, + className: "good-code-block", + line: "good-code", + block: { start: "good-code-start", end: "good-code-end" }, }, ], }, colorMode: { - defaultMode: 'light', + defaultMode: "light", disableSwitch: true, respectPrefersColorScheme: false, }, @@ -188,8 +188,8 @@ const config = { { indexBlog: false, }, - ] - ] + ], + ], }; module.exports = config;