Resource Type: archive

Defined in:

lib/puppet/type/archive.rb

Providers:

curl
ruby
wget

Overview

Manage archive file download, extraction, and cleanup.

Properties

• creates

  if file/directory exists, will not download/extract archive.

• ensure (defaults to: present)

  whether archive file should be present/absent (default: present)

  Supported values:

  • present
  • absent

Parameters

• allow_insecure (defaults to: false)

  ignore HTTPS certificate errors

  Supported values:

  • true
  • false
  • yes
  • no
• checksum

  archive file checksum (match checksum_type).

  Supported values:

  • %r{\b[0-9a-f]{5,128}\b}
  • true
  • false
  • undef
  • nil
  • ''
• checksum_type (defaults to: none)

  archive file checksum type (none|md5|sha1|sha2|sha256|sha384|sha512).

  Supported values:

  • none
  • md5
  • sha1
  • sha2
  • sha256
  • sha384
  • sha512
• checksum_url

  archive file checksum source (instead of specifying checksum)

• checksum_verify (defaults to: true)

  whether checksum wil be verified (true|false).

  Supported values:

  • true
  • false
• cleanup (defaults to: true)

  whether archive file will be removed after extraction (true|false).

  Supported values:

  • true
  • false
• cookie

  archive file download cookie.

• digest_string

  archive file checksum (match checksum_type) (this parameter is for camptocamp/archive compatibility).

  Supported values:

  • %r{\b[0-9a-f]{5,128}\b}
• digest_type

  archive file checksum type (none|md5|sha1|sha2|sha256|sha384|sha512) (this parameter is camptocamp/archive compatibility).

  Supported values:

  • none
  • md5
  • sha1
  • sha2
  • sha256
  • sha384
  • sha512
• digest_url

  archive file checksum source (instead of specifying checksum) (this parameter is for camptocamp/archive compatibility)

• download_options

  provider download options (affects curl, wget, gs, and only s3 downloads for ruby provider)

• extract (defaults to: false)

  whether archive will be extracted after download (true|false).

  Supported values:

  • true
  • false
• extract_command

  custom extraction command (‘tar xvf example.tar.gz’), also support sprintf format (‘tar xvf %s’) which will be processed with the filename: sprintf(‘tar xvf %s’, filename)

• extract_flags (defaults to: undef)

  custom extraction options, this replaces the default flags. A string such as ‘xvf’ for a tar file would replace the default xf flag. A hash is useful when custom flags are needed for different platforms. => ‘xzf’, ‘7z’ => ‘x -aot’.

• extract_path

  target folder path to extract archive.

• filename

  archive file name (derived from path).

• group

  extract command group (using this option will configure the archive file permisison to 0644 so the user can read the file).

• headers

  optional header(s) to pass.

• password

  password to download source file.

• path

  namevar, archive file fully qualified file path.

• provider

  The specific backend to use for this ‘archive` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

• proxy_server

  proxy address to use when accessing source

• proxy_type

  proxy type (none|ftp|http|https)

  Supported values:

  • none
  • ftp
  • http
  • https
• source

  archive file source, supports puppet|http|https|ftp|file|s3|gs uri.

• target

  target folder path to extract archive. (this parameter is for camptocamp/archive compatibility)

• temp_dir

  Specify an alternative temporary directory to use for copying files, if unset then the operating system default will be used.

• url

  archive file source, supports http|https|ftp|file uri. (for camptocamp/archive compatibility)

• user

  extract command user (using this option will configure the archive file permission to 0644 so the user can read the file).

• username

  username to download source file.