You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@dolphinscheduler.apache.org by ti...@apache.org on 2022/12/22 08:04:25 UTC
[dolphinscheduler] branch dev updated: [doc][datasource-12820] add azure sql database doc (#13254)
This is an automated email from the ASF dual-hosted git repository.
tianqiyan pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/dolphinscheduler.git
The following commit(s) were added to refs/heads/dev by this push:
new 06b77b34c7 [doc][datasource-12820] add azure sql database doc (#13254)
06b77b34c7 is described below
commit 06b77b34c7d9dcce9dff799f0a61bd2886761787
Author: Tq <ti...@gmail.com>
AuthorDate: Thu Dec 22 16:04:19 2022 +0800
[doc][datasource-12820] add azure sql database doc (#13254)
---
docs/configs/docsdev.js | 8 +++
docs/docs/en/guide/datasource/azure-sql.md | 77 +++++++++++++++++++++
docs/docs/zh/guide/datasource/azure-sql.md | 61 ++++++++++++++++
docs/img/new_ui/dev/datasource/azuresql-ad.png | Bin 0 -> 19735 bytes
docs/img/new_ui/dev/datasource/azuresql-ad2.png | Bin 0 -> 36172 bytes
.../new_ui/dev/datasource/azuresql-endpoints.png | Bin 0 -> 51088 bytes
.../new_ui/dev/datasource/azuresql-msi-admin1.png | Bin 0 -> 29725 bytes
.../new_ui/dev/datasource/azuresql-msi-admin2.png | Bin 0 -> 17450 bytes
docs/img/new_ui/dev/datasource/azuresql-msi.png | Bin 0 -> 16993 bytes
.../new_ui/dev/datasource/azuresql-principal.png | Bin 0 -> 19178 bytes
.../new_ui/dev/datasource/azuresql-principal2.png | Bin 0 -> 43568 bytes
docs/img/new_ui/dev/datasource/azuresql-server.png | Bin 0 -> 18465 bytes
docs/img/new_ui/dev/datasource/azuresql-token.png | Bin 0 -> 24323 bytes
13 files changed, 146 insertions(+)
diff --git a/docs/configs/docsdev.js b/docs/configs/docsdev.js
index cf36a53ffe..cb3a059652 100644
--- a/docs/configs/docsdev.js
+++ b/docs/configs/docsdev.js
@@ -299,6 +299,10 @@ export default {
title: 'Amazon Athena',
link: '/en-us/docs/dev/user_doc/guide/datasource/athena.html',
},
+ {
+ title: 'Azure SQL Database',
+ link: '/en-us/docs/dev/user_doc/guide/datasource/azure-sql.html',
+ },
],
},
{
@@ -926,6 +930,10 @@ export default {
title: 'Amazon Athena',
link: '/zh-cn/docs/dev/user_doc/guide/datasource/athena.html',
},
+ {
+ title: 'Azure SQL Database',
+ link: '/zh-cn/docs/dev/user_doc/guide/datasource/azure-sql.html',
+ },
],
},
{
diff --git a/docs/docs/en/guide/datasource/azure-sql.md b/docs/docs/en/guide/datasource/azure-sql.md
new file mode 100644
index 0000000000..80174ec0bf
--- /dev/null
+++ b/docs/docs/en/guide/datasource/azure-sql.md
@@ -0,0 +1,77 @@
+# AZURE SQL
+
+## AUTH Mode
+
+### SqlPassword
+
+
+
+Use Azure SQL server username and password to login.
+
+| **Datasource** | **Description** |
+|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Datasource | Select AZURE SQL. |
+| Datasource name | Enter the name of the DataSource. |
+| Description | Enter a description of the DataSource. |
+| IP/Host Name | Enter the AZURE SQL service Host or IP, eg: xxx.database.windows.net. |
+| Port | Enter the AZURE SQL service port, 1433 by default. |
+| Auth Mode | Set the connection auth mode. Currently support: SqlPassword,ActiveDirectoryPassword,ActiveDirectoryMSI,ActiveDirectoryServicePrincipal,accessToken. |
+| Username | Set the username for AZURE SQL connection. |
+| Password | Set the password for AZURE SQL connection. |
+| Database name | Enter the database name of the AZURE SQL connection. |
+| Jdbc connection parameters | Parameter settings for AZURE SQL connection, in JSON format. |
+
+The following only describes the different attributes.
+
+### ActiveDirectoryPassword
+
+
+
+Use Azure AD username and password to login.
+
+Prerequisites: set AD account to be the admin of the Azure SQL server.
+
+
+
+- Azure AD username: Azure AD account name, eg: xx@xx.onmicrosoft.com
+- Password: Azure AD password
+
+### ActiveDirectoryMSI
+
+
+
+Use Azure internal services to login.
+Prerequisites: set Azure virtual machine to be the admin of the Azure SQL server. MSIClientId should be VM's Application ID and it is not required.
+
+
+
+
+- MSIClientId: input the clientId of the internal resources (eg: Azure VM, applications or Azure Active Directory application functions) of the ActiveDirectoryMSI mode.
+
+### ActiveDirectoryServicePrincipal
+
+
+
+Use application (client) ID and secret to login.
+Prerequisites: set application to be the admin of the Azure SQL server. Meanwhile, apply for client secret for the application and use both secret and ID to login.
+
+
+
+- clientId: application (client) ID
+- clientSecret: application client secret
+
+### accessToken
+
+
+
+Use application (client) ID and secret to apply for temporary token, and use token to login (not JDBC connection).
+
+
+
+- clientId: application (client) ID
+- clientSecret: application client secret
+- OAuth 2.0 token endpoint (v2): application OAuth 2.0 token endpoint (v2)
+
+## Support Native
+
+Yes, can use this datasource directly in SQL task.
diff --git a/docs/docs/zh/guide/datasource/azure-sql.md b/docs/docs/zh/guide/datasource/azure-sql.md
new file mode 100644
index 0000000000..6be6adf255
--- /dev/null
+++ b/docs/docs/zh/guide/datasource/azure-sql.md
@@ -0,0 +1,61 @@
+# AZURE SQL 数据源
+
+## 模式
+
+### SqlPassword
+
+
+
+使用数据库服务器的用户名和密码验证。
+- 数据源：选择 AZURE SQL
+- 数据源名称：输入数据源的名称
+- 描述：输入数据源的描述
+- IP 主机名：输入连接 AZURE SQL 的 HOST 或 IP ，例如：xxx.database.windows.net
+- 端口：输入连接 AZURE SQL 的端口，默认1433
+- 验证模式：输入 AZURE SQL 的连接模式，目前支持：SqlPassword,ActiveDirectoryPassword,ActiveDirectoryMSI,ActiveDirectoryServicePrincipal,accessToken.
+- 用户名：设置连接 AZURE SQL 的用户名
+- 密码：设置连接 AZURE SQL 的密码
+- 数据库名：输入连接 AZURE SQL 的数据库名称
+- Jdbc 连接参数：用于 AZURE SQL 连接的参数设置，以 JSON 形式填写
+以下仅对差异化属性进行说明。
+
+### ActiveDirectoryPassword
+
+
+
+采用Azure AD账号名和密码验证。
+前置条件：设置AD账号为数据库AD管理员。
+
+- Azure AD用户名：Azure AD 的账号名，例如：xx@xx.onmicrosoft.com
+- 密码：Azure AD 的密码
+
+### ActiveDirectoryMSI
+
+
+采用AZURE内部服务器验证。
+前置条件：先设置内部服务器为数据库AD管理员再进行请求，MSIClientId是服务器的id，是不必要的。
+
+
+- MSIClientId：选择ActiveDirectoryMSI模式下的内部资源（例如 Azure 虚拟机、应用服务或与 Azure Active Directory 联合的函数应用）的clientId
+
+### ActiveDirectoryServicePrincipal
+
+
+采用应用的应用程序(客户端) ID和密钥进行验证。
+前置条件：先设置应用为数据库AD管理员,同时给应用设置客户端密码，最终使用两者新建数据源。
+
+- clientId： ActiveDirectoryServicePrincipal模式下，应用的应用程序(客户端) ID
+- clientSecret：ActiveDirectoryServicePrincipal模式下，应用的应用程序客户端密码
+
+### accessToken
+
+
+采用应用的应用程序(客户端) ID和密钥去请求临时token，然后仅采用token进行连接，非jdbc连接。
+
+- clientId： accessToken模式下，应用的应用程序(客户端) ID
+- clientSecret：accessToken模式下，应用的应用程序客户端密码
+- OAuth 2.0 令牌终结点：accessToken模式下，应用的OAuth 2.0 令牌终结点(v2)
+
+## 是否原生支持
+
+是，数据源不需要任务附加操作即可使用。
diff --git a/docs/img/new_ui/dev/datasource/azuresql-ad.png b/docs/img/new_ui/dev/datasource/azuresql-ad.png
new file mode 100644
index 0000000000..0884da4711
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-ad.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-ad2.png b/docs/img/new_ui/dev/datasource/azuresql-ad2.png
new file mode 100644
index 0000000000..e1c6e631aa
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-ad2.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-endpoints.png b/docs/img/new_ui/dev/datasource/azuresql-endpoints.png
new file mode 100644
index 0000000000..75b83a1cfb
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-endpoints.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-msi-admin1.png b/docs/img/new_ui/dev/datasource/azuresql-msi-admin1.png
new file mode 100644
index 0000000000..40d7a652e0
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-msi-admin1.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-msi-admin2.png b/docs/img/new_ui/dev/datasource/azuresql-msi-admin2.png
new file mode 100644
index 0000000000..b129d5b617
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-msi-admin2.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-msi.png b/docs/img/new_ui/dev/datasource/azuresql-msi.png
new file mode 100644
index 0000000000..a7eccd113c
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-msi.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-principal.png b/docs/img/new_ui/dev/datasource/azuresql-principal.png
new file mode 100644
index 0000000000..b234020186
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-principal.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-principal2.png b/docs/img/new_ui/dev/datasource/azuresql-principal2.png
new file mode 100644
index 0000000000..7c1a609b10
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-principal2.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-server.png b/docs/img/new_ui/dev/datasource/azuresql-server.png
new file mode 100644
index 0000000000..6b66363538
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-server.png differ
diff --git a/docs/img/new_ui/dev/datasource/azuresql-token.png b/docs/img/new_ui/dev/datasource/azuresql-token.png
new file mode 100644
index 0000000000..3545dbb5b6
Binary files /dev/null and b/docs/img/new_ui/dev/datasource/azuresql-token.png differ