archive

A tar or zip file on the host, unpacked into a directory unless its creates path exists. Removing it leaves the files.

step "example" {
  archive {
    creates = "..."
    dest = "..."
    src = "..."
  }
}

Arguments

Name	Type	Required	Description
creates	string	Yes	A path the archive creates. While it exists, nothing is unpacked.
dest	string	Yes	Directory to unpack into.
src	string	Yes	Absolute path of the archive on the host, such as a download’s dest.

Read-only attributes

Conn3x sets these; reference them as conn3x_archive.<circuit>__<step>["<host>"].<name>.

Name	Type	Description
in_sync	bool	Whether the creates path exists.

A step lowers to the conn3x_archive resource, one instance per host, and connects with its circuit’s ssh block.