Skip to content

Commit

Permalink
Add mention of sensu/sensu-go#1700 in assets reference docs
Browse files Browse the repository at this point in the history
Signed-off-by: Simon Plourde <simon@sensu.io>
  • Loading branch information
Simon Plourde committed Jun 20, 2018
1 parent 8a87acd commit 0f49b17
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions content/sensu-core/2.0/reference/assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,25 @@ cache. Asset dependencies are then injected into the `PATH` so they are
available when the command is executed. Subsequent check executions look for the
asset in local cache and ensure the contents match the checksum. An agent's
local cache can be set using the `--cache-dir` flag; it defaults to
`/var/cache/sensu/sensu-agent` (`C:\\ProgramData\sensu\cache\sensu-agent` on Windows systems).
If the requested asset is not in the local cache, it is downloaded from the asset url.
The Sensu backend does not currently provide any storage for assets; they are
expected to be retrieved over HTTP or HTTPS.
`/var/cache/sensu/sensu-agent` (`C:\\ProgramData\sensu\cache\sensu-agent` on
Windows systems). If the requested asset is not in the local cache, it is
downloaded from the asset url. The Sensu backend does not currently provide any
storage for assets; they are expected to be retrieved over HTTP or HTTPS.

The agent expects that an asset is a `TAR` archive that may optionally be GZip'd.
Any scripts or executables should be within a `bin/` folder within in the archive.
The agent expects that an asset is a `TAR` archive that may optionally be
GZip'd. Any scripts or executables should be within a `bin/` folder within in
the archive.

The following are injected into the execution context:

- `{PATH_TO_ASSET}/bin` is injected into the `PATH` environment variable.
- `{PATH_TO_ASSET}/lib` is injected into the `LD_LIBRARY_PATH` environment variable.
- `{PATH_TO_ASSET}/lib` is injected into the `LD_LIBRARY_PATH` environment
variable.
- `{PATH_TO_ASSET}/include` is injected into the `CPATH` environment variable.

**N.B.** GitHub source code archives [can't currently be used][2] as Sensu
assets archives.

## Assets specification

### Attributes
Expand Down Expand Up @@ -101,3 +106,4 @@ example | {{< highlight shell >}}
{{</ highlight >}}

[1]: ../../reference/filters/
[2]: /~https://github.com/mholt/archiver/issues/27

0 comments on commit 0f49b17

Please sign in to comment.