使用 IDE

支持范围:

本文档介绍了集成开发环境 (IDE) 生产模式。 IDE 是一个用于查看、修改和测试代码的框架。您可以查看商业集成的代码,并从头开始创建自定义集成,也可以通过复制商业集成代码来创建自定义集成。

IDE 是您管理、导入和导出自定义集成的地方。

打开 IDE

如需打开 IDE,请按以下步骤操作:

  • 如需打开 IDE,请在主菜单中依次前往自动化 > IDE。系统随即会打开 IDE 页面。

在 IDE 页面上,您可以访问以下选项:

选项 说明
集成
类型
选择集成或类型(连接器、操作、作业、管理器)。
导出
导入
从集成中导出单个或多个内容。导出单个内容项时,系统会一并导出依赖项,但导出完整软件包时则不会。
导出的文件是一个包含 JSON 文件的 ZIP 归档文件。导入时,您可以将单个内容添加到现有集成中,也可以导入完整软件包。对于旧版(V1 - 数据平面已停用)导出/导入格式,软件包必须包含 integrations.def 文件和以下文件夹:ActionsDefinitions、ActionsScripts、Dependencies 和 Managers。对于新的(V2 - 启用数据平面)导出/导入格式,软件包文件夹必须包含 metadata.json 文件,并且可以包含以下文件夹:actions、connectors、jobs 和 dependencies。
请注意,不支持从启用了数据平面的环境导出集成,并将其导入到未启用数据平面的环境。反之(从停用数据平面的环境导出到启用数据平面的环境)则受支持。
点击隐藏非活跃项/显示所有项切换开关,以显示或隐藏已停用的项(操作、连接器)。
添加新的自定义集成、连接器、操作、作业或管理器。

添加连接器

如需添加连接器,请按以下步骤操作:

  1. 点击 创建新项,然后选择连接器。
  2. 输入名称和所需的集成。
  3. 点击创建。
  4. 添加集成详情。
  5. 添加所需参数。
  6. 点击连接器切换开关以启用连接器。
  7. 完成后,点击保存,或按 Ctrl + S。

详细信息标签页中提供以下选项:

选项 说明
删除 仅适用于自定义集成中的内容。
Google Play 运行脚本的测试方法。结果会显示在测试标签页中,调试输出会显示在调试输出部分。
file_json 管理 JSON 示例 在 JSON 示例导入/导出对话框中,确保已启用包括 JSON 结果。然后,您可以为操作导入或导出 JSON 结果示例。
详细信息输入用户提供的输入和其他参数,例如集成名称。
版本控制 版本控制 - 选择操作/作业/连接器,然后点击以查看以下选项: 另存为新版本:将对象另存为新版本,并可选择添加注释。查看版本记录:查看和恢复先前版本。仅在至少保存了一个版本时可用。点击“恢复”即可随时还原到之前的任何版本。仅当您之前对操作/作业/连接器/管理器点击了另存为新版本时,此选项才可用。
重复商品 复制项目(作业、操作、连接器、管理器)。保存后,副本会显示在列表中,且不带锁形锁定图标。

创建自定义集成

  1. 点击 创建新内容,然后选择集成。
  2. 输入名称,然后点击创建。
  3. 从列表中选择创建的集成,并提供以下信息:
    • 说明:显示在 Content Hub 中,所有 Google Security Operations 用户都可以看到。
    • SVG 图标:上传与集成一起显示的 SVG 图标。
    • 图片:为 Google SecOps 用户上传 Content Hub 图片。
    • 库:使用 pip 添加 Python 库。
    • 脚本依赖项:上传“.WHL”“.PY”“.TAR”或“.GZ”文件。这些脚本可为您的集成添加更多功能。
    • 参数:添加具有已定义类型、默认值和必需状态的可配置字段。
  4. 完成后,点击保存。

创建作业

如需创建作业,请按以下步骤操作:

  1. 点击 Create New Item(新建项),然后选择 Job(作业)。
  2. 输入名称和所需的集成。
  3. 点击创建。
  4. 可选:添加用户或脚本输入参数。
  5. 点击保存或按 Ctrl + S。
  6. 点击 arrow_right 播放项以运行脚本。
  7. 前往自动化 > 作业调度器。
  8. 点击 add创建新作业,然后选择您刚刚创建的作业。
  9. 在响应 >作业调度器中,选择运行您创建的作业(脚本)所需的时间。

创建要在 playbook 中使用的新操作

如需为 playbook 创建新操作,请按以下步骤操作:

  1. 点击 创建新项,然后选择操作。
  2. 输入名称和所需的集成 > 点击创建。
  3. 根据需要修改代码。
  4. 如果操作应在 playbook 中返回 JSON 结果,请启用包含 JSON 结果。
  5. 可选:添加要显示为输入字段的参数。
  6. 启用该操作,然后点击保存。
  7. 在轮询配置中,您可以设置超时和默认返回值(如果操作超时)。您还可以设置一个默认值,以便在操作未在定义的超时期限内完成时返回。

现在,您可以在 Playbook > 操作中使用该操作。

创建自定义管理器

如需创建自定义管理员,请按以下步骤操作:

  1. 点击 创建新项,然后选择经理。输入名称和所需的集成。
  2. 点击创建。
  3. 根据需要修改代码。
  4. 点击保存。

IDE 自定义代码安全

为确保代码执行环境安全,IDE 中的所有自定义 Python 代码都在沙盒环境中运行。此环境与主服务器隔离,并以低权限用户身份运行。对底层操作系统的访问权限严格限制在典型集成和自动化任务所需的非管理命令和目录的许可名单内。这种沙盒化方法既能提供强大的安全性,又能灵活执行各种 Python 代码。

需要更多帮助?获得社区成员和 Google SecOps 专业人士的解答。