Golang构建多语言强大管道的插件库Gaia使用指南

什么是Gaia？

Gaia是一个开源自动化平台，它让使用任何编程语言构建强大的管道变得简单有趣。基于HashiCorp的go-plugin和gRPC，Gaia高效、快速、轻量且对开发者友好。

安装Gaia

使用Docker安装

docker run -d -p 8080:8080 -v $PWD:/data gaiapipeline/gaia:latest

使用默认用户admin和密码admin登录，建议之后更改密码。

示例管道代码

Go语言示例

package main

import (
    "log"

    sdk "github.com/gaia-pipeline/gosdk"
)

// 这是一个job，你可以根据需要添加更多
func DoSomethingAwesome(args sdk.Arguments) error {
    log.Println("This output will be streamed back to gaia and will be displayed in the pipeline logs.")

    // 如果发生错误，返回它让Gaia知道这个job失败了
    return nil
}

func main() {
    jobs := sdk.Jobs{
        sdk.Job{
            Handler:     DoSomethingAwesome,
            Title:       "DoSomethingAwesome",
            Description: "This job does something awesome.",
        },
    }

    // 服务启动
    if err := sdk.Serve(jobs); err != nil {
        panic(err)
    }
}

Python示例

from gaiasdk import sdk
import logging

def MyAwesomeJob(args):
    logging.info("This output will be streamed back to gaia and will be displayed in the pipeline logs.")
    # 通过抛出异常告诉Gaia job失败了
    # raise Exception("Oh no, this job failed!")

def main():
    logging.basicConfig(level=logging.INFO)
    myjob = sdk.Job("MyAwesomeJob", "Do something awesome", MyAwesomeJob)
    sdk.serve([myjob])

Java示例

package io.gaiapipeline;

import io.gaiapipeline.javasdk.*;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.logging.Logger;

public class Pipeline {
    private static final Logger LOGGER = Logger.getLogger(Pipeline.class.getName());

    private static Handler MyAwesomeJob = (gaiaArgs) -> {
        LOGGER.info("This output will be streamed back to gaia and will be displayed in the pipeline logs.");
        // 通过抛出异常告诉Gaia job失败了
        // throw new IllegalArgumentException("Oh no, this job failed!");
    };

    public static void main(String[] args) {
        PipelineJob myjob = new PipelineJob();
        myjob.setTitle("MyAwesomeJob");
        myjob.setDescription("Do something awesome.");
        myjob.setHandler(MyAwesomeJob);

        Javasdk sdk = new Javasdk();
        try {
            sdk.Serve(new ArrayList<>(Arrays.asList(myjob)));
        } catch (Exception ex) {
            ex.printStackTrace();
        }
    }
}

Gaia工作原理

Gaia基于HashiCorp的go-plugin和gRPC技术构建。插件(也称为管道)可以是任何支持gRPC的编程语言编写的应用程序。所有函数(称为jobs)都暴露给Gaia，并可以形成一个描述执行顺序的依赖图。

管道可以本地编译或通过集成的构建系统构建。Gaia会克隆git仓库并自动构建包含的管道。如果有变更(git push)，Gaia会自动为你重建管道*。

*这需要激活轮询或webhook

常见问题

Gaia解决了什么问题？

几乎所有为自动化、持续集成(CI)和持续部署(CD)设计的工具都引入了自己的配置格式。Gaia是第一个不限制用户并提供几乎所有常见编程语言全面支持的平台，同时不失去当今CI/CD工具提供的功能。

什么是管道？

管道是一个真正的应用程序，至少包含一个函数(我们称之为Job)。只要支持gRPC，任何编程语言都可以使用。我们提供SDK来支持开发。

为什么需要SDK？

SDK实现了Gaia插件gRPC接口，并提供像服务gRPC-Server这样的辅助函数。这帮助你专注于真正的问题，而不是做无聊的事情。

支持哪些编程语言？

目前完全支持Go、Java、Python、C++、Ruby和Node.JS。