From 4530fe2bb949df5af2a999d1bde6fbddffce6a2f Mon Sep 17 00:00:00 2001 From: Nikki Attea Date: Thu, 16 Aug 2018 08:21:01 -0700 Subject: [PATCH 1/2] Remove note about asset tarballs, the bug has been fixed in sensu-go Signed-off-by: Nikki Attea --- content/sensu-core/2.0/reference/assets.md | 58 ++++++++++------------ 1 file changed, 27 insertions(+), 31 deletions(-) diff --git a/content/sensu-core/2.0/reference/assets.md b/content/sensu-core/2.0/reference/assets.md index 8a8b52e189..b72dd4ef7e 100644 --- a/content/sensu-core/2.0/reference/assets.md +++ b/content/sensu-core/2.0/reference/assets.md @@ -5,7 +5,7 @@ description: "The assets reference guide." weight: 1 version: "2.0" product: "Sensu Core" -platformContent: false +platformContent: false menu: sensu-core-2.0: parent: reference @@ -33,58 +33,55 @@ The following are injected into the execution context: 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 -name | --------------|------ +name | +-------------|------ description | The unique name of the asset, validated with go regex [`\A[\w\.\-]+\z`](https://regex101.com/r/zo9mQU/2) required | true -type | String +type | String example | {{< highlight shell >}}"name": "check_script"{{}} -url | --------------|------ -description | The URL location of the asset. +url | +-------------|------ +description | The URL location of the asset. required | true -type | String +type | String example | {{< highlight shell >}}"url": "http://example.com/asset.tar.gz"{{}} -sha512 | --------------|------ -description | The checksum of the asset. +sha512 | +-------------|------ +description | The checksum of the asset. required | true -type | String +type | String example | {{< highlight shell >}}"sha512": "4f926bf4328..."{{}} -metadata | --------------|------ -description | Information about the asset, in the form of key value pairs. -required | false -type | Map +metadata | +-------------|------ +description | Information about the asset, in the form of key value pairs. +required | false +type | Map example | {{< highlight shell >}}"metadata": { -"Content-Type": "application/zip", +"Content-Type": "application/zip", "X-Intended-Distribution": "trusty-14"} {{}} -filters | --------------|------ -description | A set of [filters][1] used by the agent to determine of the asset should be installed. -required | false -type | Array +filters | +-------------|------ +description | A set of [filters][1] used by the agent to determine of the asset should be installed. +required | false +type | Array example | {{< highlight shell >}}"filters": ["System.OS=='linux'", "System.Arch=='amd64'"] {{}} -organization | --------------|------ +organization | +-------------|------ description | The Sensu RBAC organization that this asset belongs to. -required | false +required | false type | String -default | current organization value configured for `sensuctl` (ie `default`) +default | current organization value configured for `sensuctl` (ie `default`) example | {{< highlight shell >}} "organization": "default" {{}} @@ -106,4 +103,3 @@ example | {{< highlight shell >}} {{}} [1]: ../../reference/filters/ -[2]: /~https://github.com/mholt/archiver/issues/27 From 27703f1d67b33fe0c19c670f6919b59174068e40 Mon Sep 17 00:00:00 2001 From: Nikki Attea Date: Thu, 16 Aug 2018 13:57:38 -0700 Subject: [PATCH 2/2] Don't mess up spacing! Signed-off-by: Nikki Attea --- content/sensu-core/2.0/reference/assets.md | 54 +++++++++++----------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/content/sensu-core/2.0/reference/assets.md b/content/sensu-core/2.0/reference/assets.md index b72dd4ef7e..1af0291ce4 100644 --- a/content/sensu-core/2.0/reference/assets.md +++ b/content/sensu-core/2.0/reference/assets.md @@ -5,7 +5,7 @@ description: "The assets reference guide." weight: 1 version: "2.0" product: "Sensu Core" -platformContent: false +platformContent: false menu: sensu-core-2.0: parent: reference @@ -37,51 +37,51 @@ The following are injected into the execution context: ### Attributes -name | --------------|------ +name | +-------------|------ description | The unique name of the asset, validated with go regex [`\A[\w\.\-]+\z`](https://regex101.com/r/zo9mQU/2) required | true -type | String +type | String example | {{< highlight shell >}}"name": "check_script"{{}} -url | --------------|------ -description | The URL location of the asset. +url | +-------------|------ +description | The URL location of the asset. required | true -type | String +type | String example | {{< highlight shell >}}"url": "http://example.com/asset.tar.gz"{{}} -sha512 | --------------|------ -description | The checksum of the asset. +sha512 | +-------------|------ +description | The checksum of the asset. required | true -type | String +type | String example | {{< highlight shell >}}"sha512": "4f926bf4328..."{{}} -metadata | --------------|------ -description | Information about the asset, in the form of key value pairs. -required | false -type | Map +metadata | +-------------|------ +description | Information about the asset, in the form of key value pairs. +required | false +type | Map example | {{< highlight shell >}}"metadata": { -"Content-Type": "application/zip", +"Content-Type": "application/zip", "X-Intended-Distribution": "trusty-14"} {{}} -filters | --------------|------ -description | A set of [filters][1] used by the agent to determine of the asset should be installed. -required | false -type | Array +filters | +-------------|------ +description | A set of [filters][1] used by the agent to determine of the asset should be installed. +required | false +type | Array example | {{< highlight shell >}}"filters": ["System.OS=='linux'", "System.Arch=='amd64'"] {{}} -organization | --------------|------ +organization | +-------------|------ description | The Sensu RBAC organization that this asset belongs to. -required | false +required | false type | String -default | current organization value configured for `sensuctl` (ie `default`) +default | current organization value configured for `sensuctl` (ie `default`) example | {{< highlight shell >}} "organization": "default" {{}}