-
Notifications
You must be signed in to change notification settings - Fork 130
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
Add auth docker compose example #2923
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 |
... | ||
``` | ||
|
||
This setup defines the users `admin-user`, `viewer-user` and `other-user` which serve as [authentication](../configuration/authentication.md) credentials for connecting to your Weaviate instance. The user `admin-user` has been granted admin access rights while the `viewer-user` was granted read-only access using the **Role-based access control (RBAC)** method. A custom role can be assigned to the user `other-user` by following the [authorization and RBAC guide](../configuration/authorization.md). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wdyt about:
This setup enables API-key based [authentication](../configuration/authentication.md) and role-based access control [authorization](../configuration/authorization.md).
It defines the users `admin-user`, `viewer-user` and `other-user` and corresponding keys `admin-key`, `viewer-key` and `other-key` which serve as authentication credentials for connecting to your Weaviate instance.
The user `admin-user` is granted admin access rights while the `viewer-user` is granted read-only access using the **Role-based access control (RBAC)** method. A custom role can be assigned to the user `other-user` by following the [authorization and RBAC guide](../configuration/authorization.md).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lgtm! @g-despot
Separately, I made a change to the docs here (https://github.com/weaviate/weaviate-io/pull/2929/files) based on our Munich chat. Updated "admin-user" to "user-a" to remove any impilcation that the name might inherently confer rights.
Before you merge would you be able to change those names & keys? Ty!
What's being changed:
Type of change:
How Has This Been Tested?
yarn start