Skip to content

Commit 4216973

Browse files
author
Marco Franceschi
committed
chore: Updated policy packs query examples
1 parent 50ad864 commit 4216973

File tree

1 file changed

+79
-56
lines changed

1 file changed

+79
-56
lines changed

‎README.md

Lines changed: 79 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@
1111

1212
CloudGraph is the free open-source universal **GraphQL API and Cloud Security Posture Management (CSPM) tool for AWS, Azure, GCP, and K8s**. With CloudGraph you get:
1313

14-
- Free and effortless *compliance checks* (i.e. CIS 1.2)
15-
- *Type-Safe asset inventories* for all of your resources in all of your cloud environments
14+
- Free and effortless _compliance checks_ (i.e. CIS 1.2)
15+
- _Type-Safe asset inventories_ for all of your resources in all of your cloud environments
1616
- Automatically generated documentation and query validation - know if your query is valid before you send it!
17-
- Full resource data including *relationships* between resources so you can understand context
17+
- Full resource data including _relationships_ between resources so you can understand context
1818
- Historical snapshots of your data over time
1919
- A single endpoint to query all of your cloud data at once (i.e. get AWS + GCP data in the same query, or compare AWS stage with AWS prod)
2020
- Enhanced billing data (AWS only)
@@ -51,24 +51,25 @@ Cloud Graph lets you **Know your cloud** in 5 minutes. Built and maintained with
5151
![Twitter Follow](https://img.shields.io/twitter/follow/AutoCloudDev?style=social)
5252

5353
<!-- toc -->
54-
* [Amazing companies using CloudGraph\*\*](#amazing-companies-using-cloudgraph)
55-
* [Why CloudGraph](#why-cloudgraph)
56-
* [How It Works](#how-it-works)
57-
* [Authentication and Permissions](#authentication-and-permissions)
58-
* [Install](#install)
59-
* [Currently we support AWS CIS 1.2, GCP CIS 1.2, and Azure CIS 1.3.1 but more (pci, NIST, K8S NSA_CISA) are coming soon.](#currently-we-support-aws-cis-12-gcp-cis-12-and-azure-cis-131-but-more-pci-nist-k8s-nsa_cisa-are-coming-soon)
60-
* [Quick Start](#quick-start)
61-
* [Loading Previous Versions](#loading-previous-versions)
62-
* [Supported Services](#supported-services)
63-
* [Example Queries](#example-queries)
64-
* [Query Tools](#query-tools)
65-
* [Community](#community)
66-
* [Contribution Guidelines](#contribution-guidelines)
67-
* [Deployment Options](#deployment-options)
68-
* [Hosted Version](#hosted-version)
69-
* [Debugging](#debugging)
70-
* [Common Errors](#common-errors)
71-
* [Commands](#commands)
54+
55+
- [Amazing companies using CloudGraph\*\*](#amazing-companies-using-cloudgraph)
56+
- [Why CloudGraph](#why-cloudgraph)
57+
- [How It Works](#how-it-works)
58+
- [Authentication and Permissions](#authentication-and-permissions)
59+
- [Install](#install)
60+
- [Currently we support AWS CIS 1.2, GCP CIS 1.2, and Azure CIS 1.3.1 but more (pci, NIST, K8S NSA_CISA) are coming soon.](#currently-we-support-aws-cis-12-gcp-cis-12-and-azure-cis-131-but-more-pci-nist-k8s-nsa_cisa-are-coming-soon)
61+
- [Quick Start](#quick-start)
62+
- [Loading Previous Versions](#loading-previous-versions)
63+
- [Supported Services](#supported-services)
64+
- [Example Queries](#example-queries)
65+
- [Query Tools](#query-tools)
66+
- [Community](#community)
67+
- [Contribution Guidelines](#contribution-guidelines)
68+
- [Deployment Options](#deployment-options)
69+
- [Hosted Version](#hosted-version)
70+
- [Debugging](#debugging)
71+
- [Common Errors](#common-errors)
72+
- [Commands](#commands)
7273
<!-- tocstop -->
7374

7475
<br />
@@ -615,10 +616,14 @@ Use the CloudGraph Policy Pack for AWS CIS 1.2 to query all of your CIS findings
615616
```graphql
616617
query {
617618
queryawsCISFindings {
618-
ruleId
619-
description
619+
id
620+
resourceId
620621
result
621-
severity
622+
rule {
623+
id
624+
description
625+
severity
626+
}
622627
}
623628
}
624629
```
@@ -631,16 +636,24 @@ If you want to query several different compliance findings for a given provider
631636
query {
632637
queryawsFindings {
633638
CISFindings {
634-
severity
635-
description
636-
ruleId
639+
id
640+
resourceId
637641
result
642+
rule {
643+
id
644+
description
645+
severity
646+
}
638647
}
639648
AutoCloudFindings {
640-
severity
641-
description
642-
ruleId
649+
id
650+
resourceId
643651
result
652+
rule {
653+
id
654+
description
655+
severity
656+
}
644657
}
645658
}
646659
}
@@ -653,10 +666,14 @@ For each CIS rule, get the resources that the rule is associated with, in this c
653666
```graphql
654667
query {
655668
queryawsCISFindings {
656-
ruleId
657-
description
669+
id
670+
resourceId
658671
result
659-
severity
672+
rule {
673+
id
674+
description
675+
severity
676+
}
660677
iamUser {
661678
id
662679
arn
@@ -675,10 +692,14 @@ query {
675692
getawsIamUser(id: "123456789") {
676693
name
677694
CISFindings {
678-
severity
679-
description
680-
ruleId
695+
id
696+
resourceId
681697
result
698+
rule {
699+
id
700+
description
701+
severity
702+
}
682703
}
683704
}
684705
}
@@ -1350,26 +1371,27 @@ There are some common errors you may see when running CloudGraph that are usuall
13501371
# Commands
13511372

13521373
<!-- commands -->
1353-
* [`cg help [COMMAND]`](#cg-help-command)
1354-
* [`cg init [PROVIDER]`](#cg-init-provider)
1355-
* [`cg launch [PROVIDER]`](#cg-launch-provider)
1356-
* [`cg load [PROVIDER]`](#cg-load-provider)
1357-
* [`cg policy [PROVIDER]`](#cg-policy-provider)
1358-
* [`cg policy:add [PROVIDER]`](#cg-policyadd-provider)
1359-
* [`cg policy:install [PROVIDER]`](#cg-policyinstall-provider)
1360-
* [`cg policy:list [PROVIDER]`](#cg-policylist-provider)
1361-
* [`cg policy:remove [PROVIDER]`](#cg-policyremove-provider)
1362-
* [`cg policy:update [PROVIDER]`](#cg-policyupdate-provider)
1363-
* [`cg provider [PROVIDER]`](#cg-provider-provider)
1364-
* [`cg provider:add [PROVIDER]`](#cg-provideradd-provider)
1365-
* [`cg provider:install [PROVIDER]`](#cg-providerinstall-provider)
1366-
* [`cg provider:list [PROVIDER]`](#cg-providerlist-provider)
1367-
* [`cg provider:remove [PROVIDER]`](#cg-providerremove-provider)
1368-
* [`cg provider:update [PROVIDER]`](#cg-providerupdate-provider)
1369-
* [`cg scan [PROVIDER]`](#cg-scan-provider)
1370-
* [`cg serve [PROVIDER]`](#cg-serve-provider)
1371-
* [`cg teardown [PROVIDER]`](#cg-teardown-provider)
1372-
* [`cg update [PROVIDER]`](#cg-update-provider)
1374+
1375+
- [`cg help [COMMAND]`](#cg-help-command)
1376+
- [`cg init [PROVIDER]`](#cg-init-provider)
1377+
- [`cg launch [PROVIDER]`](#cg-launch-provider)
1378+
- [`cg load [PROVIDER]`](#cg-load-provider)
1379+
- [`cg policy [PROVIDER]`](#cg-policy-provider)
1380+
- [`cg policy:add [PROVIDER]`](#cg-policyadd-provider)
1381+
- [`cg policy:install [PROVIDER]`](#cg-policyinstall-provider)
1382+
- [`cg policy:list [PROVIDER]`](#cg-policylist-provider)
1383+
- [`cg policy:remove [PROVIDER]`](#cg-policyremove-provider)
1384+
- [`cg policy:update [PROVIDER]`](#cg-policyupdate-provider)
1385+
- [`cg provider [PROVIDER]`](#cg-provider-provider)
1386+
- [`cg provider:add [PROVIDER]`](#cg-provideradd-provider)
1387+
- [`cg provider:install [PROVIDER]`](#cg-providerinstall-provider)
1388+
- [`cg provider:list [PROVIDER]`](#cg-providerlist-provider)
1389+
- [`cg provider:remove [PROVIDER]`](#cg-providerremove-provider)
1390+
- [`cg provider:update [PROVIDER]`](#cg-providerupdate-provider)
1391+
- [`cg scan [PROVIDER]`](#cg-scan-provider)
1392+
- [`cg serve [PROVIDER]`](#cg-serve-provider)
1393+
- [`cg teardown [PROVIDER]`](#cg-teardown-provider)
1394+
- [`cg update [PROVIDER]`](#cg-update-provider)
13731395

13741396
## `cg help [COMMAND]`
13751397

@@ -2071,4 +2093,5 @@ EXAMPLES
20712093
```
20722094

20732095
_See code: [src/commands/update.ts](https://github.com/cloudgraphdev/cli/blob/v0.20.10/src/commands/update.ts)_
2096+
20742097
<!-- commandsstop -->

0 commit comments

Comments
 (0)