Ansible 社区文档

community.general.consul_session 模块 – 操作 Consul 会话

注意

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

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

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

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

概要 

允许在 Consul 集群中添加、修改和删除会话。然后，这些会话可以与键值对结合使用以实现分布式锁。有关使用会话的深入文档，请访问 http://www.consul.io/docs/internals/sessions.html

参数 

参数	注释
behavior 字符串	创建会话时可以附加的可选行为。这控制会话失效时的行为。选项 `"delete"` `"release"` ← (默认)
ca_path 字符串	用于 https 连接的 CA 证书包
checks 列表 / 元素=字符串	用于验证会话健康的检查。如果所有检查都失败，则会话将失效，并且与会话关联的任何锁都将被释放，并且在关联的锁延迟过期后可以再次获取。
datacenter 字符串	会话存在或应创建的数据中心的名称。
delay 整数	创建会话时可以附加的可选锁延迟。失效会话的锁将被阻止获取，直到此延迟过期。持续时间以秒为单位。默认值： `15`
host 字符串	Consul 代理的主机，默认为 `localhost`。默认值： `"localhost"`
id 字符串	会话的 ID，当 `state` 为 `info` 或 `remove` 时需要。
name 字符串	应与会话关联的名称。当使用 `state=node` 时需要。
node 字符串	将与会话关联的节点的名称。默认情况下，这是代理的名称。
port 整数	Consul 代理运行的端口。默认值： `8500`
scheme 字符串	Consul 代理运行的协议方案。默认为 `http`，可以设置为 `https` 以进行安全连接。默认值： `"http"`
state 字符串	会话是否存在，即如果会话不存在则创建，如果存在则删除。如果创建，则会话的 `id` 将返回到输出中。如果为 `absent`，则需要 `id` 来删除会话。可以通过为 `state` 指定 `info`、`node` 或 `list` 来检索单个会话的信息、节点的所有会话或所有可用会话；对于 `node` 或 `info`，需要节点 `name` 或会话 `id` 作为参数。选项 `"absent"` `"info"` `"list"` `"node"` `"present"` ← (默认)
token 字符串在 community.general 5.6.0 中添加	用于授权的令牌。
ttl 整数在 community.general 5.4.0 中添加	指定会话的持续时间（秒）（介于 10 到 86400 之间）。
validate_certs 布尔值	是否验证 Consul 代理的 TLS 证书。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: Register basic session with consul
  community.general.consul_session:
    name: session1

- name: Register a session with an existing check
  community.general.consul_session:
    name: session_with_check
    checks:
      - existing_check_name

- name: Register a session with lock_delay
  community.general.consul_session:
    name: session_with_delay
    delay: 20s

- name: Retrieve info about session by id
  community.general.consul_session:
    id: session_id
    state: info

- name: Retrieve active sessions
  community.general.consul_session:
    state: list

- name: Register session with a ttl
  community.general.consul_session:
    name: session-with-ttl
    ttl: 600  # sec

作者

Steve Gargan (@sgargan)
Håkon Lerring (@Hakon)

集合链接