You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@iotdb.apache.org by qi...@apache.org on 2022/12/01 04:04:30 UTC
[iotdb] branch rel/1.0 updated: [To rel/1.0] [IOTDB-4414] Modify openId related documents and configuration files (#8270)
This is an automated email from the ASF dual-hosted git repository.
qiaojialin pushed a commit to branch rel/1.0
in repository https://gitbox.apache.org/repos/asf/iotdb.git
The following commit(s) were added to refs/heads/rel/1.0 by this push:
new c621ca87ed [To rel/1.0] [IOTDB-4414] Modify openId related documents and configuration files (#8270)
c621ca87ed is described below
commit c621ca87ed6072659c1fae46a3f4a24d8be498a2
Author: CloudWise-Lukemiao <76...@users.noreply.github.com>
AuthorDate: Thu Dec 1 12:04:25 2022 +0800
[To rel/1.0] [IOTDB-4414] Modify openId related documents and configuration files (#8270)
---
docs/UserGuide/QuickStart/Command-Line-Interface.md | 7 ++++---
docs/UserGuide/Reference/Common-Config-Manual.md | 4 ++--
docs/zh/UserGuide/QuickStart/Command-Line-Interface.md | 4 ++--
docs/zh/UserGuide/Reference/Common-Config-Manual.md | 4 ++--
node-commons/src/assembly/resources/conf/iotdb-common.properties | 2 +-
5 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/docs/UserGuide/QuickStart/Command-Line-Interface.md b/docs/UserGuide/QuickStart/Command-Line-Interface.md
index 7737903554..996958c75b 100644
--- a/docs/UserGuide/QuickStart/Command-Line-Interface.md
+++ b/docs/UserGuide/QuickStart/Command-Line-Interface.md
@@ -124,11 +124,12 @@ Special commands of Cli are below.
Openid connect (oidc) uses keycloack as the authority authentication service of oidc service
-#### Configuration
-The configuration is located in iotdb-datanode.properties(iotdb-confignode.properties) , set the author_provider_class is org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer Openid service is enabled, and the default value is org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer Indicates that the openid service is not enabled.
+
+#### configuration
+The configuration is located in iotdb-datanode.properties(iotdb-confignode.properties) , set the author_provider_class is org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer Openid service is enabled, and the default value is org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer Indicates that the openid service is not enabled.
```
-authorizer_provider_class=org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer
+authorizer_provider_class=org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer
```
If the openid service is turned on, openid_URL is required,openID_url value is http://ip:port/auth/realms/{realmsName}
diff --git a/docs/UserGuide/Reference/Common-Config-Manual.md b/docs/UserGuide/Reference/Common-Config-Manual.md
index 504824ccdc..72d59afcf4 100644
--- a/docs/UserGuide/Reference/Common-Config-Manual.md
+++ b/docs/UserGuide/Reference/Common-Config-Manual.md
@@ -1237,9 +1237,9 @@ Different configuration parameters take effect in the following three ways:
| :--------------------: | :------------------------------------------------------ |
| Description | the class name of the authorization service |
| Type | String |
-| Default | org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer |
+| Default | org.apache.iotdb.commons.auth.authorizer.LocalFileAuthorizer |
| Effective | After restarting system |
-| Other available values | org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer |
+| Other available values | org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer |
* openID\_url
diff --git a/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md b/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
index fbc7704d40..07c386ff15 100644
--- a/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
+++ b/docs/zh/UserGuide/QuickStart/Command-Line-Interface.md
@@ -112,10 +112,10 @@ Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO
OpenID Connect (OIDC) 使用 keycloack 作为 OIDC 服务权限认证服务。
#### 配置
-配置位于 iotdb-datanode.properties(iotdb-confignode.properties)，设定 authorizer_provider_class 为 org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer 则开启了 openID 服务，默认情况下值为 org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer 表示没有开启 openID 服务。
+配置位于 iotdb-datanode.properties(iotdb-confignode.properties)，设定 authorizer_provider_class 为 org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer 则开启了 openID 服务，默认情况下值为 org.apache.iotdb.commons.auth.authorizer.LocalFileAuthorizer 表示没有开启 openID 服务。
```
-authorizer_provider_class=org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer
+authorizer_provider_class=org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer
```
如果开启了 openID 服务则 openID_url 为必填项，openID_url 值为 http://ip:port/auth/realms/{realmsName}
diff --git a/docs/zh/UserGuide/Reference/Common-Config-Manual.md b/docs/zh/UserGuide/Reference/Common-Config-Manual.md
index 3fa5556310..a78270d460 100644
--- a/docs/zh/UserGuide/Reference/Common-Config-Manual.md
+++ b/docs/zh/UserGuide/Reference/Common-Config-Manual.md
@@ -1291,9 +1291,9 @@ IoTDB ConfigNode 和 DataNode 的公共配置参数位于 `conf` 目录下。
| :----------: | :------------------------------------------------------ |
| 描述 | 权限服务的类名 |
| 类型 | String |
-| 默认值 | org.apache.iotdb.db.auth.authorizer.LocalFileAuthorizer |
+| 默认值 | org.apache.iotdb.commons.auth.authorizer.LocalFileAuthorizer |
| 改后生效方式 | 重启服务生效 |
-| 其他可选值 | org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer |
+| 其他可选值 | org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer |
* openID\_url
diff --git a/node-commons/src/assembly/resources/conf/iotdb-common.properties b/node-commons/src/assembly/resources/conf/iotdb-common.properties
index 930ab46ba2..e29b1252b2 100644
--- a/node-commons/src/assembly/resources/conf/iotdb-common.properties
+++ b/node-commons/src/assembly/resources/conf/iotdb-common.properties
@@ -783,7 +783,7 @@
####################
# which class to serve for authorization. By default, it is LocalFileAuthorizer.
-# Another choice is org.apache.iotdb.db.auth.authorizer.OpenIdAuthorizer
+# Another choice is org.apache.iotdb.commons.auth.authorizer.OpenIdAuthorizer
# authorizer_provider_class=org.apache.iotdb.commons.auth.authorizer.LocalFileAuthorizer
# If OpenIdAuthorizer is enabled, then openID_url must be set.