[v1.38] Document namespaces#429
Open
g-despot wants to merge 7 commits into
Open
Conversation
![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 |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| # where <node-name> is a current storage candidate from | ||
| # client.cluster.nodes(). | ||
| ns = client.namespaces.create(name="customer1") | ||
| print(ns.name, ns.home_node, ns.state) |
| if ns is None: | ||
| print("not found") | ||
| else: | ||
| print(ns.name, ns.home_node, ns.state) |
| # Bind the new DB user to a namespace. The user is stored internally as | ||
| # `customer1:api_user` and can only see resources in `customer1`. | ||
| api_key = client.users.db.create(user_id="api_user", namespace="customer1") | ||
| print(api_key) |
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Passed |
Infrastructure as Code | 0 1 1 3 |
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 |
🛡️ The following IaC misconfigurations have been detected
| NAME | FILE | ||
|---|---|---|---|
|
Controller creating containers without dropped capabilities | ...mpose-namespaces.yml | View in code |
|
Container Traffic Not Bound to Host Interface | ...mpose-namespaces.yml | View in code |
|
Container Healthcheck Not Defined | ...mpose-namespaces.yml | View in code |
|
Docker Compose Restart Policy On-Failure Not Set to 5 | ...mpose-namespaces.yml | View in code |
|
Ensure that, if applicable, SELinux security options are set (Automated) | ...mpose-namespaces.yml | View in code |
g-despot
changed the title
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
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
2 participants
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.
Summary
Documents the v1.38 Preview namespaces feature — cluster-level isolation where every collection and alias belongs to exactly one namespace. Namespaced principals see short names (
Movies); the cluster stores qualified names (customer1:Movies). One cluster can host many isolated logical "customer clusters".Companion to server PR weaviate/weaviate#11128 and Python client PR weaviate/weaviate-python-client#2033.
What's documented
Phase 1 (collections + aliases scoped per namespace, operator-managed DB users); Phase 2/3 flagged as designed-but-not-shipped. Two framings repeated throughout:
NAMESPACES_ENABLED=truecan't be retrofitted, and a cluster that has run with it can't be downgraded.Changes
New:
concepts/namespaces.md— concept page: prerequisites, principal model (DB user / static API key / OIDC), name resolution, limits, blocked surfaces, cross-feature interactions.configuration/namespaces.mdx— operator how-to: enable, REST CRUD, bootstrap a namespaced DB user. Python examples in<Tabs>._includes/namespaces-overview.mdx— shared overview + terminology (principal, operator, name resolution…), reused on both pages._includes/code/howto/namespaces.py— runnable Python snippet, wired intotests/test_python.py(skips until the #2033 client ships).tests/docker-compose-namespaces.yml— namespace-enabled test instance.Updated:
concepts/data.md,manage-collections/multi-tenancy.mdx+collection-aliases.mdx,configuration/rbac/index.mdx,deploy/configuration/oidc.md,env-vars/index.md(new rows:NAMESPACES_ENABLED,DISABLE_GRAPHQL,REPLICATION_MAXIMUM_FACTOR, OIDC claims), concepts + configuration index cards,sidebars.js.Status / test plan
yarn buildclean (cross-links/anchors resolve).1.38.0-rc.0with the #2033 client.namespace=; therc.0server expects it in the request body). Re-verify once #2033 reconciles with the release image, then unskip the test and pin the released client version.Other clients (TS/Java/C#/Go) have no typed namespace methods yet — use REST.