Skip to content

initial draft app docs #90

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft

initial draft app docs #90

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3a1f3cf
initial draft app docs
ripienaar May 11, 2022
ce0200e
update for latest schema
ripienaar May 12, 2022
f4a6bd9
minor tweaks
ripienaar May 12, 2022
16d3628
update for recent additions
ripienaar May 14, 2022
7e5b7c9
document functions, document filter options merge
ripienaar May 15, 2022
6663060
document the discovery command type
ripienaar May 16, 2022
f46442b
document rpc transforms
ripienaar May 17, 2022
c8acfb0
(#1665) move filter to a more appropriate place
ripienaar May 17, 2022
cafcec4
document semver in compound filters
ripienaar May 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions docs/content/concepts/discovery/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,19 +182,20 @@ $ choria discovery -S '(with("customer=acme") && with("environment=staging")) ||

Within the expressions we have defined some variables:

|Variable|Description|
|--------|-----------|
|`agents`|List of known agents|
|`classes`|List of classes this machine belongs to|
|`facts`|Facts for the machine as raw JSON|
| Variable | Description |
|-----------|-----------------------------------------|
| `agents` | List of known agents |
| `classes` | List of classes this machine belongs to |
| `facts` | Facts for the machine as raw JSON |

And we made a few functions available:

|Function|Description|
|--------|-----------|
|`with` |Equivalent of a `-W` filter - class and fact matches combined with regular expression support|
|`fact` |Retrieves a fact from the nested fact data using [GJSON path syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md)|
|`include`|Checks if an array includes a specific element|
| Function | Description |
|-----------|------------------------------------------------------------------------------------------------------------------------------|
| `with` | Equivalent of a `-W` filter - class and fact matches combined with regular expression support |
| `fact` | Retrieves a fact from the nested fact data using [GJSON path syntax](https://github.com/tidwall/gjson/blob/master/SYNTAX.md) |
| `include` | Checks if an array includes a specific element |
| `semver` | Performs semver version matching (since 0.26.0) |

We can go really deep as here:

Expand All @@ -204,7 +205,8 @@ with('apache') and # class or agent 'apache'
with('fnumber=1.2') and # fact fnumber with a float value equals 1.2
fact('nested.string') matches('h.llo') and # lookup a fact 'nested.string' and regex match it with 'h.llo'
include(fact('sarray'), '1') and # check if the 'sarray' fact - a array of strings - include a value '1'
include(fact('iarray'), 1) # check if the 'iarray' fact - a array of ints - include a value 1
include(fact('iarray'), 1) and # check if the 'iarray' fact - a array of ints - include a value 1
semver(fact('facterversion'), '>= 4.0.0') # matches the version of facter to
```

Here the *include* command is a basic function to check if an array contains something and *fact()* just looks up a fact using GJSON.
Expand Down
Loading