community.general.maven_artifact 模块 – 从 Maven 仓库下载构件

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参见需求。

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

概要 

根据提供给模块的 Maven 坐标从 Maven 仓库下载构件。
可以检索构件的快照或发布版本，如果找不到可用版本，将解析最新可用版本。

需求 

执行此模块的主机需要以下需求。

lxml
如果使用 S3 仓库 (s3://...)，则需要 boto

参数 

参数	注释
artifact_id 字符串 / 必填	Maven artifactId 坐标。
属性别名：attr 字符串	生成的系统文件对象应具有的属性。要获取支持的标志，请查看目标系统上 chattr 的手册页。此字符串应按 lsattr 显示的顺序包含属性。默认情况下假定使用 `=` 运算符，否则需要在字符串中包含 `+` 或 `-` 运算符。
checksum_alg 字符串在 community.general 3.2.0 中添加	如果为 `md5`，则校验和将使用 MD5 算法。这是默认值。如果为 `sha1`，则校验和将使用 SHA1 算法。这可以在配置为使用符合 FIPS 的算法的系统上使用，因为在这些系统上 MD5 将被阻止。选项 `"md5"` ← (默认) `"sha1"`
classifier 字符串	Maven classifier 坐标。默认值： `""`
client_cert 路径在 community.general 1.3.0 中添加	用于 SSL 客户端身份验证的 PEM 格式证书链文件。此文件也可以包含密钥，如果包含密钥，则不需要 `client_key`。
client_key 路径在 community.general 1.3.0 中添加	包含用于 SSL 客户端身份验证的私钥的 PEM 格式文件。如果 `client_cert` 包含证书和密钥，则不需要此选项。
dest 路径 / 必填	应将构件写入到的路径。如果指定了文件模式或所有权并且目标路径已存在，则它们会影响下载的文件。
directory_mode 字符串	递归应用于 `dest` 的文件系统权限模式，前提是它是一个目录。
extension 字符串	Maven 类型/扩展名坐标。默认值： `"jar"`
force_basic_auth 布尔值在 community.general 0.2.0 中添加	uri 模块使用的库 httplib2 只在 Web 服务以 401 状态响应初始请求时发送身份验证信息。由于某些基本身份验证服务没有正确发送 401，因此登录将失败。此选项强制在初始请求时发送基本身份验证标头。选项 `false` ← (默认) `true`
group 字符串	应该拥有文件系统对象的组的名称，如同提供给chown命令。如果未指定，则使用当前用户的当前组，除非您是root用户，在这种情况下，它可以保留之前的拥有者。
group_id 字符串 / 必填	Maven groupId 坐标。
headers 字典	以哈希/字典格式向请求添加自定义 HTTP 头。
keep_name 布尔值	如果 `true`，则保留下载的构件的名称，即版本号仍然是其一部分。此选项仅在`dest` 是目录并且 `version` 设置为 `latest` 或 `version_by_spec` 已定义时有效。选项 `false` ← (默认) `true`
mode 任意	生成的文件系统对象应具有的权限。对于习惯使用/usr/bin/chmod的用户，请记住模式实际上是八进制数。您必须向 Ansible 提供足够的信息才能正确解析它们。为了获得一致的结果，请引用八进制数（例如，`'644'` 或 `'1777'`），以便 Ansible 接收字符串并可以自行将字符串转换为数字。添加前导零（例如，`0755`）有时有效，但在循环和其他一些情况下可能会失败。如果不遵循上述任何规则而向 Ansible 提供数字，则最终将得到一个十进制数，这将产生意外的结果。从 Ansible 1.8 开始，模式可以指定为符号模式（例如，`u+rwx` 或 `u=rw,g=r,o=r`）。如果未指定`mode` 并且目标文件系统对象不存在，则在设置新创建的文件系统对象的模式时，将使用系统上的默认`umask`。如果未指定`mode` 并且目标文件系统对象存在，则将使用现有文件系统对象的模式。指定`mode` 是确保以正确的权限创建文件系统对象的最佳方法。有关更多详细信息，请参阅 CVE-2020-1736。
owner 字符串	应该拥有文件系统对象的用户的名称，如同提供给chown命令。如果未指定，则使用当前用户，除非您是root用户，在这种情况下，它可以保留之前的拥有者。指定数字用户名将被假定为用户 ID 而不是用户名。避免使用数字用户名以避免此混淆。
password 别名：aws_secret_access_key 字符串	用于向 Maven 存储库进行身份验证的密码。如果存储库托管在 S3 上，则使用 AWS 密钥访问密钥。
repository_url 字符串	要从中下载的 Maven 存储库的 URL。如果存储库托管在 Amazon S3 上，请使用 `s3://...`。如果存储库是本地的，请使用 `file://...`。默认值： `"https://repo1.maven.org/maven2"`
selevel 字符串	SELinux 文件系统对象上下文中的级别部分。这是 MLS/MCS 属性，有时称为`range`。如果设置为`_default`，则如果可用，它将使用策略的`level`部分。
serole 字符串	SELinux 文件系统对象上下文中的角色部分。如果设置为`_default`，则如果可用，它将使用策略的`role`部分。
setype 字符串	SELinux 文件系统对象上下文中的类型部分。如果设置为`_default`，则如果可用，它将使用策略的`type`部分。
seuser 字符串	SELinux 文件系统对象上下文中的用户部分。默认情况下，它使用`system`策略（如果适用）。如果设置为`_default`，则如果可用，它将使用策略的`user`部分。
state 字符串	构件的所需状态。选项 `"present"` ← (默认) `"absent"`
timeout 整数	指定连接尝试的超时时间（以秒为单位）。默认值： `10`
unredirected_headers 列表 / 元素=字符串在 community.general 5.2.0 中添加	不应包含在重定向中的标头列表。这些标头将发送到`fetch_url`函数。在 ansible-core 2.12 或更高版本上，此选项的默认值为`[Authorization, Cookie]`。如果重定向 URL 不需要请求中包含敏感标头，则很有用。需要 ansible-core 2.12 或更高版本。
unsafe_writes 布尔值	影响何时使用原子操作来防止数据损坏或目标文件系统对象的不一致读取。默认情况下，此模块使用原子操作来防止数据损坏或目标文件系统对象的不一致读取，但有时系统会以阻止此操作的方式进行配置或损坏。一个例子是 docker 挂载的文件系统对象，不能从容器内部以原子方式更新，只能以不安全的方式写入。此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全的写入）。重要！不安全的写入容易出现竞争条件，并可能导致数据损坏。选项 `false` ← (默认) `true`
username 别名：aws_secret_key 字符串	用于向 Maven 存储库进行身份验证的用户名。如果存储库托管在 S3 上，则使用 AWS 密钥。
validate_certs 布尔值	如果 `false`，则不会验证 SSL 证书。只有在没有其他选项的情况下，才应将其设置为 `false`。选项 `false` `true` ← (默认)
verify_checksum 字符串	如果 `never`，则永远不会下载和验证 MD5/SHA1 校验和。如果 `download`，则仅在构件下载后下载和验证 MD5/SHA1 校验和。这是默认值。如果 `change`，如果目标已存在，则将下载和验证 MD5/SHA1 校验和，以验证它们是否相同。这是 2.6 之前的行为。因为它在（可能）下载构件之前下载校验和，并且一些存储库软件在充当代理/缓存时，如果构件尚未被缓存，则返回 404 错误，因此它可能会意外失败。如果您仍然需要它，您应该考虑使用`always`代替 - 如果您处理校验和，最好在下载后使用它来验证完整性。 `always` 组合了 `download` 和 `change`。选项 `"never"` `"download"` ← (默认) `"change"` `"always"`
version 字符串	maven 版本坐标。与 `version_by_spec` 互斥。
version_by_spec 字符串在 community.general 0.2.0 中添加	maven 依赖版本范围。请参阅 https://cwiki.apache.org/confluence/display/MAVENOLD/Dependency+Mediation+and+Conflict+Resolution 上支持的版本范围不支持范围类型 `(,1.0],[1.2,)` 和 `(,1.1),(1.1,)`。与 `version` 互斥。

属性 

属性	支持	描述
check_mode	支持：不支持	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	在差异模式下，将返回有关已更改内容（或可能需要在 `check_mode` 中更改的内容）的详细信息。

示例 

- name: Download the latest version of the JUnit framework artifact from Maven Central
  community.general.maven_artifact:
    group_id: junit
    artifact_id: junit
    dest: /tmp/junit-latest.jar

- name: Download JUnit 4.11 from Maven Central
  community.general.maven_artifact:
    group_id: junit
    artifact_id: junit
    version: 4.11
    dest: /tmp/junit-4.11.jar

- name: Download an artifact from a private repository requiring authentication
  community.general.maven_artifact:
    group_id: com.company
    artifact_id: library-name
    repository_url: 'https://repo.company.com/maven'
    username: user
    password: pass
    dest: /tmp/library-name-latest.jar

- name: Download an artifact from a private repository requiring certificate authentication
  community.general.maven_artifact:
    group_id: com.company
    artifact_id: library-name
    repository_url: 'https://repo.company.com/maven'
    client_cert: /path/to/cert.pem
    client_key: /path/to/key.pem
    dest: /tmp/library-name-latest.jar

- name: Download a WAR File to the Tomcat webapps directory to be deployed
  community.general.maven_artifact:
    group_id: com.company
    artifact_id: web-app
    extension: war
    repository_url: 'https://repo.company.com/maven'
    dest: /var/lib/tomcat7/webapps/web-app.war

- name: Keep a downloaded artifact's name, i.e. retain the version
  community.general.maven_artifact:
    version: latest
    artifact_id: spring-core
    group_id: org.springframework
    dest: /tmp/
    keep_name: true

- name: Download the latest version of the JUnit framework artifact from Maven local
  community.general.maven_artifact:
    group_id: junit
    artifact_id: junit
    dest: /tmp/junit-latest.jar
    repository_url: "file://{{ lookup('env','HOME') }}/.m2/repository"

- name: Download the latest version between 3.8 and 4.0 (exclusive) of the JUnit framework artifact from Maven Central
  community.general.maven_artifact:
    group_id: junit
    artifact_id: junit
    version_by_spec: "[3.8,4.0)"
    dest: /tmp/

作者

Chris Schmidt (@chrisisbeef)