cycloid/cycloid-events-resource

Cycloid事件资源

与Cycloid DevOps框架发送和接收事件。该框架提供事件端点作为集中式存储和检索事件的唯一入口，通过从管道直接存储事件，可增强重要步骤的可见性并永久存储生产部署等关键事件。

部署到Concourse

可通过在管道YAML中定义资源类型使用此Docker镜像。

示例：

yaml
resource_types:
- name: cycloid-events
  type: docker-image
  source:
    repository: cycloid/cycloid-events-resource
    tag: latest

源配置

以下所有可选值若在源中指定，将作为默认值，直至被参数配置覆盖。

• api_url: 必填。Cycloid DevOps平台API的URL。 示例：https://http-api.cycloid.io

• api_key: 必填。用于发送事件的Cycloid API密钥。

• organization: 必填。存储事件的组织。

• type: 可选。事件类型。目前仅允许Cycloid、Custom、AWS或Monitoring。

• severity: 可选。事件严重程度。目前仅允许info、warn、err或crit。

• icon: 可选。显示图标，使用Font Awesome图标。 示例：fa-cubes

• title: 可选。事件标题。

• message: 可选。事件正文消息。

• message_file: 可选。包含事件正文消息的文件路径。

• fail_on_error: 可选。若为true，当Cycloid事件API返回错误时资源将失败。默认false（真值包括y、yes、t、true、on和1；假值包括n、no、f、false、off和0）。

• vars_file: 可选。从文件加载可用于事件消息或标题的变量。格式为MYKEY: value，使用方式为my title containing vars $MYKEY。

• tags: 可选。用于过滤的标签。 示例：

  tags:
    - key: project
      value: myproject
    - key: env
      value: prod
  

行为

check: 检查新事件

目前未实现，未来将允许在新事件生成时触发作业。

in: 检索事件

目前未实现。

out: 向Cycloid发送事件

使用指定参数将事件发送到Cycloid API。

参数

/!\ *必填*参数可在此处或源配置中定义 /!\

• type: 必填。事件类型。目前仅允许Cycloid、Custom、AWS或Monitoring。

• severity: 必填。事件严重程度。目前仅允许info、warn、err或crit。

• icon: 必填。显示图标，使用Font Awesome图标。 示例：fa-cubes

• title: 必填。事件标题。

• message: 可选。事件正文消息。（需定义message或message_file）。

• message_file: 可选。包含事件正文消息的文件路径。

• fail_on_error: 可选。若为true，当Cycloid事件API返回错误时资源将失败。默认false（真值包括y、yes、t、true、on和1；假值包括n、no、f、false、off和0）。

• vars_file: 可选。从文件加载可用于事件消息或标题的变量。格式为MYKEY: value，使用方式为my title containing vars $MYKEY。

• tags: 必填。用于过滤的标签。 示例：

  tags:
    - key: project
      value: myproject
    - key: env
      value: prod