Unverified Commit ad90df20 authored by zhangchunyang's avatar zhangchunyang Committed by GitHub
Browse files

1. add file add README.md2. delete ambari_plugin/common-services/DOLPHIN/2.0.0 (#2546) 



* Ambari plugin development for the dolphin scheduler in version 2.0.0 is complete

* Update the Ambari plugin of DS  usage documentation

* delete readme whic is not completed

* update version 2.0.0 backup to 1.3.0

* update ambari plugin version to 1.3.0

* add readme doc

* delete common-services/DOLPHIN/2.0.0

* update the version in doc

Co-authored-by: default avatarzhangchunyang <zhangchunyang@analysys.com.cn>
Co-authored-by: default avatarzhangchunyang <18910529250@163.com>
Co-authored-by: default avatardailidong <dailidong66@gmail.com>
parent d629d385

ambari_plugin/README.md

0 → 100644
+68 −0
Original line number Diff line number Diff line 
### Dolphin Scheduler的Ambari插件使用说明



##### 备注



1. 本文档适用于对Ambari中基本了解的用户

2. 本文档是对已安装Ambari服务添加Dolphin Scheduler(1.3.0版本)服务的说明



##### 一  安装准备



1. 准备RPM包



   - 在源码dolphinscheduler-dist目录下执行命令```mvn -U clean install rpm:attached-rpm  -Prpmbuild  -Dmaven.test.skip=true -X```即可生成(在目录 dolphinscheduler-dist/target/rpm/apache-dolphinscheduler-incubating/RPMS/noarch 下)



2. 创建DS的安装用户--权限



3. 初始化数据库信息



   ```

   -- 创建Dolphin Scheduler的数据库：dolphinscheduler

   CREATE DATABASE dolphinscheduler DEFAULT CHARACTER SET utf8 DEFAULT COLLATE

   utf8_general_ci;

   

   -- 初始化dolphinscheduler数据库的用户和密码，并分配权限

   -- 替换下面sql语句中的{user}为dolphinscheduler数据库的用户

   GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'%' IDENTIFIED BY '{password}';

   GRANT ALL PRIVILEGES ON dolphinscheduler.* TO '{user}'@'localhost' IDENTIFIED BY

   '{password}';

   flush privileges;

   ```



 



##### 二  Ambari安装Dolphin Scheduler



1. Ambari界面安装Dolphin Scheduler



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_001.png)



2. 选择Dolphin Scheduler的Master安装的节点



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_002.png)



3. 配置Dolphin Scheduler的Worker、Api、Logger、Alert安装的节点



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_003.png)



4. 设置Dolphin Scheduler服务的安装用户（**步骤一中创建的**）及所属的用户组



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_004.png)



5. 配置数据库的信息（和步骤一中初始化数据库中一致）



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_005.png)



6. 配置其它的信息--如果需要的话



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_006.png)



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_007.png)



7. 正常执行接下来的步骤



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_008.png)



8. 安装成功后的界面



   ![](https://github.com/apache/incubator-dolphinscheduler-website/blob/master/img/ambari-plugin/DS2_AMBARI_009.png)

ambari_plugin/common-services/DOLPHIN/2.0.0/alerts.json

deleted100644 → 0
+0 −164
Original line number Diff line number Diff line 
{

  "DOLPHIN": {

    "service": [],

    "DOLPHIN_API": [

      {

        "name": "dolphin_api_port_check",

        "label": "dolphin_api_port_check",

        "description": "dolphin_api_port_check.",

        "interval": 10,

        "scope": "ANY",

        "source": {

          "type": "PORT",

          "uri": "{{dolphin-application-api/server.port}}",

          "default_port": 12345,

          "reporting": {

            "ok": {

              "text": "TCP OK - {0:.3f}s response on port {1}"

            },

            "warning": {

              "text": "TCP OK - {0:.3f}s response on port {1}",

              "value": 1.5

            },

            "critical": {

              "text": "Connection failed: {0} to {1}:{2}",

              "value": 5.0

            }

          }

        }

      }

    ],

    "DOLPHIN_MASTER": [

      {

        "name": "DOLPHIN_MASTER_CHECK",

        "label": "check dolphin scheduler master status",

        "description": "",

        "interval":10,

        "scope": "HOST",

        "enabled": true,

        "source": {

          "type": "SCRIPT",

          "path": "DOLPHIN/2.0.0/package/alerts/alert_dolphin_scheduler_status.py",

          "parameters": [



            {

              "name": "connection.timeout",

              "display_name": "Connection Timeout",

              "value": 5.0,

              "type": "NUMERIC",

              "description": "The maximum time before this alert is considered to be CRITICAL",

              "units": "seconds",

              "threshold": "CRITICAL"

            },

            {

              "name": "alertName",

              "display_name": "alertName",

              "value": "DOLPHIN_MASTER",

              "type": "STRING",

              "description": "alert name"

            }

          ]

        }

      }

    ],

    "DOLPHIN_WORKER": [

      {

        "name": "DOLPHIN_WORKER_CHECK",

        "label": "check dolphin scheduler worker status",

        "description": "",

        "interval":10,

        "scope": "HOST",

        "enabled": true,

        "source": {

          "type": "SCRIPT",

          "path": "DOLPHIN/2.0.0/package/alerts/alert_dolphin_scheduler_status.py",

          "parameters": [



            {

              "name": "connection.timeout",

              "display_name": "Connection Timeout",

              "value": 5.0,

              "type": "NUMERIC",

              "description": "The maximum time before this alert is considered to be CRITICAL",

              "units": "seconds",

              "threshold": "CRITICAL"

            },

            {

              "name": "alertName",

              "display_name": "alertName",

              "value": "DOLPHIN_WORKER",

              "type": "STRING",

              "description": "alert name"

            }

          ]

        }

      }

    ],

    "DOLPHIN_ALERT": [

      {

        "name": "DOLPHIN_DOLPHIN_ALERT_CHECK",

        "label": "check dolphin scheduler alert status",

        "description": "",

        "interval":10,

        "scope": "HOST",

        "enabled": true,

        "source": {

          "type": "SCRIPT",

          "path": "DOLPHIN/2.0.0/package/alerts/alert_dolphin_scheduler_status.py",

          "parameters": [



            {

              "name": "connection.timeout",

              "display_name": "Connection Timeout",

              "value": 5.0,

              "type": "NUMERIC",

              "description": "The maximum time before this alert is considered to be CRITICAL",

              "units": "seconds",

              "threshold": "CRITICAL"

            },

            {

              "name": "alertName",

              "display_name": "alertName",

              "value": "DOLPHIN_ALERT",

              "type": "STRING",

              "description": "alert name"

            }

          ]

        }

      }

    ],

    "DOLPHIN_ALERT": [

      {

        "name": "DOLPHIN_DOLPHIN_LOGGER_CHECK",

        "label": "check dolphin scheduler alert status",

        "description": "",

        "interval":10,

        "scope": "HOST",

        "enabled": true,

        "source": {

          "type": "SCRIPT",

          "path": "DOLPHIN/2.0.0/package/alerts/alert_dolphin_scheduler_status.py",

          "parameters": [



            {

              "name": "connection.timeout",

              "display_name": "Connection Timeout",

              "value": 5.0,

              "type": "NUMERIC",

              "description": "The maximum time before this alert is considered to be CRITICAL",

              "units": "seconds",

              "threshold": "CRITICAL"

            },

            {

              "name": "alertName",

              "display_name": "alertName",

              "value": "DOLPHIN_LOGGER",

              "type": "STRING",

              "description": "alert name"

            }

          ]

        }

      }

    ]

  }

}
 
 No newline at end of file

ambari_plugin/common-services/DOLPHIN/2.0.0/configuration/dolphin-alert.xml

deleted100644 → 0
+0 −143
Original line number Diff line number Diff line 
<!--

  ~ Licensed to the Apache Software Foundation (ASF) under one or more

  ~ contributor license agreements.  See the NOTICE file distributed with

  ~ this work for additional information regarding copyright ownership.

  ~ The ASF licenses this file to You under the Apache License, Version 2.0

  ~ (the "License"); you may not use this file except in compliance with

  ~ the License.  You may obtain a copy of the License at

  ~

  ~     http://www.apache.org/licenses/LICENSE-2.0

  ~

  ~ Unless required by applicable law or agreed to in writing, software

  ~ distributed under the License is distributed on an "AS IS" BASIS,

  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  ~ See the License for the specific language governing permissions and

  ~ limitations under the License.

  -->

<configuration>

	<property>

		<name>alert.type</name>

		<value>EMAIL</value>

		<description>alert type is EMAIL/SMS</description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>alert.template</name>

		<value>html</value>

		<description>alter msg template, default is html template</description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.protocol</name>

		<value>SMTP</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.server.host</name>

		<value>xxx.xxx.com</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.server.port</name>

		<value>25</value>

		<value-attributes>

			<type>int</type>

		</value-attributes>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.sender</name>

		<value>admin</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.user</name>

		<value>admin</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.passwd</name>

		<value>000000</value>

		<description></description>

		<property-type>PASSWORD</property-type>

		<value-attributes>

			<type>password</type>

		</value-attributes>

		<on-ambari-upgrade add="true"/>

	</property>



	<property>

		<name>mail.smtp.starttls.enable</name>

		<value>true</value>

		<value-attributes>

			<type>boolean</type>

		</value-attributes>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.smtp.ssl.enable</name>

		<value>true</value>

		<value-attributes>

			<type>boolean</type>

		</value-attributes>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>mail.smtp.ssl.trust</name>

		<value>xxx.xxx.com</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>



	<property>

		<name>enterprise.wechat.enable</name>

		<value>false</value>

		<description></description>

		<value-attributes>

			<type>value-list</type>

			<entries>

				<entry>

					<value>true</value>

					<label>Enabled</label>

				</entry>

				<entry>

					<value>false</value>

					<label>Disabled</label>

				</entry>

			</entries>

			<selection-cardinality>1</selection-cardinality>

		</value-attributes>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>enterprise.wechat.corp.id</name>

		<value>wechatId</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>enterprise.wechat.secret</name>

		<value>secret</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>enterprise.wechat.agent.id</name>

		<value>agentId</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

	<property>

		<name>enterprise.wechat.users</name>

		<value>wechatUsers</value>

		<description></description>

		<on-ambari-upgrade add="true"/>

	</property>

</configuration>
 
 No newline at end of file

ambari_plugin/common-services/DOLPHIN/2.0.0/configuration/dolphin-application-api.xml

deleted100644 → 0
+0 −87
Original line number Diff line number Diff line 
<!--

  ~ Licensed to the Apache Software Foundation (ASF) under one or more

  ~ contributor license agreements.  See the NOTICE file distributed with

  ~ this work for additional information regarding copyright ownership.

  ~ The ASF licenses this file to You under the Apache License, Version 2.0

  ~ (the "License"); you may not use this file except in compliance with

  ~ the License.  You may obtain a copy of the License at

  ~

  ~     http://www.apache.org/licenses/LICENSE-2.0

  ~

  ~ Unless required by applicable law or agreed to in writing, software

  ~ distributed under the License is distributed on an "AS IS" BASIS,

  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  ~ See the License for the specific language governing permissions and

  ~ limitations under the License.

  -->

<configuration>

	<property>

		<name>server.port</name>

		<value>12345</value>

		<description>

			server port

		</description>

		<value-attributes>

			<type>int</type>

		</value-attributes>

	</property>

	<property>

		<name>server.servlet.session.timeout</name>

		<value>7200</value>

		<value-attributes>

			<type>int</type>

		</value-attributes>

		<description>

		</description>

	</property>

	<property>

		<name>server.servlet.context-path</name>

		<value>/dolphinscheduler/</value>

		<description>

		</description>

	</property>

	<property>

		<name>spring.servlet.multipart.max-file-size</name>

		<value>1024</value>

		<value-attributes>

			<unit>MB</unit>

			<type>int</type>

		</value-attributes>

		<description>

		</description>

	</property>

	<property>

		<name>spring.servlet.multipart.max-request-size</name>

		<value>1024</value>

		<value-attributes>

			<unit>MB</unit>

			<type>int</type>

		</value-attributes>

		<description>

		</description>

	</property>

	<property>

		<name>server.jetty.max-http-post-size</name>

		<value>5000000</value>

		<value-attributes>

			<type>int</type>

		</value-attributes>

		<description>

		</description>

	</property>

	<property>

		<name>spring.messages.encoding</name>

		<value>UTF-8</value>

		<description></description>

	</property>

	<property>

		<name>spring.messages.basename</name>

		<value>i18n/messages</value>

		<description></description>

	</property>

	<property>

		<name>security.authentication.type</name>

		<value>PASSWORD</value>

		<description></description>

	</property>

</configuration>
 
 No newline at end of file

ambari_plugin/common-services/DOLPHIN/2.0.0/configuration/dolphin-common.xml

deleted100644 → 0
+0 −158
Original line number Diff line number Diff line 
<!--

  ~ Licensed to the Apache Software Foundation (ASF) under one or more

  ~ contributor license agreements.  See the NOTICE file distributed with

  ~ this work for additional information regarding copyright ownership.

  ~ The ASF licenses this file to You under the Apache License, Version 2.0

  ~ (the "License"); you may not use this file except in compliance with

  ~ the License.  You may obtain a copy of the License at

  ~

  ~     http://www.apache.org/licenses/LICENSE-2.0

  ~

  ~ Unless required by applicable law or agreed to in writing, software

  ~ distributed under the License is distributed on an "AS IS" BASIS,

  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

  ~ See the License for the specific language governing permissions and

  ~ limitations under the License.

  -->

<configuration>

    <property>

        <name>resource.storage.type</name>

        <display-name>Choose Resource Upload Startup Type</display-name>

        <description>

            Resource upload startup type : HDFS,S3,NONE

        </description>

        <value>NONE</value>

        <value-attributes>

            <type>value-list</type>

            <entries>

                <entry>

                    <value>HDFS</value>

                    <label>HDFS</label>

                </entry>

                <entry>

                    <value>S3</value>

                    <label>S3</label>

                </entry>

                <entry>

                    <value>NONE</value>

                    <label>NONE</label>

                </entry>

            </entries>

            <selection-cardinality>1</selection-cardinality>

        </value-attributes>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>resource.upload.path</name>

        <value>/dolphinscheduler</value>

        <description>

            resource store on HDFS/S3 path, resource file will store to this hadoop hdfs path, self configuration, please make sure the directory exists on hdfs and have read write permissions。"/dolphinscheduler" is recommended

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>data.basedir.path</name>

        <value>/tmp/dolphinscheduler</value>

        <description>

            user data local directory path, please make sure the directory exists and have read write permissions

        </description>

        <on-ambari-upgrade add="true"/>

    </property>



    <property>

        <name>hadoop.security.authentication.startup.state</name>

        <value>false</value>

        <value-attributes>

            <type>value-list</type>

            <entries>

                <entry>

                    <value>true</value>

                    <label>Enabled</label>

                </entry>

                <entry>

                    <value>false</value>

                    <label>Disabled</label>

                </entry>

            </entries>

            <selection-cardinality>1</selection-cardinality>

        </value-attributes>

        <description>whether kerberos starts</description>

    </property>

    <property>

        <name>java.security.krb5.conf.path</name>

        <value>/opt/krb5.conf</value>

        <description>

            java.security.krb5.conf path

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>login.user.keytab.username</name>

        <value>hdfs-mycluster@ESZ.COM</value>

        <description>

            LoginUserFromKeytab user

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>login.user.keytab.path</name>

        <value>/opt/hdfs.headless.keytab</value>

        <description>

            LoginUserFromKeytab path

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>resource.view.suffixs</name>

        <value>txt,log,sh,conf,cfg,py,java,sql,hql,xml,properties</value>

        <description></description>

    </property>

    <property>

        <name>hdfs.root.user</name>

        <value>hdfs</value>

        <description>

            Users who have permission to create directories under the HDFS root path

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>fs.defaultFS</name>

        <value>hdfs://mycluster:8020</value>

        <description>

            HA or single namenode,

            If namenode ha needs to copy core-site.xml and hdfs-site.xml to the conf directory，

            support s3，for example : s3a://dolphinscheduler

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>fs.s3a.endpoint</name>

        <value>http://host:9010</value>

        <description>

            s3 need，s3 endpoint

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>fs.s3a.access.key</name>

        <value>A3DXS30FO22544RE</value>

        <description>

            s3 need，s3 access key

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>fs.s3a.secret.key</name>

        <value>OloCLq3n+8+sdPHUhJ21XrSxTC+JK</value>

        <description>

            s3 need，s3 secret key

        </description>

        <on-ambari-upgrade add="true"/>

    </property>

    <property>

        <name>kerberos.expire.time</name>

        <value>7</value>

        <description></description>

    </property>



</configuration>
 
 No newline at end of file