community.general.consul_auth_method 模块 – 操作 Consul 认证方法

注意

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

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

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

要在 playbook 中使用它，请指定：community.general.consul_auth_method。

community.general 8.3.0 中的新增功能

概要 

允许通过代理在 consul 集群中添加、修改和删除认证方法。有关使用和配置 ACL 的更多详细信息，请参阅 https://www.consul.io/docs/guides/acl.html。

参数 

参数	注释
ca_path 字符串	用于 https 连接的 CA 包
config 字典	用于所选认证方法的原始配置。内容会因选择的类型而异。创建认证方法时是必需的。
description 字符串	认证方法的人类可读描述，自由形式。
display_name 字符串	在显示有关此认证方法的信息时，可以使用可选的名称来代替 `name`。
host 字符串	consul 代理的主机，默认为 `localhost`。默认值： `"localhost"`
max_token_ttl 字符串	这指定了由此认证方法创建的任何令牌的最大生命周期。可以以 `60s` 或 `5m` 的形式指定（即分别为 60 秒或 5 分钟）。
name 字符串 / 必需	指定 ACL 认证方法的名称。名称可以包含字母数字字符、破折号 `-` 和下划线 `_`。
port 整数	consul 代理正在运行的端口。默认值： `8500`
scheme 字符串	consul 代理正在运行的协议方案。默认为 `http`，并且可以设置为 `https` 用于安全连接。默认值： `"http"`
state 字符串	令牌应该是存在还是不存在。选项 `"present"` ← (默认) `"absent"`
token 字符串	用于授权的令牌。
token_locality 字符串	定义此认证方法应生成的令牌类型。选项 `"local"` `"global"`
type 字符串	正在配置的认证方法的类型。此字段是不可变的。创建认证方法时是必需的。选项 `"kubernetes"` `"jwt"` `"oidc"` `"aws-iam"`
validate_certs 布尔值	是否验证 consul 代理的 TLS 证书。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
action_group	操作组： community.general.consul	在 `module_defaults` 中使用 `group/community.general.consul` 为此模块设置默认值。
check_mode	支持：完整	可以在 `check_mode` 中运行，并返回更改状态预测，而无需修改目标。
diff_mode	支持：部分在检查模式下，差异将遗漏操作属性。	在差异模式下运行时，将返回已更改（或可能需要在 `check_mode` 中更改）的详细信息。

示例 

- name: Create an auth method
  community.general.consul_auth_method:
    name: test
    type: jwt
    config:
      jwt_validation_pubkeys:
        - |
          -----BEGIN PUBLIC KEY-----
          MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo
          4lgOEePzNm0tRgeLezV6ffAt0gunVTLw7onLRnrq0/IzW7yWR7QkrmBL7jTKEn5u
          +qKhbwKfBstIs+bMY2Zkp18gnTxKLxoS2tFczGkPLPgizskuemMghRniWaoLcyeh
          kd3qqGElvW/VDL5AaWTg0nLVkjRo9z+40RQzuVaE8AkAFmxZzow3x+VJYKdjykkJ
          0iT9wCS0DRTXu269V264Vf/3jvredZiKRkgwlL9xNAwxXFg0x/XFw005UWVRIkdg
          cKWTjpBP2dPwVZ4WWC+9aGVd+Gyn1o0CLelf4rEjGoXbAAEgAqeGUxrcIlbjXfbc
          mwIDAQAB
          -----END PUBLIC KEY-----
    token: "{{ consul_management_token }}"

- name: Delete auth method
  community.general.consul_auth_method:
    name: test
    state: absent
    token: "{{ consul_management_token }}"

返回值 

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

键

描述

auth_method

字典

consul HTTP API 返回的认证方法。

返回： 始终

示例： {"Config": {"JWTValidationPubkeys": ["-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAu1SU1LfVLPHCozMxH2Mo\n4lgOEePzNm0tRgeLezV6ffAt0gunVTLw7onLRnrq0/IzW7yWR7QkrmBL7jTKEn5u\n+qKhbwKfBstIs+bMY2Zkp18gnTxKLxoS2tFczGkPLPgizskuemMghRniWaoLcyeh\nkd3qqGElvW/VDL5AaWTg0nLVkjRo9z+40RQzuVaE8AkAFmxZzow3x+VJYKdjykkJ\n0iT9wCS0DRTXu269V264Vf/3jvredZiKRkgwlL9xNAwxXFg0x/XFw005UWVRIkdg\ncKWTjpBP2dPwVZ4WWC+9aGVd+Gyn1o0CLelf4rEjGoXbAAEgAqeGUxrcIlbjXfbc\nmwIDAQAB\n-----END PUBLIC KEY-----"]}, "CreateIndex": 416, "ModifyIndex": 487, "Name": "test", "Type": "jwt"}

operation

字符串

执行的操作。

返回： changed

示例： "update"

作者

Florian Apolloner (@apollo13)