Skip to content

Commit 764aea0

Browse files
chore(docs): update docs (#31)
1 parent 64f0998 commit 764aea0

11 files changed

Lines changed: 180 additions & 4 deletions

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
edition = "2024"
33
name = "cirro"
44
repository = "https://github.com/bishopfox/cirro"
5-
version = "1.1.0"
5+
version = "1.2.0"
66

77
[features]
88
azure = ["collector"]

docs/analysis/additional-nodes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ These nodes are not direct objects in Entra ID or Azure but are created as a res
1919
- **[KeyVaultCertificateValue](additional-nodes/key-vault-certificate-value.md)** - Versioned Key Vault certificate data and policy details
2020
- **[KeyVaultSecret](additional-nodes/key-vault-secret.md)** - Key Vault secret metadata
2121
- **[KeyVaultSecretValue](additional-nodes/key-vault-secret-value.md)** - Versioned Key Vault secret values
22+
- **[LoadBalancerBackendAddressPool](additional-nodes/load-balancer-backend-address-pool.md)** - Backend address pools attached to load balancers
23+
- **[LoadBalancerFrontendIPConfiguration](additional-nodes/load-balancer-frontend-ip-configuration.md)** - Frontend IP configurations for load balancers
24+
- **[LoadBalancerRule](additional-nodes/load-balancer-rule.md)** - Rule definitions attached to load balancers
2225
- **[NetworkGateway](additional-nodes/network-gateway.md)** - Virtual network gateways
2326
- **[NetworkPeering](additional-nodes/network-peering.md)** - Virtual network peering connections
2427
- **[NetworkRoute](additional-nodes/network-route.md)** - Individual routes within route tables
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# LoadBalancerBackendAddressPool
2+
3+
Represents backend address pool objects attached to a load balancer.
4+
5+
**Labels:** `:LoadBalancerBackendAddressPool`
6+
7+
**Properties:**
8+
9+
- `id` - Backend address pool resource ID (primary key)
10+
- `name` - Backend pool name
11+
- `provisioningState` - Current provisioning state
12+
- `type` - Azure resource type value
13+
14+
## Relationships
15+
16+
### Incoming
17+
18+
- **LoadBalancer** -> `HAS_BACKEND_POOL` -> **LoadBalancerBackendAddressPool** - Parent load balancer
19+
20+
### Outgoing
21+
22+
- **LoadBalancerBackendAddressPool** -> `ASSOCIATED_WITH` -> **NetworkInterface** - Backend NIC configuration reference
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# LoadBalancerFrontendIPConfiguration
2+
3+
Represents frontend IP configuration objects for a load balancer.
4+
5+
**Labels:** `:LoadBalancerFrontendIPConfiguration`
6+
7+
**Properties:**
8+
9+
- `id` - Frontend configuration resource ID (primary key)
10+
- `name` - Frontend configuration name
11+
- `privateIPAllocationMethod` - Private IP allocation method
12+
- `provisioningState` - Current provisioning state
13+
- `type` - Azure resource type value
14+
15+
## Relationships
16+
17+
### Incoming
18+
19+
- **LoadBalancer** -> `HAS_LB_FRONTEND` -> **LoadBalancerFrontendIPConfiguration** - Parent load balancer
20+
21+
### Outgoing
22+
23+
- **LoadBalancerFrontendIPConfiguration** -> `HAS_IP` -> **PublicIPAddress** - Associated public IP (if present)
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# LoadBalancerRule
2+
3+
Represents load balancing rule definitions attached to a load balancer.
4+
5+
**Labels:** `:LoadBalancerRule`
6+
7+
**Properties:**
8+
9+
- `id` - Rule resource ID (primary key)
10+
- `name` - Rule name
11+
- `protocol` - Protocol used by the rule
12+
- `frontendPort` - Frontend listening port
13+
- `backendPort` - Backend target port
14+
- `allowBackendPortConflict` - Whether backend port conflict is allowed
15+
- `disableConnectionTracking` - Whether connection tracking is disabled
16+
- `disableOutboundSnat` - Whether outbound SNAT is disabled
17+
- `enableConnectionTracking` - Whether connection tracking is enabled
18+
- `enableDestinationServiceEndpoint` - Whether destination service endpoint is enabled
19+
- `enableFloatingIP` - Whether floating IP is enabled
20+
- `enableTcpReset` - Whether TCP reset is enabled
21+
- `idleTimeoutInMinutes` - Idle timeout value
22+
- `provisioningState` - Current provisioning state
23+
- `type` - Azure resource type value
24+
25+
## Relationships
26+
27+
### Incoming
28+
29+
- **LoadBalancer** -> `HAS_RULE` -> **LoadBalancerRule** - Load balancer that owns the rule
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# LoadBalancer
2+
3+
Represents Azure Load Balancer resources.
4+
5+
**Labels:** `:ArmResource:LoadBalancer`
6+
7+
**Properties:**
8+
9+
- `id` - Load balancer resource ID (primary key)
10+
- `resourceGuid` - Azure-generated unique resource GUID
11+
- `provisioningState` - Current provisioning state
12+
13+
## Relationships
14+
15+
### Outgoing
16+
17+
- **LoadBalancer** -> `HAS_RULE` -> **LoadBalancerRule** - Load balancing rules attached to the load balancer
18+
- **LoadBalancer** -> `HAS_LB_FRONTEND` -> **LoadBalancerFrontendIPConfiguration** - Frontend IP configurations
19+
- **LoadBalancer** -> `HAS_BACKEND_POOL` -> **LoadBalancerBackendAddressPool** - Backend address pools
20+
21+
## Examples
22+
23+
```cypher
24+
// Find load balancers with frontend and backend topology
25+
MATCH (lb:LoadBalancer)
26+
OPTIONAL MATCH (lb)-[:HAS_LB_FRONTEND]->(fe:LoadBalancerFrontendIPConfiguration)
27+
OPTIONAL MATCH (lb)-[:HAS_BACKEND_POOL]->(be:LoadBalancerBackendAddressPool)
28+
RETURN lb.name, count(DISTINCT fe) AS frontendCount, count(DISTINCT be) AS backendPoolCount
29+
```
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# VirtualHub
2+
3+
Represents Azure Virtual Hub resources.
4+
5+
**Labels:** `:ArmResource:VirtualHub`
6+
7+
**Properties:**
8+
9+
- `id` - Virtual hub resource ID (primary key)
10+
- `allowBranchToBranchTraffic` - Whether branch-to-branch traffic is allowed
11+
- `hubRoutingPreference` - Hub routing preference mode
12+
- `provisioningState` - Current provisioning state
13+
- `routingState` - Current routing state
14+
- `virtualRouterAsn` - ASN used by the virtual router
15+
- `virtualRouterIps` - Virtual router IP addresses
16+
17+
## Relationships
18+
19+
No direct relationships are created in ingestion for this node type.
20+
21+
## Examples
22+
23+
```cypher
24+
// Find virtual hubs and routing posture
25+
MATCH (vh:VirtualHub)
26+
RETURN vh.name, vh.hubRoutingPreference, vh.routingState, vh.virtualRouterAsn
27+
```
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# HAS_BACKEND_POOL
2+
3+
Represents the relationship between a load balancer and its backend address pools.
4+
5+
## Usage
6+
7+
- **LoadBalancer** -> `HAS_BACKEND_POOL` -> **LoadBalancerBackendAddressPool** - Backend pool attached to a load balancer
8+
9+
## Properties
10+
11+
No additional properties on the relationship.
12+
13+
## Examples
14+
15+
```cypher
16+
MATCH (lb:LoadBalancer)-[:HAS_BACKEND_POOL]->(pool:LoadBalancerBackendAddressPool)
17+
RETURN lb.name, pool.name, pool.provisioningState
18+
```
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# HAS_LB_FRONTEND
2+
3+
Represents the relationship between a load balancer and its frontend IP configurations.
4+
5+
## Usage
6+
7+
- **LoadBalancer** -> `HAS_LB_FRONTEND` -> **LoadBalancerFrontendIPConfiguration** - Frontend configuration attached to a load balancer
8+
9+
## Properties
10+
11+
No additional properties on the relationship.
12+
13+
## Examples
14+
15+
```cypher
16+
MATCH (lb:LoadBalancer)-[:HAS_LB_FRONTEND]->(fe:LoadBalancerFrontendIPConfiguration)
17+
RETURN lb.name, fe.name, fe.privateIPAllocationMethod
18+
```

0 commit comments

Comments
 (0)