Skip to content
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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

g-despot
Copy link
Contributor

@g-despot g-despot commented Jan 15, 2025

What's being changed:

Type of change:

  • Documentation updates (non-breaking change to fix/update documentation)

How Has This Been Tested?

  • GitHub action – automated build completed without errors
  • Local build - the site works as expected when running yarn start

note, you can run yarn verify-links to test site links locally

Copy link

@orca-security-eu orca-security-eu bot left a 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 Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

@g-despot g-despot added the documentation Improvements or additions to documentation label Jan 15, 2025
@g-despot g-despot self-assigned this Jan 15, 2025
@g-despot g-despot requested a review from databyjp January 15, 2025 14:43
...
```

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).
Copy link
Contributor

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).

@g-despot g-despot marked this pull request as ready for review January 20, 2025 07:34
Copy link
Contributor

@databyjp databyjp left a 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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants