Skip to content

Commit 2255ac6

Browse files
wlynchwlynch
authored
Fix submodule paths in READMEs. (#62)
1 parent 0949b30 commit 2255ac6

File tree

25 files changed

+581
-42
lines changed

25 files changed

+581
-42
lines changed

‎hack/update-docs.sh‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
#!/bin/bash
2+
set -e
3+
4+
# Update terraform docs
5+
for d in `find . -name '*.tf' -exec dirname {} \; | sort | uniq`; do
6+
echo "###############################################"
7+
echo "# Generating $d"
8+
terraform-docs markdown table \
9+
--output-file README.md \
10+
--output-mode inject \
11+
$d
12+
done

‎modules/cloudevent-broker/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# `cloudevent-broker`
22

33
This module provisions a regionalizied Broker abstraction akin to the Knative
4-
"Broker" concept. The dual "Trigger" concept is captured by the sibling
5-
`cloudevent-trigger` module. The intended usage of this module for publishing
4+
"Broker" concept. The dual "Trigger" concept is captured by the sibling
5+
`cloudevent-trigger` module. The intended usage of this module for publishing
66
events is something like this:
77

88
```hcl
99
// Create a network with several regional subnets
1010
module "networking" {
11-
source = "chainguard-dev/common/infra//networking"
11+
source = "chainguard-dev/common/infra//modules/networking"
1212
1313
name = "my-networking"
1414
project_id = var.project_id
@@ -17,7 +17,7 @@ module "networking" {
1717
1818
// Create the Broker abstraction.
1919
module "cloudevent-broker" {
20-
source = "chainguard-dev/common/infra//cloudevent-broker"
20+
source = "chainguard-dev/common/infra//modules/cloudevent-broker"
2121
2222
name = "my-broker"
2323
project_id = var.project_id
@@ -28,7 +28,7 @@ module "cloudevent-broker" {
2828
module "foo-emits-events" {
2929
for_each = module.networking.regional-networks
3030
31-
source = "chainguard-dev/common/infra//authorize-private-service"
31+
source = "chainguard-dev/common/infra//modules/authorize-private-service"
3232
3333
project_id = var.project_id
3434
region = each.key
@@ -40,7 +40,7 @@ module "foo-emits-events" {
4040
// Run a cloud run service as the "foo" service account, and pass in the address
4141
// of the regional ingress endpoint.
4242
module "foo-service" {
43-
source = "chainguard-dev/common/infra//regional-go-service"
43+
source = "chainguard-dev/common/infra//modules/regional-go-service"
4444
4545
project_id = var.project_id
4646
name = "foo"

‎modules/cloudevent-recorder/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ intended usage of this module for publishing events is something like this:
99
```hcl
1010
// Create a network with several regional subnets
1111
module "networking" {
12-
source = "chainguard-dev/common/infra//networking"
12+
source = "chainguard-dev/common/infra//modules/networking"
1313
1414
name = "my-networking"
1515
project_id = var.project_id
@@ -18,7 +18,7 @@ module "networking" {
1818
1919
// Create the Broker abstraction.
2020
module "cloudevent-broker" {
21-
source = "chainguard-dev/common/infra//cloudevent-broker"
21+
source = "chainguard-dev/common/infra//modules/cloudevent-broker"
2222
2323
name = "my-broker"
2424
project_id = var.project_id
@@ -27,7 +27,7 @@ module "cloudevent-broker" {
2727
2828
// Record cloudevents of type com.example.foo and com.example.bar
2929
module "foo-emits-events" {
30-
source = "chainguard-dev/common/infra//cloudevent-recorder"
30+
source = "chainguard-dev/common/infra//modules/cloudevent-recorder"
3131
3232
name = "my-recorder"
3333
project_id = var.project_id

‎modules/cloudevent-trigger/README.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# `cloudevent-trigger`
22

33
This module provisions regionalizied event-triggered services using a Trigger
4-
abstraction akin to the Knative "Trigger" concept. The dual "Broker" concept
5-
is captured by the sibling `cloudevent-broker` module. The intended usage of
6-
this module for consuming events is something like this:
4+
abstraction akin to the Knative "Trigger" concept. The dual "Broker" concept is
5+
captured by the sibling `cloudevent-broker` module. The intended usage of this
6+
module for consuming events is something like this:
77

88
```hcl
99
// Create a network with several regional subnets
1010
module "networking" {
11-
source = "chainguard-dev/common/infra//networking"
11+
source = "chainguard-dev/common/infra//modules/networking"
1212
1313
name = "my-networking"
1414
project_id = var.project_id
@@ -17,15 +17,15 @@ module "networking" {
1717
1818
// Create the Broker abstraction.
1919
module "cloudevent-broker" {
20-
source = "chainguard-dev/common/infra//cloudevent-broker"
20+
source = "chainguard-dev/common/infra//modules/cloudevent-broker"
2121
2222
name = "my-broker"
2323
project_id = var.project_id
2424
regions = module.networking.regional-networks
2525
}
2626
2727
module "bar-service" {
28-
source = "chainguard-dev/common/infra//regional-go-service"
28+
source = "chainguard-dev/common/infra//modules/regional-go-service"
2929
3030
project_id = var.project_id
3131
name = "bar"
@@ -48,7 +48,7 @@ module "bar-service" {
4848
module "cloudevent-trigger" {
4949
for_each = module.networking.regional-networks
5050
51-
source = "chainguard-dev/common/infra//cloudevent-trigger"
51+
source = "chainguard-dev/common/infra//modules/cloudevent-trigger"
5252
5353
name = "bar"
5454
project_id = var.project_id

‎modules/dashboard/cloudevent-receiver/README.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# `dashboard/cloudevent-receiver`
22

3-
This module provisions a Google Cloud Monitoring dashboard for a regionalized Cloud Run service that receives Cloud Events from one or more `cloudevent-trigger`.
3+
This module provisions a Google Cloud Monitoring dashboard for a regionalized
4+
Cloud Run service that receives Cloud Events from one or more
5+
`cloudevent-trigger`.
46

57
It assumes the service has the same name in all regions.
68

79
```hcl
810
// Create a network with several regional subnets
911
module "networking" {
10-
source = "chainguard-dev/common/infra//networking"
12+
source = "chainguard-dev/common/infra//modules/networking"
1113
1214
name = "my-networking"
1315
project_id = var.project_id
@@ -16,7 +18,7 @@ module "networking" {
1618
1719
// Run a regionalized cloud run service "receiver" to handle events.
1820
module "receiver" {
19-
source = "chainguard-dev/common/infra//regional-go-service"
21+
source = "chainguard-dev/common/infra//modules/regional-go-service"
2022
2123
project_id = var.project_id
2224
name = "receiver"
@@ -37,7 +39,7 @@ module "receiver" {
3739
module "cloudevent-trigger" {
3840
for_each = module.networking.regional-networks
3941
40-
source = "chainguard-dev/common/infra//cloudevent-trigger"
42+
source = "chainguard-dev/common/infra//modules/cloudevent-trigger"
4143
4244
name = "my-trigger"
4345
project_id = var.project_id
@@ -53,7 +55,7 @@ module "cloudevent-trigger" {
5355
5456
// Set up a dashboard for a regionalized event handler named "receiver".
5557
module "receiver-dashboard" {
56-
source = "chainguard-dev/common/infra//dashboard/cloudevent-receiver"
58+
source = "chainguard-dev/common/infra//modules/dashboard/cloudevent-receiver"
5759
service_name = "receiver"
5860
5961
triggers = {
@@ -62,7 +64,9 @@ module "receiver-dashboard" {
6264
}
6365
```
6466

65-
The dashboard it creates includes widgets for service logs, request count, latency (p50,p95,p99), instance count grouped by revision, CPU and memory utilization, startup latency, and sent/received bytes.
67+
The dashboard it creates includes widgets for service logs, request count,
68+
latency (p50,p95,p99), instance count grouped by revision, CPU and memory
69+
utilization, startup latency, and sent/received bytes.
6670

6771
<!-- BEGIN_TF_DOCS -->
6872
## Requirements

‎modules/dashboard/job/README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@ resource "google_cloud_run_v2_job" "sync" {
2020
2121
// Set up a dashboard for a regionalized job named "sync".
2222
module "job-dashboard" {
23-
source = "chainguard-dev/common/infra//dashboard/job"
23+
source = "chainguard-dev/common/infra//modules/dashboard/job"
2424
service_name = google_cloud_run_v2_job.name
2525
}
2626
```
2727

28-
The dashboard it creates includes widgets for job logs, CPU and memory utilization, startup latency, and sent/received bytes.
28+
The dashboard it creates includes widgets for job logs, CPU and memory
29+
utilization, startup latency, and sent/received bytes.
2930

3031
<!-- BEGIN_TF_DOCS -->
3132
## Requirements

‎modules/dashboard/sections/alerts/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
No providers.
9+
10+
## Modules
11+
12+
| Name | Source | Version |
13+
|------|--------|---------|
14+
| <a name="module_alert"></a> [alert](#module\_alert) | ../../widgets/alert | n/a |
15+
| <a name="module_collapsible"></a> [collapsible](#module\_collapsible) | ../collapsible | n/a |
16+
| <a name="module_width"></a> [width](#module\_width) | ../width | n/a |
17+
18+
## Resources
19+
20+
No resources.
21+
22+
## Inputs
23+
24+
| Name | Description | Type | Default | Required |
25+
|------|-------------|------|---------|:--------:|
26+
| <a name="input_alert"></a> [alert](#input\_alert) | n/a | `string` | n/a | yes |
27+
| <a name="input_collapsed"></a> [collapsed](#input\_collapsed) | n/a | `bool` | `false` | no |
28+
| <a name="input_title"></a> [title](#input\_title) | n/a | `string` | n/a | yes |
29+
30+
## Outputs
31+
32+
| Name | Description |
33+
|------|-------------|
34+
| <a name="output_section"></a> [section](#output\_section) | n/a |
35+
<!-- END_TF_DOCS -->

‎modules/dashboard/sections/collapsible/README.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
No providers.
9+
10+
## Modules
11+
12+
| Name | Source | Version |
13+
|------|--------|---------|
14+
| <a name="module_width"></a> [width](#module\_width) | ../width | n/a |
15+
16+
## Resources
17+
18+
No resources.
19+
20+
## Inputs
21+
22+
| Name | Description | Type | Default | Required |
23+
|------|-------------|------|---------|:--------:|
24+
| <a name="input_collapsed"></a> [collapsed](#input\_collapsed) | n/a | `bool` | `false` | no |
25+
| <a name="input_tiles"></a> [tiles](#input\_tiles) | n/a | `any` | n/a | yes |
26+
| <a name="input_title"></a> [title](#input\_title) | n/a | `string` | n/a | yes |
27+
28+
## Outputs
29+
30+
| Name | Description |
31+
|------|-------------|
32+
| <a name="output_section"></a> [section](#output\_section) | n/a |
33+
<!-- END_TF_DOCS -->

‎modules/dashboard/sections/grpc/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
No providers.
9+
10+
## Modules
11+
12+
| Name | Source | Version |
13+
|------|--------|---------|
14+
| <a name="module_collapsible"></a> [collapsible](#module\_collapsible) | ../collapsible | n/a |
15+
| <a name="module_incoming_latency"></a> [incoming\_latency](#module\_incoming\_latency) | ../../widgets/latency | n/a |
16+
| <a name="module_outbound_latency"></a> [outbound\_latency](#module\_outbound\_latency) | ../../widgets/latency | n/a |
17+
| <a name="module_outbound_request_count"></a> [outbound\_request\_count](#module\_outbound\_request\_count) | ../../widgets/xy | n/a |
18+
| <a name="module_request_count"></a> [request\_count](#module\_request\_count) | ../../widgets/xy | n/a |
19+
| <a name="module_width"></a> [width](#module\_width) | ../width | n/a |
20+
21+
## Resources
22+
23+
No resources.
24+
25+
## Inputs
26+
27+
| Name | Description | Type | Default | Required |
28+
|------|-------------|------|---------|:--------:|
29+
| <a name="input_collapsed"></a> [collapsed](#input\_collapsed) | n/a | `bool` | `false` | no |
30+
| <a name="input_filter"></a> [filter](#input\_filter) | n/a | `list(string)` | n/a | yes |
31+
| <a name="input_service_name"></a> [service\_name](#input\_service\_name) | n/a | `string` | n/a | yes |
32+
| <a name="input_title"></a> [title](#input\_title) | n/a | `string` | n/a | yes |
33+
34+
## Outputs
35+
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_section"></a> [section](#output\_section) | n/a |
39+
<!-- END_TF_DOCS -->

‎modules/dashboard/sections/http/README.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
<!-- BEGIN_TF_DOCS -->
2+
## Requirements
3+
4+
No requirements.
5+
6+
## Providers
7+
8+
No providers.
9+
10+
## Modules
11+
12+
| Name | Source | Version |
13+
|------|--------|---------|
14+
| <a name="module_collapsible"></a> [collapsible](#module\_collapsible) | ../collapsible | n/a |
15+
| <a name="module_incoming_latency"></a> [incoming\_latency](#module\_incoming\_latency) | ../../widgets/latency | n/a |
16+
| <a name="module_outbound_request_count"></a> [outbound\_request\_count](#module\_outbound\_request\_count) | ../../widgets/xy | n/a |
17+
| <a name="module_outbound_request_latency"></a> [outbound\_request\_latency](#module\_outbound\_request\_latency) | ../../widgets/latency | n/a |
18+
| <a name="module_request_count"></a> [request\_count](#module\_request\_count) | ../../widgets/xy | n/a |
19+
| <a name="module_width"></a> [width](#module\_width) | ../width | n/a |
20+
21+
## Resources
22+
23+
No resources.
24+
25+
## Inputs
26+
27+
| Name | Description | Type | Default | Required |
28+
|------|-------------|------|---------|:--------:|
29+
| <a name="input_collapsed"></a> [collapsed](#input\_collapsed) | n/a | `bool` | `false` | no |
30+
| <a name="input_filter"></a> [filter](#input\_filter) | n/a | `list(string)` | n/a | yes |
31+
| <a name="input_service_name"></a> [service\_name](#input\_service\_name) | n/a | `string` | n/a | yes |
32+
| <a name="input_title"></a> [title](#input\_title) | n/a | `string` | n/a | yes |
33+
34+
## Outputs
35+
36+
| Name | Description |
37+
|------|-------------|
38+
| <a name="output_section"></a> [section](#output\_section) | n/a |
39+
<!-- END_TF_DOCS -->

0 commit comments

Comments
 (0)