[v1.38] Release v1.38 documentation to main#438
Open
g-despot wants to merge 26 commits into
Open
Conversation
Async replication now runs automatically for any collection with a replication factor > 1; the per-collection asyncEnabled flag is removed. Update the async-rep, replication, env-var, runtime-config, collections config, multi-node-setup, horizontal-scaling and consistency pages, and the related includes. Replace the removed CLUSTER_MAX_WORKERS / ALIVE_NODES_CHECKING_FREQUENCY env vars with SCHEDULER_WORKERS / HASHTREE_INIT_CONCURRENCY, keeping the removed entries with notes. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove asyncEnabled/async_enabled arguments and assertions, and the removed per-collection maxWorkers option, from the Python, TypeScript, Java and Go replication snippets. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Remove async_replication_goroutines_running (replaced by the scheduler) and add the new scheduler gauges and diff/deletion/reconcile counters introduced in v1.38. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The RAFT_ENABLE_FQDN_RESOLVER / RAFT_FQDN_RESOLVER_TLD resolver was removed in v1.30. Replace the cluster-architecture section with a brief removal note and drop the obsolete FQDN (and pre-v1.18.1) content from the cluster concepts page. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Add a WAN section to the Multi-DC page covering CLUSTER_ADVERTISE_ADDR (DefaultWANConfig) and related networking env vars, clearly separated from the unimplemented topology-aware Multi-DC replication feature. Also refresh the stale v1.17/v1.18 not-supported wording. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Track docs entries that describe removed features/env vars and are kept with a removal note, so they can be deleted in a later release. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
[v1.38] Document Boost API
[v1.38] Document MCP runtime config + Prometheus metrics
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
[v1.38] Document nested object property filters
- Async replication config precedence (Jero): the cluster-wide environment variables override per-collection asyncConfig settings, not the other way around. Fixed the statement in both includes (async-replication-per-collection-config.mdx and feature-notes/async-config-collection.mdx), which had it reversed and contradicted each other. - Multi-DC (Mooga): running a single Weaviate cluster across data centers has been supported since v1.31 (weaviate#9521), so the "not currently supported" claim was wrong. Reworded to state cross-DC clustering is supported and that only topology-aware replica placement (issue #2436) remains on the roadmap. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
[v1.38] Async replication on by default
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
Contributor
There was a problem hiding this comment.
Pull request overview
Merges the accumulated v1.38 documentation set into main, updating the docs site to reflect v1.38 feature behavior and references (notably async replication defaults, nested filtering, MCP runtime config/metrics, and the new Boost API), plus associated config/version bumps used by the docs build and local test stacks.
Changes:
- Document Boost (new page + cross-links) and add
QUERY_BOOST_DEFAULT_DEPTHto env-var reference. - Document nested object filtering (preview) across search + GraphQL filter docs, with a new Python snippet.
- Update async replication docs for v1.38 (on-by-default behavior, centralized scheduler env vars/metrics, removed settings) and add MCP runtime-config + monitoring documentation; refresh Multi-DC/WAN cluster concepts.
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| versions-config.json | Bumps documented Weaviate version used for local builds to v1.38.0. |
| tests/docker-compose.yml | Updates test Weaviate image tag to v1.38.0-rc.0. |
| tests/docker-compose-three-nodes.yml | Updates 3-node test Weaviate image tags to v1.38.0-rc.0. |
| tests/docker-compose-rbac.yml | Updates RBAC test Weaviate image tag to v1.38.0-rc.0. |
| tests/docker-compose-anon.yml | Updates anon test Weaviate image tag to v1.38.0-rc.0. |
| tests/docker-compose-anon-offload.yml | Updates anon-offload test Weaviate image tag to v1.38.0-rc.0. |
| tests/docker-compose-anon-clip.yml | Updates anon-clip test Weaviate image tag to v1.38.0-rc.0. |
| tests/docker-compose-anon-bind.yml | Updates anon-bind test Weaviate image tag to v1.38.0-rc.0. |
| tests/docker-compose-anon-2.yml | Updates anon-2 test Weaviate image tag to v1.38.0-rc.0. |
| sidebars.js | Adds the new Boost doc page to the Search sidebar. |
| REMOVED_CONTENT_CLEANUP.md | Adds a tracking file for “removed in vX.Y” doc entries targeted for later deletion. |
| docusaurus.config.js | Pins the REST API reference OpenAPI spec URL to the v1-38 branch. |
| docs/weaviate/search/similarity.md | Adds a Boost cross-link section with preview callout. |
| docs/weaviate/search/rerank.md | Adds a Boost cross-link section with preview callout. |
| docs/weaviate/search/hybrid.md | Adds Boost explanation specific to hybrid result fusion + preview callout. |
| docs/weaviate/search/filters.md | Renames “Nested filters” section and adds nested object filtering (preview) documentation + examples include. |
| docs/weaviate/search/boost.md | New Boost documentation page (concepts + Python examples). |
| docs/weaviate/search/bm25.md | Adds a Boost cross-link section with preview callout. |
| docs/weaviate/manage-collections/multi-node-setup.mdx | Removes deprecated asyncEnabled and per-collection worker settings from examples. |
| docs/weaviate/manage-collections/collection-operations.mdx | Adds a cross-link from nested object schema docs to nested filtering docs. |
| docs/weaviate/configuration/mcp-server.mdx | Adds runtime-configurable column, toggle behavior references, and MCP monitoring section. |
| docs/weaviate/config-refs/datatypes.md | Updates object datatype note to reflect v1.38 nested filtering (preview) on leaf scalars. |
| docs/weaviate/config-refs/collections.mdx | Removes asyncEnabled, adds “async by default” note, and removes per-collection worker config rows. |
| docs/weaviate/concepts/replication-architecture/multi-dc.md | Reframes Multi-DC page to document WAN/cross-DC single-cluster operation (since v1.31). |
| docs/weaviate/concepts/replication-architecture/consistency.md | Updates async replication docs for v1.38 behavior and scheduler worker pool sizing mention. |
| docs/weaviate/concepts/replication-architecture/cluster-architecture.md | Removes outdated FQDN node discovery content. |
| docs/weaviate/concepts/cluster.md | Removes outdated/removed FQDN node discovery section and other legacy details blocks. |
| docs/weaviate/api/graphql/filters.md | Updates operand/nesting link and documents nested object leaf filtering (preview) in GraphQL. |
| docs/deploy/configuration/replication.md | Updates “async by default” behavior and replaces removed env vars with scheduler-based ones + removal note. |
| docs/deploy/configuration/monitoring.md | Updates async replication metrics list for v1.38 scheduler and adds MCP server metrics catalogue. |
| docs/deploy/configuration/horizontal-scaling.mdx | Removes deprecated asyncEnabled from replication examples. |
| docs/deploy/configuration/env-vars/runtime-config.md | Adds v1.38 async scheduler override mappings, keeps removed entries noted, and adds MCP runtime overrides. |
| docs/deploy/configuration/env-vars/index.md | Updates async replication + MCP env-var entries, removes FQDN vars, and adds QUERY_BOOST_DEFAULT_DEPTH. |
| docs/deploy/configuration/async-rep.md | Updates async replication deep-dive for v1.38 scheduler env vars and documents removed vars. |
| _includes/feature-notes/boost.mdx | Adds a shared “Boost preview” admonition include. |
| _includes/feature-notes/async-config-collection.mdx | Updates note about precedence between asyncConfig and env vars. |
| _includes/collection-mutable-parameters.mdx | Removes asyncEnabled from mutable parameter list. |
| _includes/code/java-v6/src/test/java/ManageCollectionsTest.java | Updates Java snippets to remove deprecated async replication flags and updates assertions. |
| _includes/code/howto/search.filters.nested.py | Adds Python snippet demonstrating nested object filtering patterns (preview). |
| _includes/code/howto/search.boost.py | Adds Python snippet demonstrating Boost usage patterns. |
| _includes/code/howto/manage-data.collections.ts | Updates TypeScript snippets to remove deprecated async replication fields. |
| _includes/code/howto/manage-data.collections.py | Updates Python snippets to remove deprecated async replication fields. |
| _includes/code/howto/go/docs/manage-data.classes_test.go | Updates Go snippet to remove deprecated async replication flag. |
| _includes/code/configuration/replication-consistency.mdx | Updates replication snippet to drop asyncEnabled. |
| _includes/code/config-refs/reference.collections.py | Updates reference Python snippet to drop async_enabled usage and assertions. |
| _includes/async-replication-per-collection-config.mdx | Updates include to reflect v1.38 async replication behavior and precedence statement. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Merges the accumulated v1.38 documentation from
v1-38/mainintomain. 25 commits, 46 files (+1038 / −172), bringing together the feature PRs that landed on the release branch.Highlights
asyncConfignow only fine-tunes an already-running process. Removed theasyncEnabledfield; documented the centralized scheduler env vars (ASYNC_REPLICATION_SCHEDULER_WORKERSetc.) and updated the async-replication monitoring metrics. Corrected the env-var ↔ per-collection override precedence.WEAVIATE_PREVIEW_NESTED_FILTERING=on); dotted-pathwhere/Filtersyntax overobject/object[]leaves, with search + GraphQL filter docs.filtersAPI doc updates, testdocker-composeupdates, and aversions-config.jsonbump to1.38.0.Notes
v1-38/async-by-default) is already merged into this branch.main-vs-release content that should be reconciled before merge.🤖 Generated with Claude Code