HashiCorp 和 Ansible Automation Platform 入门

流程

1. 登录到 Ansible Automation Platform。
2. 在导航面板中，选择 Automation Execution → Infrastructure → Credential Types。
3. 单击 Create credential type。Create Credential Type 页面将打开并显示 Details 选项卡。
4. 对于 Name 字段，输入凭证类型名称。

5. 在 Input configuration 字段中输入以下参数和值：

   fields:
     - id: token
       type: string
       label: token
       secret: true

6. 在 Injector 配置 字段中，输入以下配置：

   env:
     TF_TOKEN:  ‘{{ token }}’

7. 要保存配置，请再次点击 Create Credential Type。创建新凭证类型。

流程

1. 登录到 Ansible Automation Platform。
2. 在导航面板中，选择 Automation Execution → Infrastructure → Credentials，然后选择 Create credential。
3. 从 Credential type 列表中，选择凭证类型。显示的字段取决于凭证类型。
4. 在 Token 字段中输入 Terraform API 令牌。
5. （可选）编辑 Description 字段，并从 Organization 列表中选择 TF 机构。
6. 单击 Save credential。您已准备好在作业模板中使用凭证。

流程

1. 登录到 Ansible Automation Platform。
2. 在导航面板中，选择 Automation Execution → Infrastructure → Credential Types。
3. 单击 Create credential type。Create Credential Type 页面将打开并显示 Details 选项卡。
4. 对于 凭据类型， 请输入名称。

5. 在 Input configuration 字段中输入以下 YAML 参数和值：

   fields:
      - id: token
        type: string
        label: token
        secret: true

6. 在 Injector 配置 字段中，输入以下配置。

   • 对于 Terraform Enterprise，主机名是您部署 TFE 的位置：

     env:
       TF_TOKEN_<hostname>:  ‘{{ token }}’

   • 对于 HCP Terraform，请使用：

     env:
       TF_TOKEN_app_terraform_io:   ‘{{ token }}’

7. 要保存配置，请再次点击 Create Credential Type。创建新凭证类型。
8. 要创建新凭证类型的实例，请选择 Automation Execution → Infrastructure → Credentials 页面，然后选择 Create credential。
9. 从 Credential type 中选择您之前创建的凭证类型的名称。
10. 在 Token 字段中输入 Terraform API 令牌。
11. （可选）编辑 Description 并从 Organization 列表中选择 TF 机构。
12. 单击 Save credential。

流程

1. 在导航面板中，选择 Automation Execution → Infrastructure → Execution Environments。

2. 单击 Create execution environment。

   
3. 对于 Name，输入 Ansible Automation Platform 执行环境的名称。
4. 对于 Image，输入到您预先存在的执行环境的镜像的存储库链接。
5. 单击 Create execution environment。您新添加的执行环境已准备好在作业模板中使用。

流程

1. 在导航面板中，选择 Automation Execution → Templates。
2. 选择 Create template > Create Job Template。
3. 从 Execution Environment 列表中，选择您创建的环境。
4. 从 Credentials 列表中，选择您之前创建的凭据实例。如果没有看到凭证，请点击 Browse 来查看列表中的更多选项。
5. 为必填字段输入任何其他信息。
6. 单击 Create job template。
7. 点 Launch template。
8. 要启动作业，请单击 Next 和 Finish。作业输出显示作业已运行。

流程

1. 从 cloud.terraform 模块中复制您的自动化任务。

   示例

   - name: Create configuration version with auto_queue_runs to false
     hashicorp.terraform.configuration_version:
      workspace_id: ws-1234
      configuration_files_path: "/usr/home/tf"
      auto_queue_runs: false
      tf_validate_certs: true
      poll_interval: 3
      poll_timeout: 15
      state: present

2. 配置以下所需参数：

   • workspace_id 或 workspace + organization ： 将创建配置版本的工作区 ID 或工作区名称和组织，该文件将被上传（表示 state: present）。

   • configuration_files_path ： 上传所需 Terraform Enterprise 或 HCP Terraform 文件的路径来创建配置版本（用于 state: present）。模块接受 configuration_files_path 的两个文件类型：

     • 目录： 包含 Terraform Enterprise 或 HCP Terraform 文件的任何文件夹。模块会自动从所有内容中自动创建 .tar.gz 文件。
     • .tar.gz Archive: Pre-compressed gzip tarball.模块验证 TAR 格式和 gzip 压缩。

   • configuration_version_id ： 要存档的配置版本 ID (状态： archive)。此操作会删除关联的上传的 .tar.gz 文件。注意以下几点：

     • 仅上传使用 API 或 CLI 创建的版本，没有活跃的运行，且不是任何工作区的当前版本可以被归档。
     • 如果未指定 configuration_version_id，Terraform Enterprise 或 HCP Terraform 在工作区中选择最新的批准的 configuration_version_id。
   • auto_queue_runs ： 确定 Terraform Enterprise 或 HCP Terraform 是否在配置上传后自动启动（默认为true ），或者需要手动启动(false)。
3. 根据需要设置其他 可选参数。

流程

1. 创建 run 模块。

   示例

   - name: Create a destroy run with auto_apply
     hashicorp.terraform.run:
     workspace_id: ws-1234
     run_message: "destroy vpc"
     state: "present"
     tf_token: <your token>
     is_destroy: true
     auto_apply: true
     target_addrs:
       - "aws_vpc.vpc1"
       - "aws_vpc.vpc2"
     poll: true
     poll_interval: 10
     poll_timeout: 30

2. 配置以下所需参数：

   • workspace_id 或 workspace + organization ： 将创建配置版本的工作区 ID 或工作区名称和组织，该文件将被上传（表示 state: present）。
   • run_id ： 要应用、取消或丢弃操作的目标的唯一标识符。
   • tf_token: Terraform API 身份验证令牌。如果没有设置这个值，则使用 TF_TOKEN 环境变量。

3. （可选）配置内置的轮询选项，以确定 Terraform Enterprise 或 HCP Terraform 操作的等待周期完成：

   • poll: true ：（默认）每 poll_interval 秒（默认为 5s）检查运行状态，直到达到 completion 或 poll_timeout (default: 25s)为止，返回最终状态。
   • poll: false : 在启动运行后立即返回，而不等待。
4. 根据需要设置其他 可选参数。

流程

1. 要防止针对 TFE 或 HCP Terraform 运行 playbook 时的错误，请在运行 playbook 前执行以下操作：

   1. 确认执行环境中的 Terraform 版本与 TFE 或 HCP Terraform 中声明的版本相同。

   2. 在 TFE 或 HCP Terraform 中执行初始化：

      terraform init

   3. 如果您在执行环境中有一个本地状态文件，请删除本地状态文件。
   4. 从 HCP Terraform 或 Terraform Enterprise 获取令牌，您将用来在后续步骤中创建凭证。确保令牌具有必要的权限，基于团队或用户令牌在 playbook 中执行所需的功能。
   5. 从 playbook 定义中删除后端配置文件和文件。

   6. 如果要在 TF 配置中的默认设置或环境变量中添加工作区，如果要定义在更新 playbook 本身外的工作空间。

      注意

      您可以将工作区添加到 playbook 中，以扩展工作空间利用率。

2. 在 Ansible Automation Platform 用户界面中：

   1. 创建凭据。
   2. 在 Ansible Automation Platform 中构建执行环境。
   3. 创建并启动作业模板。

3. （可选）在迁移完成后，您可以从执行环境中的集合运行额外的模块和插件：

   • plan Stash 模块
   • Terraform 模块
   • 输出插件
   • 输出查找插件
   • State 清单插件

流程

1. 在 5.2. tf 文件中定义 aap_job_launch 操作。

2. 添加生命周期作业块，以定义在正确的生命周期事件触发器期间调用哪些操作。

   示例

1. （必需）将本示例中的作业模板名称和清单名称改为您的对应变量。
2. （可选）您可以将所有者设置为 Red Hat RHEL 镜像 ID，以便每次作业运行时都会使用最新的镜像。
3. （可选）根据需要设置 附加参数。例如，您可以将 wait_for_completion 设置为 true，然后 Terraform 将等待到创建此作业并达到任何最终状态，然后再继续。您还可以设置 wait_for_completion_timeout_seconds 来控制超时限制。
4. 更新并提交 Terraform 代码。
5. 执行 Terraform 计划并应用它。

流程

1. 将 community.hashi_vault 模块 复制到以下 hashicorp.vault.kv1_secret_secret_info 参数。

     engine_mount_point:
       description: KV secrets engine mount point.
       default: secret
       type: str
       aliases: [secret_mount_path]
     path:
       description:
         - Specifies the path of the secret.
       required: true
       type: str
       aliases: [secret_path]
   extends_documentation_fragment:
     - hashicorp.vault.vault_auth.modules

2. （必需）配置 path 参数。这是 community.hashi_vault.hashi_vault 模块中 secret 的路径。alias: secret_path
3. 如果需要，配置 可选参数。

流程

1. 将 community.hashi_vault 模块复制到以下 hashicorp.vault.kv1_secret_get 参数。

   auth_method:
     description: Authentication method to use.
     choices: ['token', 'approle']
     default: token
     type: str
   engine_mount_point:
     description:
       - The KV secrets engine mount point.
     default: secret
     type: str
     aliases: ['mount_point', 'secret_mount_path']
   secret:
     description:
       - The Vault path to the secret being requested.
     required: true
     type: str
     aliases: ['secret_path']

2. （必需）配置 secret 参数。这会映射到 community.hashi_vault.hashi_vault 模块中的 secret。alias: secret_path
3. 如果需要，配置 可选参数。

流程

1. 将两个 community.hashi_vault 模块中的自动化任务复制到以下 hashicorp.vault.kv2_secret 参数。hashicorp.vault.kv2_secret 参数与 community.hashi_vault 类似。

   auth_method:
    description: Authentication method to use
    type: str
    choices: [token, approle]
    default: token
    required: false
   
   cas:
    description: Perform a check-and-set operation.
    type: int
    required: false
   
   data:
    description: KV2 secret data to write.
    type: dict
    required: true
   
   engine_mount_point:
    description: The path where the secret backend is mounted.
    type: str
    default: secret
    required: false
    aliases: [secret_mount_path]
   
   namespace:
    description: Vault namespace where secrets reside.
    type: str
    default: admin
    aliases: [vault_namespace]
   
   path:
    description: Vault KVv2 path to be written to.
    type: str
    required: true
    aliases: [secret_path]
   
   url:
    description: URL of the Vault service
    type: str
    aliases: [vault_address]
    required: true
   
   versions:
    description: One or more versions of the secret to delete.
    type: list of int
    required: false
   
   state:
    description: Desired state of the secret
    type: str
    choices: [present, absent]
    default: present

2. 您必须将 state 参数添加到 hashicorp.vault.kv2_secret 模块中，如上所示。有效选项有：

   • present ： 这等同于在 community.hashi_vault.vault_kv2 模块中创建或更新。
   • absent ： 这等同于在 community.hashi_vault.vault_kv2 模块 中删除 secret。

流程

1. 将 community.hashi_vault 模块复制到以下 hashicorp.vault.kv2_secret_info 参数。

     engine_mount_point:
       description: KV secrets engine mount point.
       default: secret
       type: str
       aliases: [secret_mount_path]
     path:
       description: Path to the secret.
       required: true
       type: str
       aliases: [secret_path]
     version:
       description: The version to retrieve.
       type: int
   extends_documentation_fragment:
     - hashicorp.vault.vault_auth.modules

2. 配置所需参数：

   • Path : secret 位于 community 中的路径。hashi_vault.hashi_vault 模块。alias: secret_path
   • URL :映射到 community.hashi_vault.hashi_vault 模块中的 url。使用与 vault_address 相同的别名。
3. 如果需要，配置 可选参数。

流程

1. 将 community.hashi_vault 模块复制到以下 hashicorp.vault.kv2_secret_get 参数。

   auth_method:
    description: Authentication method to use
    type: str
    choices: [token, approle]
    default: token
    required: false
   
   mount_point:
    description: Vault mount point
    type: str
    required: false
    aliases: [secret_mount_path]
   
   namespace:
    description: Vault namespace where secrets reside.
    type: str
    default: admin
    aliases: [vault_namespace]
   secret:
    description: Vault path to the secret being requested in the format path[:field]
    type: str
    required: true
    aliases: [secret_path]
   
   url:
    description: URL of the Vault service
    type: str
    aliases: [vault_address]
    required: true
   
   version:
    description: Specifies the version to return. If not set the latest is returned.
    type: int
    required: false

2. 使用以下指导来配置 hashicorp.vault.kv2_secret_get 参数：

   • auth_method: 映射与 community.hashi_vault.hashi_vault.hashi_vault 模块中的 auth_method 相同。
   • mount_point :映射到 community.hashi_vault.hashi_vault 模块中的 mount_point。别名： secret_mount_path。
   • Namespace :映射到 community.hashi_vault.hashi_vault 模块中的命名空间。别名： vault_namespace.
   • Secret :映射到 community.hashi_vault.hashi_vault 模块中的 secret。
   • URL :映射到 community.hashi_vault.hashi_vault 模块中的 url。使用与 vault_address 相同的别名。
   • Version : 映射到 community.hashi_vault.hashi_vault 模块中的 版本。