diff --git a/provider-dev/docgen/provider-data/headerContent2.txt b/provider-dev/docgen/provider-data/headerContent2.txt index ff9e602..df0e4fc 100644 --- a/provider-dev/docgen/provider-data/headerContent2.txt +++ b/provider-dev/docgen/provider-data/headerContent2.txt @@ -90,7 +90,11 @@ SELECT id, name, category FROM sumologic.collectors.collectors WHERE filter = 'h SELECT json_extract(item, '$.name') AS name, path FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Users and roles +## Example Queries + +Try the following queries using `stackql shell`, or run them from a script or CI pipeline with `stackql exec`. + +### Users and roles Users with their state and role assignment: @@ -108,7 +112,7 @@ SELECT id, name, description, system_defined, json_array_length(capabilities) AS FROM sumologic.roles.roles; ``` -## Collectors and sources +### Collectors and sources The collector estate - type, liveness and version: @@ -134,7 +138,7 @@ FROM sumologic.collectors.offline_collectors WHERE alive_before_days = 30; ``` -## Content library, monitors and dashboards +### Content library, monitors and dashboards The personal folder and its children: @@ -161,7 +165,7 @@ FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Data tiers, partitions and budgets +### Data tiers, partitions and budgets Partitions with tier and retention: @@ -178,7 +182,7 @@ SELECT id, name, capacity_bytes, usage_bytes, usage_status, action, reset_time, FROM sumologic.ingest_budgets.ingest_budgets; ``` -## Provision, mutate and tear down +### Provision, mutate and tear down Mutations use the same SQL grammar - `INSERT` creates a resource, `UPDATE` replaces it (Sumo Logic updates are `PUT`s, so supply every required field), `EXEC` invokes lifecycle actions and `DELETE` removes it. Structured values (arrays, objects) are passed as JSON strings, and booleans are quoted (`is_active = 'false'`) - a bare `true` / `false` on the right-hand side of `SET` is not accepted. A hosted collector with an HTTP source end to end (the Collector Management API wraps its bodies in `collector` / `source` objects, passed as JSON values): @@ -222,7 +226,7 @@ SET first_name = 'Ada', last_name = 'Lovelace', is_active = 'false', role_ids = WHERE id = '000000000000ABCD'; ``` -## Lifecycle operations +### Lifecycle operations State transitions are `EXEC` methods on the resource they act on, addressed with the wire-cased parameter names: diff --git a/website/docs/index.md b/website/docs/index.md index c00de71..bcf37bc 100644 --- a/website/docs/index.md +++ b/website/docs/index.md @@ -120,7 +120,11 @@ SELECT id, name, category FROM sumologic.collectors.collectors WHERE filter = 'h SELECT json_extract(item, '$.name') AS name, path FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Users and roles +## Example Queries + +Try the following queries using `stackql shell`, or run them from a script or CI pipeline with `stackql exec`. + +### Users and roles Users with their state and role assignment: @@ -138,7 +142,7 @@ SELECT id, name, description, system_defined, json_array_length(capabilities) AS FROM sumologic.roles.roles; ``` -## Collectors and sources +### Collectors and sources The collector estate - type, liveness and version: @@ -164,7 +168,7 @@ FROM sumologic.collectors.offline_collectors WHERE alive_before_days = 30; ``` -## Content library, monitors and dashboards +### Content library, monitors and dashboards The personal folder and its children: @@ -191,7 +195,7 @@ FROM sumologic.monitors.search WHERE query = 'type:monitor'; ``` -## Data tiers, partitions and budgets +### Data tiers, partitions and budgets Partitions with tier and retention: @@ -208,7 +212,7 @@ SELECT id, name, capacity_bytes, usage_bytes, usage_status, action, reset_time, FROM sumologic.ingest_budgets.ingest_budgets; ``` -## Provision, mutate and tear down +### Provision, mutate and tear down Mutations use the same SQL grammar - `INSERT` creates a resource, `UPDATE` replaces it (Sumo Logic updates are `PUT`s, so supply every required field), `EXEC` invokes lifecycle actions and `DELETE` removes it. Structured values (arrays, objects) are passed as JSON strings, and booleans are quoted (`is_active = 'false'`) - a bare `true` / `false` on the right-hand side of `SET` is not accepted. A hosted collector with an HTTP source end to end (the Collector Management API wraps its bodies in `collector` / `source` objects, passed as JSON values): @@ -252,7 +256,7 @@ SET first_name = 'Ada', last_name = 'Lovelace', is_active = 'false', role_ids = WHERE id = '000000000000ABCD'; ``` -## Lifecycle operations +### Lifecycle operations State transitions are `EXEC` methods on the resource they act on, addressed with the wire-cased parameter names: diff --git a/website/static/favicon-16x16.png b/website/static/favicon-16x16.png new file mode 100644 index 0000000..178c107 Binary files /dev/null and b/website/static/favicon-16x16.png differ diff --git a/website/static/favicon-32x32.png b/website/static/favicon-32x32.png new file mode 100644 index 0000000..f1efee0 Binary files /dev/null and b/website/static/favicon-32x32.png differ diff --git a/website/static/favicon.ico b/website/static/favicon.ico new file mode 100644 index 0000000..0145fbf Binary files /dev/null and b/website/static/favicon.ico differ