Skip to content

Commit

Permalink
Clarify wording for authentication/authorization (#639)
Browse files Browse the repository at this point in the history
  • Loading branch information
josh-wong authored Oct 10, 2024
1 parent ef01918 commit 01dc2b5
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion docs/releases/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ This release includes a lot of enhancements, improvements, bug fixes, and vulner

##### ScalarDB Cluster

- Added error codes to the error messages of the Auth module.
- Added error codes to the error messages of the authentication and authorization module.
- Added error codes to the error messages.
- Added TLS support for the Prometheus exporter. With this change, when enabling TLS (setting `scalar.db.cluster.tls.enabled` to `true`) in ScalarDB cluster nodes, the Prometheus exporter also starts with TLS (HTTPS).
- Update base image of container image. This update fixes an OOM issue on a Kubernetes with cgroup v2 environment. In the previous versions, if you use a Kubernetes cluster with cgroup v2, you might face an OOM-killed issue.
Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-3.11/releases/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ This release has several bug and vulnerability fixes.

### Summary

This release has a lot of enhancements, improvements, and bug fixes. There are many SQL enhancements including `JOIN` support and cross-partition scan support. This release also includes ScalarDB Auth, which is an authentication and authorization mechanism for ScalarDB Cluster. Please see the following for a list of detailed changes.
This release has a lot of enhancements, improvements, and bug fixes. There are many SQL enhancements including `JOIN` support and cross-partition scan support. This release also includes an authentication and authorization mechanism for ScalarDB Cluster. Please see the following for a list of detailed changes.

ScalarDB provides a Community edition and an Enterprise edition. The Community edition is available as open-source software that you can use under the Apache 2.0 License. The Enterprise edition includes not only the features of the Community edition but also many advanced features. Release notes for the Enterprise edition are available under the “Enterprise edition” section. To use the features in the Enterprise edition, you must have a license agreement with Scalar Inc.

Expand Down Expand Up @@ -150,7 +150,7 @@ ScalarDB provides a Community edition and an Enterprise edition. The Community e
- Added import functionalities for existing relational databases.
- Added support for operating a ScalarDB Cluster node in standalone mode to make development and testing more convenient. You can activate standalone mode by setting `scalar.db.cluster.node.standalone_mode.enabled` to `true`.
- Added the `docker-compose.yaml` file to test standalone mode. You can run ScalarDB Cluster for testing purposes in your local environment by using the `docker compose up` command.
- Introduced ScalarDB Auth, an authentication and authorization mechanism for ScalarDB Cluster.
- Introduced an authentication and authorization mechanism for ScalarDB Cluster.

##### ScalarDB SQL

Expand Down
6 changes: 3 additions & 3 deletions versioned_docs/version-3.12/releases/release-notes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ This release includes several improvements, including error message improvements

##### ScalarDB Cluster

- Added error codes to the error messages of the Auth module.
- Added error codes to the error messages of the authentication and authorization module.
- Added error codes to the error messages.
- Added TLS support for the Prometheus exporter. With this change, when enabling TLS (setting `scalar.db.cluster.tls.enabled` to `true`) in ScalarDB cluster nodes, the Prometheus exporter also starts with TLS (HTTPS).

Expand Down Expand Up @@ -164,8 +164,8 @@ This release has several enhancements, improvements, and bug fixes.

##### ScalarDB Cluster

- Added support for wire encryption using TLS. When you enable ScalarDB Auth, you should enable wire encryption in production environments to protect the user credentials.
- Added an expiration time for the auth token to the response of the `AuthLogin.Login` endpoint.
- Added support for wire encryption using TLS. When you enable authentication and authorization, you should enable wire encryption in production environments to protect the user credentials.
- Added an expiration time for the authentication and authorization token to the response of the `AuthLogin.Login` endpoint.

#### Improvements

Expand Down

0 comments on commit 01dc2b5

Please sign in to comment.