community.digitalocean.digital_ocean_project 模块 – 管理 DigitalOcean 项目

注意

此模块是 community.digitalocean 集合（版本 1.27.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.digitalocean。

要在 playbook 中使用它，请指定：community.digitalocean.digital_ocean_project。

community.digitalocean 1.6.0 中的新增功能

概要

  • 管理 DigitalOcean 中的项目

参数

参数

注释

description

字符串

项目的描述。最大长度为 255 个字符。

environment

字符串

项目资源的环境。

选择

  • "Development"

  • "Staging"

  • "Production"

id

字符串

项目的 UUID

is_default

布尔值

如果为 true，则如果没有指定项目，所有资源都将添加到此项目。

选择

  • false ←（默认）

  • true

name

字符串

项目的易读名称。最大长度为 175 个字符，并且名称必须是唯一的。

oauth_token

别名：API_TOKEN

字符串 / 必需

DigitalOcean OAuth 令牌。可以在 DO_API_KEY、DO_API_TOKEN 或 DO_OAUTH_TOKEN 环境变量中指定

purpose

字符串

项目的目的。最大长度为 255 个字符

如果状态为 present，则为必需

如果不是 DO 提供的目的之一，将以 Other 为前缀

DO 提供的目的可以在下面找到

只是 尝试 使用 DigitalOcean

课程 项目/教育 目的

网站 或 博客

Web 应用程序

服务 或 API

移动 应用程序

机器学习/人工智能/数据 处理

物联网

操作/开发者 工具

state

字符串

指示目标所需的 状态。

present 将创建项目

absent 将删除该项目（如果存在）。

选择

  • "present" ←（默认）

  • "absent"

示例

# Creates a new project
- community.digitalocean.digital_ocean_project:
    name: "TestProj"
    state: "present"
    description: "This is a test project"
    purpose: "IoT"
    environment: "Development"

# Updates the existing project with the new environment
- community.digitalocean.digital_ocean_project:
    name: "TestProj"
    state: "present"
    description: "This is a test project"
    purpose: "IoT"
    environment: "Production"

# This renames an existing project by utilizing the id of the project
- community.digitalocean.digital_ocean_project:
    name: "TestProj2"
    id: "12312312-abcd-efgh-ijkl-123123123123"
    state: "present"
    description: "This is a test project"
    purpose: "IoT"
    environment: "Development"

# This creates a project that results with a purpose of "Other: My Prod App"
- community.digitalocean.digital_ocean_project:
    name: "ProdProj"
    state: "present"
    description: "This is a prod app"
    purpose: "My Prod App"
    environment: "Production"

# This removes a project
- community.digitalocean.digital_ocean_project:
    name: "ProdProj"
    state: "absent"

返回值

常见返回值记录在此处，以下是此模块特有的字段

键

描述

数据

字典

一个 DigitalOcean 项目

已返回： changed

示例： {"project": {"created_at": "2021-05-28T00:00:00Z", "description": "这是一个测试描述", "environment": "Development", "id": "12312312-abcd-efgh-1234-abcdefgh123", "is_default": false, "name": "Test123", "owner_id": 1234567, "owner_uuid": "12312312-1234-5678-abcdefghijklm", "purpose": "IoT", "updated_at": "2021-05-29T00:00:00Z"}}

作者

  • Tyler Auerbeck (@tylerauerbeck)