Tigon 开源项目安装与使用教程

Tigon 开源项目安装与使用教程

tigon 项目地址: https://gitcode.com/gh_mirrors/tig/tigon

1. 项目目录结构及介绍

Tigon 项目的目录结构如下：

tigon/
├── bin/
│   ├── tigon-api/
│   ├── tigon-client/
│   ├── tigon-common/
│   ├── tigon-distribution/
│   ├── tigon-docs/
│   ├── tigon-examples/
│   ├── tigon-flow/
│   ├── tigon-hbase-compat-0.94/
│   ├── tigon-hbase-compat-0.96/
│   ├── tigon-queue/
│   ├── tigon-sql/
│   ├── tigon-unit-test/
│   └── tigon-yarn/
├── .gitignore
├── .travis.yml
├── BUILD.md
├── LICENSE
├── README.md
├── checkstyle.xml
├── pom.xml
└── suppressions.xml

目录结构介绍

• bin/: 包含 Tigon 项目的各个模块，如 API、客户端、公共库、分布式模块等。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 配置文件。
• BUILD.md: 构建项目的说明文档。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• checkstyle.xml: Checkstyle 配置文件。
• pom.xml: Maven 项目配置文件。
• suppressions.xml: Checkstyle 抑制配置文件。

2. 项目启动文件介绍

Tigon 项目的启动文件主要位于 bin/ 目录下，具体包括：

• run_standalone.sh: 用于在单机模式下启动 Tigon 的脚本。
• run_distributed.sh: 用于在分布式模式下启动 Tigon 的脚本。

启动命令示例

单机模式启动

$ run_standalone.sh <path-to-flow-jar> <flow-class-name> <run-time-args>

分布式模式启动

$ run_distributed.sh <zookeeper-quorum> <hdfs-namespace>

3. 项目配置文件介绍

Tigon 项目的配置文件主要包括以下几个：

• pom.xml: Maven 项目配置文件，定义了项目的依赖、构建配置等。
• checkstyle.xml: Checkstyle 配置文件，用于代码风格检查。
• suppressions.xml: Checkstyle 抑制配置文件，用于忽略某些代码风格的检查。
• .gitignore: Git 忽略文件配置，定义了哪些文件或目录不需要被 Git 管理。
• .travis.yml: Travis CI 配置文件，定义了持续集成的工作流程。

配置文件示例

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>io.tigon</groupId>
    <artifactId>tigon</artifactId>
    <version>0.2.1</version>
    <dependencies>
        <!-- 项目依赖 -->
    </dependencies>
    <build>
        <!-- 构建配置 -->
    </build>
</project>

checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
        "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
        "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<module name="Checker">
    <!-- Checkstyle 配置 -->
</module>

.gitignore

# 忽略 Maven 构建输出
target/
# 忽略 IDE 配置文件
.idea/
*.iml

通过以上配置文件，可以对 Tigon 项目进行构建、代码风格检查以及版本控制的管理。

tigon 项目地址: https://gitcode.com/gh_mirrors/tig/tigon