Add new documentation to enable Pulsar PubSub message compression#5028
Add new documentation to enable Pulsar PubSub message compression#5028jslatten wants to merge 1 commit intodapr:v1.17from
Conversation
There was a problem hiding this comment.
Pull request overview
This PR promotes the v1.16 docs to “latest”, inlines SDK documentation (instead of submodules), and adds/updates content for new features like AI/agents, Jobs, Workflow, cryptography, distributed lock, Redis Sentinel, AWS Secrets enhancements, and Pulsar compression.
Changes:
- Remove SDK git submodules and move SDK docs (Go, Java, JS, .NET, PHP, Rust, pluggable components) into this repo, updating navigation, cascading GitHub metadata, and contributing guides.
- Update site configuration for v1.16 as the primary docs (version switcher, Algolia/DocSearch, latest-version shortcode), and clean out legacy scripts and custom Algolia indexer.
- Extend and refine reference docs: new/updated API references (Workflow, Jobs, Crypto, Conversation), component specs (Redis Sentinel, AWS Secrets, DynamoDB/Cosmos workflow limits, Pulsar compression), AI/agents content (Dapr Agents and agent integrations), and multiple .NET/Java/Go/JS SDK guides.
Reviewed changes
Copilot reviewed 188 out of 239 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| sdkdocs/php/content/en/php-sdk-docs/php-app/_index.md | New PHP App class guide with routing, response handling, and client usage. |
| sdkdocs/php/content/en/php-sdk-docs/php-actors/_index.md | New PHP virtual actors documentation including proxy, state, lifecycle, and registration. |
| sdkdocs/php/content/en/php-sdk-docs/_index.md | New PHP SDK landing page, setup, and hello-world sample. |
| sdkdocs/php | Remove PHP SDK submodule pointer in favor of inlined docs. |
| sdkdocs/js/content/en/js-sdk-docs/js-logger/_index.md | New JS SDK logging configuration and custom logger (Winston) guide. |
| sdkdocs/js/content/en/js-sdk-docs/js-examples/_index.md | New JS examples index linking to quickstarts and community articles. |
| sdkdocs/js/content/en/js-sdk-docs/_index.md | New JS SDK landing page with structure, cards, and links to client/server/actors/logging/examples. |
| sdkdocs/js/content/en/js-sdk-contributing/js-contributing.md | New contribution guide for JS SDK (commit conventions, coding rules, docs, examples). |
| sdkdocs/js/README.md | Explain how JS SDK docs integrate into main Dapr docs. |
| sdkdocs/js | Remove JS SDK submodule pointer. |
| sdkdocs/java/content/en/java-sdk-docs/spring-boot/sb-workflows-howto.md | New “How to” for Dapr Workflow with Spring Boot starter. |
| sdkdocs/java/content/en/java-sdk-docs/java-workflow/_index.md | New Java Workflow package index page. |
| sdkdocs/java/content/en/java-sdk-docs/java-jobs/_index.md | New Java Jobs package index page. |
| sdkdocs/java/content/en/java-sdk-docs/java-ai/java-ai-howto.md | New Java Conversation AI how-to using DaprPreviewClient. |
| sdkdocs/java/content/en/java-sdk-docs/java-ai/_index.md | New Java AI package index page. |
| sdkdocs/java/content/en/java-sdk-docs/_index.md | New Java SDK landing page, import instructions, and available package cards. |
| sdkdocs/java/content/en/java-sdk-contributing/java-contributing.md | New Java SDK contributing guide (examples/docs rules, Dapr bot). |
| sdkdocs/java | Remove Java SDK submodule pointer. |
| sdkdocs/go/content/en/go-sdk-docs/go-service/http-service.md | New Go HTTP service/callback SDK getting-started guide. |
| sdkdocs/go/content/en/go-sdk-docs/go-service/grpc-service.md | New Go gRPC service/callback SDK getting-started guide. |
| sdkdocs/go/content/en/go-sdk-docs/go-service/_index.md | New Go Service SDK index page linking HTTP/gRPC service docs. |
| sdkdocs/go/content/en/go-sdk-docs/_index.md | New Go SDK landing page with client/service cards and GitHub cascade. |
| sdkdocs/go/content/en/go-sdk-contributing/go-contributing.md | New Go SDK contributing guide. |
| sdkdocs/go/README.md | Explain how Go SDK docs integrate into Dapr docs. |
| sdkdocs/go | Remove Go SDK submodule pointer. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-workflow/dotnet-workflow-management-methods.md | New .NET DaprWorkflowClient management operations guide. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-workflow/dotnet-workflow-examples.md | New .NET workflow examples/index page. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-workflow/_index.md | New .NET Workflow SDK section index. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-troubleshooting/_index.md | New .NET troubleshooting index skeleton. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-messaging/_index.md | New .NET Messaging SDK index for streaming PubSub. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-jobs/_index.md | New .NET Jobs SDK index. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-integrations/dotnet-development-docker-compose.md | New .NET local dev guidance with docker-compose. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-integrations/dotnet-development-dapr-cli.md | New .NET local dev guidance with Dapr CLI. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-integrations/_index.md | New .NET deployment integrations overview. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-guidance/dotnet-guidance-source-generators.md | New Roslyn analyzers/generators guidance for .NET SDKs. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-guidance/dotnet-guidance-experimental-attributes.md | New guidance on .NET [Experimental] attributes in Dapr SDK. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-guidance/dotnet-guidance-error-model.md | New guidance on rich error model in .NET SDK. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-guidance/_index.md | New .NET best-practices overview. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-distributed-lock/dotnet-distributedlock-howto.md | New .NET distributed lock how-to. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-cryptography/dotnet-cryptography-howto.md | New .NET cryptography how-to. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-cryptography/_index.md | New .NET cryptography SDK index. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-ai/dotnet-ai-conversation-howto.md | New .NET Conversational AI how-to. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-ai/_index.md | New .NET AI SDK index. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-actors/dotnet-actors-client.md | New .NET actors client (IActorProxyFactory) guide. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/dotnet-actors/_index.md | New .NET actors SDK index. |
| sdkdocs/dotnet/content/en/dotnet-sdk-docs/_index.md | New consolidated .NET SDK landing page with all packages and cards. |
| sdkdocs/dotnet/README.md | Explain how .NET SDK docs integrate into Dapr docs. |
| sdkdocs/dotnet | Remove .NET SDK submodule pointer. |
| hugo.yaml | Switch baseURL to main docs, set v1.16 as latest, add v1.17 preview, adjust DocSearch (Algolia) config, and rewrite module mounts to new inlined SDK docs. |
| daprdocs/layouts/_shortcodes/dapr-latest-version.html | Update latest Dapr version shortcode to 1.16.x/CLI to 1.16.5. |
| daprdocs/layouts/_partials/hooks/head-end.html | Remove third-party Kapa AI widget script from head. |
| daprdocs/layouts/_partials/hooks/body-end.html | Use DocSearch params from config instead of hardcoded Algolia creds; remove Reo widget script. |
| daprdocs/data/components/state_stores/oracle.yaml | Mark Oracle state store as workflow-capable. |
| daprdocs/data/components/state_stores/generic.yaml | Mark multiple generic DB state stores as workflow-capable. |
| daprdocs/data/components/state_stores/azure.yaml | Mark Azure Cosmos DB as workflow-capable. |
| daprdocs/data/components/secret_stores/aws.yaml | Add AWS Secrets Manager feature flag for multiple key/values per secret. |
| daprdocs/content/en/reference/resource-specs/subscription-schema.md | Document new metadata field on subscription specs (v2alpha1 & v1alpha1). |
| daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md | Expand Redis state store docs, including improved redisHost/failover descriptions and a (new) Sentinel config example. |
| daprdocs/content/en/reference/components-reference/supported-state-stores/setup-dynamodb.md | Add ttlInSeconds metadata and workflow limitations for DynamoDB. |
| daprdocs/content/en/reference/components-reference/supported-state-stores/setup-azure-cosmosdb.md | Document workflow limitations for Cosmos DB state store. |
| daprdocs/content/en/reference/components-reference/supported-state-stores/_index.md | Adjust menu weight for state store component specs. |
| daprdocs/content/en/reference/components-reference/supported-secret-stores/aws-secret-manager.md | Clarify AWS Secrets Manager description and document multipleKeyValuesPerSecret behavior. |
| daprdocs/content/en/reference/components-reference/supported-secret-stores/_index.md | Adjust menu weight for secret store component specs. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-redis-pubsub.md | Enhance Redis pubsub docs including Sentinel usage and redisHost/failover clarifications. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-rabbitmq.md | Fix Markdown table formatting and “Mutally” → “Mutually” typo. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-pulsar.md | Add Pulsar message compression metadata docs and example. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-azure-eventhubs.md | Fix “Mutally” → “Mutually” in spec table. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/setup-apache-kafka.md | Clarify disableTls description. |
| daprdocs/content/en/reference/components-reference/supported-pubsub/_index.md | Adjust menu weight for pub/sub component specs. |
| daprdocs/content/en/reference/components-reference/supported-name-resolution/_index.md | Adjust menu weight for name resolution component specs. |
| daprdocs/content/en/reference/components-reference/supported-middleware/_index.md | Adjust menu weight for middleware component specs. |
| daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md | Improve Redis lock metadata docs for redisHost/failover and Sentinel. |
| daprdocs/content/en/reference/components-reference/supported-locks/_index.md | Adjust menu weight for lock component specs. |
| daprdocs/content/en/reference/components-reference/supported-cryptography/local-storage.md | Minor YAML ordering fix in local-storage crypto component example. |
| daprdocs/content/en/reference/components-reference/supported-cryptography/_index.md | Adjust menu weight for cryptography component specs. |
| daprdocs/content/en/reference/components-reference/supported-conversation/openai.md | Add Azure OpenAI-specific configuration docs and example. |
| daprdocs/content/en/reference/components-reference/supported-conversation/_index.md | Adjust menu weight for conversation component specs. |
| daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md | Enhance Redis configuration store docs and add Sentinel configuration example. |
| daprdocs/content/en/reference/components-reference/supported-configuration-stores/azure-appconfig-configuration-store.md | Fix “Mutally” → “Mutually” in spec table. |
| daprdocs/content/en/reference/components-reference/supported-configuration-stores/_index.md | Adjust menu weight for config store component specs. |
| daprdocs/content/en/reference/components-reference/supported-bindings/redis.md | Improve Redis binding docs and add Sentinel configuration example. |
| daprdocs/content/en/reference/components-reference/supported-bindings/eventhubs.md | Fix “Mutally” → “Mutually” and table formatting. |
| daprdocs/content/en/reference/components-reference/supported-bindings/_index.md | Adjust menu weight for bindings component specs. |
| daprdocs/content/en/reference/api/workflow_api.md | Adjust Workflow API reference weight. |
| daprdocs/content/en/reference/api/state_api.md | Adjust State API reference weight. |
| daprdocs/content/en/reference/api/service_invocation_api.md | Adjust Service Invocation API reference weight. |
| daprdocs/content/en/reference/api/secrets_api.md | Adjust Secrets API reference weight. |
| daprdocs/content/en/reference/api/pubsub_api.md | Adjust PubSub API reference weight. |
| daprdocs/content/en/reference/api/placement_api.md | Adjust Placement API reference weight. |
| daprdocs/content/en/reference/api/metadata_api.md | Adjust Metadata API reference weight. |
| daprdocs/content/en/reference/api/jobs_api.md | Adjust Jobs API reference weight. |
| daprdocs/content/en/reference/api/health_api.md | Adjust Health API reference weight. |
| daprdocs/content/en/reference/api/distributed_lock_api.md | Normalize “Distributed lock API” casing and weight. |
| daprdocs/content/en/reference/api/cryptography_api.md | Adjust Cryptography API reference weight. |
| daprdocs/content/en/reference/api/configuration_api.md | Adjust Configuration API reference weight. |
| daprdocs/content/en/reference/api/bindings_api.md | Adjust Bindings API reference weight. |
| daprdocs/content/en/reference/api/actors_api.md | Adjust Actors API reference weight. |
| daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md | Add deprecation note for http-max-request-size → max-body-size. |
| daprdocs/content/en/operations/support/alpha-beta-apis.md | Update alpha APIs table with streaming subscriptions and conversation v1.0-alpha2. |
| daprdocs/content/en/operations/security/api-token.md | Reorganize and clarify API token configuration/rotation guidance. |
| daprdocs/content/en/operations/resiliency/health-checks/sidecar-health.md | Clarify sidecar outbound health checks and SDK wait methods. |
| daprdocs/content/en/operations/hosting/kubernetes/kubernetes-persisting-scheduler.md | Remove duplicated PVC warning block. |
| daprdocs/content/en/operations/configuration/secret-scope.md | Deduplicate and clean up secret-scope config examples. |
| daprdocs/content/en/operations/configuration/increase-request-size.md | Deprecate http-max-request-size in favor of max-body-size and unify HTTP/gRPC docs. |
| daprdocs/content/en/operations/configuration/configuration-overview.md | Document workflow concurrency config in Dapr configuration. |
| daprdocs/content/en/getting-started/quickstarts/jobs-quickstart.md | Extend Jobs quickstart with dapr scheduler list and post-run behavior. |
| daprdocs/content/en/getting-started/quickstarts/_index.md | Add Agents quickstart link. |
| daprdocs/content/en/getting-started/install-dapr-selfhost.md | Add note about Diagrid Dashboard for workflow development; minor cleanup. |
| daprdocs/content/en/developing-applications/sdks/_index.md | Add Dapr Agents framework row; update SDK summary. |
| daprdocs/content/en/developing-applications/error-codes/errors-overview.md | Fix “alphamueric” → “alphanumeric” and expand explanation. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-patterns.md | Add CLI snippet for fan-out/fan-in and refine concurrency guidance. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-overview.md | Add multi-application workflows, workflow mgmt CLI, and workflow state store limitations. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-features-concepts.md | Add workflow instance mgmt, CLI queries, refined retry semantics. |
| daprdocs/content/en/developing-applications/building-blocks/workflow/workflow-architecture.md | Document workflow state store record counts, direct DB access, and supported state stores. |
| daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-raw.md | Add Java examples for raw pub/sub; minor expansion. |
| daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-route-messages.md | Fix CEL documentation link. |
| daprdocs/content/en/developing-applications/building-blocks/jobs/jobs-features-concepts.md | Add CLI-based jobs management section. |
| daprdocs/content/en/developing-applications/building-blocks/conversation/conversation-overview.md | Expand Conversation API docs (prompt caching, PII, tool calling) and clarify features. |
| daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md | Fix JavaScript tab shortcode typo. |
| daprdocs/content/en/developing-applications/building-blocks/actors/namespaced-actors.md | Fix minor wording (“namepaces” → “namespaces”). |
| daprdocs/content/en/developing-applications/building-blocks/actors/actors-timers-reminders.md | Add CLI-based management for actor reminders. |
| daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-why.md | Refine Dapr Agents “why” page and fix links/aliases. |
| daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-quickstarts.md | Expand and correct Dapr Agents quickstarts table and links. |
| daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-patterns.md | Expand patterns with DurableAgent example and updated configs. |
| daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-introduction.md | Improve Dapr Agents intro, links, and aliases. |
| daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-integrations.md | Extend integrations page, including MCP Toolbox example. |
| daprdocs/content/en/developing-ai/dapr-agents/dapr-agents-getting-started.md | Update getting started with new components and memory config usage. |
| daprdocs/content/en/developing-ai/dapr-agents/_index.md | New Dapr Agents section root with alias. |
| daprdocs/content/en/developing-ai/agent-integrations/openai-agents/openai-agents-sessions.md | New page: OpenAI Agents sessions with Dapr-managed state. |
| daprdocs/content/en/developing-ai/agent-integrations/openai-agents/_index.md | New OpenAI Agents integration index. |
| daprdocs/content/en/developing-ai/agent-integrations/crewai/_index.md | New CrewAI integration index. |
| daprdocs/content/en/developing-ai/agent-integrations/_index.md | New “Agent Integrations” section root. |
| daprdocs/content/en/developing-ai/_index.md | New “Developing AI with Dapr” section root. |
| daprdocs/content/en/contributing/presentations.md | Update slide deck descriptions and mention Dapr Agents deck. |
| daprdocs/content/en/contributing/docs-contrib/maintainer-guide.md | Update versioning docs to match hugo.yaml (YAML) and refresh archival steps. |
| daprdocs/content/en/concepts/terminology.md | Add Dapr Actors, Dapr Agents, and Dapr Workflows terminology entries. |
| daprdocs/content/en/concepts/security-concept.md | Fix minor typo (“Daprs” → “Dapr's”) and clarify audit. |
| daprdocs/content/en/concepts/overview.md | Introduce Dapr Agents as a framework in the concepts overview. |
| daprdocs/content/en/concepts/building-blocks-concept.md | Update Conversation API path to v1.0-alpha2. |
| daprdocs/assets/scss/_content.scss | Add styling for images inside card titles. |
| README.md | Update maintained branch table for v1.16 primary and v1.17 preview, plus setup instructions. |
| .gitmodules | Remove SDK/pluggable-components submodules, keep only zh translation. |
| .github/workflows/website-root.yml | Point workflow at v1.16 branch, tweak Hugo build, and drop custom Algolia indexing job. |
| .github/scripts/algolia.py | Remove custom Algolia indexer (replaced by crawler-based DocSearch). |
Comments suppressed due to low confidence (6)
daprdocs/content/en/reference/components-reference/supported-state-stores/setup-redis.md:281
- This example lives in the Redis state store documentation but declares
type: pubsub.redisand names the componentredis-pubsub, which is inconsistent and would not create a state store if copy-pasted. For a state store Sentinel example, update thetypeto the appropriate Redis state component (for example,state.redis) and use a matchingmetadata.namesuch asstatestoreorredis-statestore.
value: |
daprdocs/content/en/reference/components-reference/supported-configuration-stores/redis-configuration-store.md:96
- In the Redis configuration store docs, the Sentinel example uses
type: pubsub.redisandname: redis-pubsub, which is incorrect for a configuration store and will not match the earlierconfiguration.redisexamples. Change thetypeto the Redis configuration store type (for example,configuration.redis) and align the component name with the rest of the page (for example,redisconfig), so readers can safely copy this snippet.
- **Linux/MacOS**: Run `kubectl get secret --namespace default redis -o jsonpath="{.data.redis-password}" | base64 --decode` and copy the outputted password.
daprdocs/content/en/reference/components-reference/supported-bindings/redis.md:1
- This Sentinel example appears under the Redis binding documentation, but the component is declared as
type: pubsub.rediswithname: redis-pubsub, which is inconsistent with the binding type shown earlier and will not configure a binding if copied. For accuracy, the example should use the Redis binding type (for example,bindings.redis) and a binding-appropriate component name (such asredis-binding).
---
daprdocs/content/en/reference/components-reference/supported-locks/redis-lock.md:1
- The
redisHosttable row has duplicated example content and an extra trailing 'host' token, which breaks the table layout and makes the examples hard to read. Clean this row up so there is a single example column, for example:localhost:6379,redis-master.default.svc.cluster.local:6379,sentinel1:26379,sentinel2:26379,sentinel3:26379.
---
README.md:1
- The v1.17 row in the branch table links to
tree/v1.16instead of av1.17branch, which is misleading and likely incorrect. Update the URL to point to the actual v1.17 branch (for example,https://github.com/dapr/docs/tree/v1.17).
# Dapr documentation
daprdocs/content/en/developing-applications/building-blocks/pubsub/pubsub-raw.md:1
- The second line uses
metatada.put(...)instead ofmetadata.put(...), which will not compile. The map variable is declared asmetadata, so both calls should use the same identifier.
---
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| $clientBuilder = $clientBuilder->useHttpClient('https://localhost:3800') | ||
| ``` | ||
|
|
||
| There are several functions you can call before |
There was a problem hiding this comment.
The last sentence 'There are several functions you can call before' is incomplete and ends abruptly, which can confuse readers. Either complete the sentence with the intended guidance (for example, describing which configuration methods can be chained before build()/usage) or remove it entirely.
| There are several functions you can call before | |
| There are several functions you can call on the client builder to customize serialization, logging, and the sidecar URL; refer to the `DaprClient` builder API documentation for the complete list of available configuration methods. |
| title: "JavaScript Examples" | ||
| linkTitle: "Examples" | ||
| weight: 5000 | ||
| description: Get started with the Dapr Javascript SDK through some of our examples! |
There was a problem hiding this comment.
The term 'Javascript' should be capitalized as 'JavaScript' to match the official language name and the rest of the docs.
| description: Get started with the Dapr Javascript SDK through some of our examples! | |
| description: Get started with the Dapr JavaScript SDK through some of our examples! |
| @@ -0,0 +1,74 @@ | |||
| --- | |||
| type: docs | |||
| title: "How to: Create an use Dapr Cryptography in the .NET SDK" | |||
There was a problem hiding this comment.
The phrase 'Create an use' is ungrammatical; it should read 'Create and use'. Updating the title improves clarity and professionalism.
| title: "How to: Create an use Dapr Cryptography in the .NET SDK" | |
| title: "How to: Create and use Dapr Cryptography in the .NET SDK" |
| | `lz4` | LZ4 compression - fast compression/decompression | | ||
| | `zlib` | ZLib compression - balanced compression ratio | | ||
| | `zstd` | ZSTD compression - high compression ratio | | ||
|
|
There was a problem hiding this comment.
There is an empty '####' heading with no title or content between the compression note and the 'E2E Encryption' section, which appears to be a stray header and may affect formatting. Remove the blank heading or replace it with a meaningful subheading if additional content is intended.
| #### Compression levels |
| --- | ||
|
|
||
| An error code is a numeric or alphamueric code that indicates the nature of an error and, when possible, why it occured. | ||
| An error code is a numeric or alphanumeric code that indicates the nature of an error and, when possible, why it occured. |
There was a problem hiding this comment.
The word 'occured' is misspelled; it should be 'occurred'.
| - The Dapr HTTP port is available; _but,_ | ||
| - The app channel is not yet established. | ||
|
|
||
| In the Dapr SDKs, the `waitForSidecar`/`wait_until_ready` method (depending on [which SDK you use]({{% ref "#sdks-supporting-outbound-health-endpoint" %}})) is used for this specific check with the `v1.0/healthz/outbound` endpoint. Using this behavior, instead of waiting for the app channel to be available (see: red boundary lines) with the `v1.0/healthz/` endpoint, Dapr waits for a successful response from `v1.0/healthz/outbound`. This approach enables your application to perform calls on the Dapr sidecar APIs before the app channel is initalized - for example, reading secrets with the secrets API. | ||
| In the Dapr SDKs, the `waitForSidecar` method (depending on [which SDK you use]({{% ref "#sdks-supporting-outbound-health-endpoint" %}})) is used for this specific check with the `v1.0/healthz/outbound` endpoint. Using this behavior, instead of waiting for the app channel to be available (see: red boundary lines) with the `v1.0/healthz/` endpoint, Dapr waits for a successful response from `v1.0/healthz/outbound`. This approach enables your application to perform calls on the Dapr sidecar APIs before the app channel is initalized - for example, reading secrets with the secrets API. | ||
|
|
||
| If you are using the `waitForSidecar`/`wait_until_ready` method on the SDKs, then the correct initialization is performed. Otherwise, you can call the `v1.0/healthz/outbound` endpoint during initalization, and if successesful, you can call the Dapr sidecar APIs. | ||
| If you are using the `waitForSidecar` method on the SDKs, then the correct initialization is performed. Otherwise, you can call the `v1.0/healthz/outbound` endpoint during initalization, and if successesful, you can call the Dapr sidecar APIs. |
There was a problem hiding this comment.
This section now only mentions a waitForSidecar method, but different SDKs expose different names (for example, .NET WaitForSidecarAsync, Python wait_until_ready, etc.), which was called out earlier. To avoid confusion, it would be better to retain or restore wording that acknowledges the per-SDK method names (for example, 'waitForSidecar/wait_until_ready or equivalent, depending on the SDK') while still pointing to the /v1.0/healthz/outbound endpoint.
Signed-off-by: Justin Slatten <justin.slatten@gmail.com>
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Added documentation for new Pulsar message pubsub compressiontype and compressionlevel
Issue reference
#4989