Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wlynch committed Jan 21, 2025
1 parent 833ed87 commit 3fc478d
Show file tree
Hide file tree
Showing 7 changed files with 111 additions and 11 deletions.
6 changes: 4 additions & 2 deletions modules/dashboard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,11 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_object"></a> [object](#input\_object) | Object to encode into JSON | `object({})` | n/a | yes |
| <a name="input_object"></a> [object](#input\_object) | Object to encode into JSON | `any` | n/a | yes |

## Outputs

No outputs.
| Name | Description |
|------|-------------|
| <a name="output_json"></a> [json](#output\_json) | n/a |
<!-- END_TF_DOCS -->
10 changes: 3 additions & 7 deletions modules/dashboard/alerts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,19 @@ No requirements.

## Providers

| Name | Version |
|------|---------|
| <a name="provider_google"></a> [google](#provider\_google) | n/a |
No providers.

## Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_alerts"></a> [alerts](#module\_alerts) | ../widgets/alert | n/a |
| <a name="module_dashboard-json"></a> [dashboard-json](#module\_dashboard-json) | ../json | n/a |
| <a name="module_dashboard"></a> [dashboard](#module\_dashboard) | ../ | n/a |
| <a name="module_width"></a> [width](#module\_width) | ../sections/width | n/a |

## Resources

| Name | Type |
|------|------|
| [google_monitoring_dashboard.dashboard](https://registry.terraform.io/providers/hashicorp/google/latest/docs/resources/monitoring_dashboard) | resource |
No resources.

## Inputs

Expand Down
1 change: 1 addition & 0 deletions modules/dashboard/sections/resources/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ No providers.
|------|--------|---------|
| <a name="module_collapsible"></a> [collapsible](#module\_collapsible) | ../collapsible | n/a |
| <a name="module_cpu_utilization"></a> [cpu\_utilization](#module\_cpu\_utilization) | ../../widgets/xy | n/a |
| <a name="module_disk_usage"></a> [disk\_usage](#module\_disk\_usage) | ../../widgets/xy | n/a |
| <a name="module_instance_count"></a> [instance\_count](#module\_instance\_count) | ../../widgets/xy | n/a |
| <a name="module_memory_utilization"></a> [memory\_utilization](#module\_memory\_utilization) | ../../widgets/xy | n/a |
| <a name="module_received_bytes"></a> [received\_bytes](#module\_received\_bytes) | ../../widgets/xy | n/a |
Expand Down
60 changes: 60 additions & 0 deletions modules/gke/README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion modules/regional-go-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ No requirements.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_containers"></a> [containers](#input\_containers) | The containers to run in the service. Each container will be run in each region. | <pre>map(object({<br/> source = object({<br/> base_image = optional(string, "cgr.dev/chainguard/static:latest-glibc")<br/> working_dir = string<br/> importpath = string<br/> env = optional(list(string), [])<br/> })<br/> args = optional(list(string), [])<br/> ports = optional(list(object({<br/> name = optional(string, "http1")<br/> container_port = number<br/> })), [])<br/> resources = optional(<br/> object(<br/> {<br/> limits = optional(object(<br/> {<br/> cpu = string<br/> memory = string<br/> }<br/> ), null)<br/> cpu_idle = optional(bool, true)<br/> startup_cpu_boost = optional(bool, true)<br/> }<br/> ),<br/> {<br/> cpu_idle = true<br/> }<br/> )<br/> env = optional(list(object({<br/> name = string<br/> value = optional(string)<br/> value_source = optional(object({<br/> secret_key_ref = object({<br/> secret = string<br/> version = string<br/> })<br/> }), null)<br/> })), [])<br/> regional-env = optional(list(object({<br/> name = string<br/> value = map(string)<br/> })), [])<br/> volume_mounts = optional(list(object({<br/> name = string<br/> mount_path = string<br/> })), [])<br/> }))</pre> | n/a | yes |
| <a name="input_containers"></a> [containers](#input\_containers) | The containers to run in the service. Each container will be run in each region. | <pre>map(object({<br/> source = object({<br/> base_image = optional(string, "cgr.dev/chainguard/static:latest-glibc")<br/> working_dir = string<br/> importpath = string<br/> env = optional(list(string), [])<br/> })<br/> args = optional(list(string), [])<br/> ports = optional(list(object({<br/> name = optional(string, "http1")<br/> container_port = number<br/> })), [])<br/> resources = optional(<br/> object(<br/> {<br/> limits = optional(object(<br/> {<br/> cpu = string<br/> memory = string<br/> }<br/> ), null)<br/> cpu_idle = optional(bool, true)<br/> startup_cpu_boost = optional(bool, true)<br/> }<br/> ),<br/> {<br/> cpu_idle = true<br/> }<br/> )<br/> env = optional(list(object({<br/> name = string<br/> value = optional(string)<br/> value_source = optional(object({<br/> secret_key_ref = object({<br/> secret = string<br/> version = string<br/> })<br/> }), null)<br/> })), [])<br/> regional-env = optional(list(object({<br/> name = string<br/> value = map(string)<br/> })), [])<br/> volume_mounts = optional(list(object({<br/> name = string<br/> mount_path = string<br/> })), [])<br/> startup_probe = optional(object({<br/> initial_delay_seconds = optional(number)<br/> // GCP Terraform provider defaults differ from Cloud Run defaults.<br/> // See https://cloud.google.com/run/docs/configuring/healthchecks#tcp-startup-probe<br/> period_seconds = optional(number, 240)<br/> timeout_seconds = optional(number, 240)<br/> failure_threshold = optional(number, 1)<br/> http_get = optional(object({<br/> path = string<br/> port = optional(number)<br/> }), null)<br/> tcp_socket = optional(object({<br/> port = optional(number)<br/> }), null)<br/> grpc = optional(object({<br/> service = optional(string)<br/> port = optional(number)<br/> }), null)<br/> }))<br/> liveness_probe = optional(object({<br/> initial_delay_seconds = optional(number)<br/> // GCP Terraform provider defaults differ from Cloud Run defaults.<br/> // See https://cloud.google.com/run/docs/configuring/healthchecks#tcp-startup-probe<br/> period_seconds = optional(number, 240)<br/> timeout_seconds = optional(number, 240)<br/> failure_threshold = optional(number, 1)<br/> http_get = optional(object({<br/> path = string<br/> port = optional(number)<br/> }), null)<br/> tcp_socket = optional(object({<br/> port = optional(number)<br/> }), null)<br/> grpc = optional(object({<br/> service = optional(string)<br/> port = optional(number)<br/> }), null)<br/> }))<br/> }))</pre> | n/a | yes |
| <a name="input_deletion_protection"></a> [deletion\_protection](#input\_deletion\_protection) | Whether to enable delete protection for the service. | `bool` | `true` | no |
| <a name="input_egress"></a> [egress](#input\_egress) | Which type of egress traffic to send through the VPC.<br/><br/>- ALL\_TRAFFIC sends all traffic through regional VPC network<br/>- PRIVATE\_RANGES\_ONLY sends only traffic to private IP addresses through regional VPC network | `string` | `"ALL_TRAFFIC"` | no |
| <a name="input_enable_profiler"></a> [enable\_profiler](#input\_enable\_profiler) | Enable cloud profiler. | `bool` | `false` | no |
Expand Down
2 changes: 1 addition & 1 deletion modules/regional-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_containers"></a> [containers](#input\_containers) | The containers to run in the service. Each container will be run in each region. | <pre>map(object({<br/> image = string<br/> args = optional(list(string), [])<br/> ports = optional(list(object({<br/> name = optional(string, "http1")<br/> container_port = number<br/> })), [])<br/> resources = optional(<br/> object(<br/> {<br/> limits = optional(object(<br/> {<br/> cpu = string<br/> memory = string<br/> }<br/> ), null)<br/> cpu_idle = optional(bool, true)<br/> startup_cpu_boost = optional(bool, true)<br/> }<br/> ),<br/> {<br/> cpu_idle = true<br/> }<br/> )<br/> env = optional(list(object({<br/> name = string<br/> value = optional(string)<br/> value_source = optional(object({<br/> secret_key_ref = object({<br/> secret = string<br/> version = string<br/> })<br/> }), null)<br/> })), [])<br/> regional-env = optional(list(object({<br/> name = string<br/> value = map(string)<br/> })), [])<br/> volume_mounts = optional(list(object({<br/> name = string<br/> mount_path = string<br/> })), [])<br/> }))</pre> | n/a | yes |
| <a name="input_containers"></a> [containers](#input\_containers) | The containers to run in the service. Each container will be run in each region. | <pre>map(object({<br/> image = string<br/> args = optional(list(string), [])<br/> ports = optional(list(object({<br/> name = optional(string, "http1")<br/> container_port = number<br/> })), [])<br/> resources = optional(<br/> object(<br/> {<br/> limits = optional(object(<br/> {<br/> cpu = string<br/> memory = string<br/> }<br/> ), null)<br/> cpu_idle = optional(bool, true)<br/> startup_cpu_boost = optional(bool, true)<br/> }<br/> ),<br/> {<br/> cpu_idle = true<br/> }<br/> )<br/> env = optional(list(object({<br/> name = string<br/> value = optional(string)<br/> value_source = optional(object({<br/> secret_key_ref = object({<br/> secret = string<br/> version = string<br/> })<br/> }), null)<br/> })), [])<br/> regional-env = optional(list(object({<br/> name = string<br/> value = map(string)<br/> })), [])<br/> volume_mounts = optional(list(object({<br/> name = string<br/> mount_path = string<br/> })), [])<br/> startup_probe = optional(object({<br/> initial_delay_seconds = optional(number)<br/> // GCP Terraform provider defaults differ from Cloud Run defaults.<br/> // See https://cloud.google.com/run/docs/configuring/healthchecks#tcp-startup-probe<br/> period_seconds = optional(number, 240)<br/> timeout_seconds = optional(number, 240)<br/> failure_threshold = optional(number, 1)<br/> http_get = optional(object({<br/> path = string<br/> port = optional(number)<br/> }), null)<br/> tcp_socket = optional(object({<br/> port = optional(number)<br/> }), null)<br/> grpc = optional(object({<br/> service = optional(string)<br/> port = optional(number)<br/> }), null)<br/> }))<br/> liveness_probe = optional(object({<br/> initial_delay_seconds = optional(number)<br/> // GCP Terraform provider defaults differ from Cloud Run defaults.<br/> // See https://cloud.google.com/run/docs/configuring/healthchecks#tcp-startup-probe<br/> period_seconds = optional(number, 240)<br/> timeout_seconds = optional(number, 240)<br/> failure_threshold = optional(number, 1)<br/> http_get = optional(object({<br/> path = string<br/> port = optional(number)<br/> }), null)<br/> tcp_socket = optional(object({<br/> port = optional(number)<br/> }), null)<br/> grpc = optional(object({<br/> service = optional(string)<br/> port = optional(number)<br/> }), null)<br/> }))<br/> }))</pre> | n/a | yes |
| <a name="input_deletion_protection"></a> [deletion\_protection](#input\_deletion\_protection) | Whether to enable delete protection for the service. | `bool` | `true` | no |
| <a name="input_egress"></a> [egress](#input\_egress) | Which type of egress traffic to send through the VPC.<br/><br/>- ALL\_TRAFFIC sends all traffic through regional VPC network<br/>- PRIVATE\_RANGES\_ONLY sends only traffic to private IP addresses through regional VPC network | `string` | `"ALL_TRAFFIC"` | no |
| <a name="input_enable_profiler"></a> [enable\_profiler](#input\_enable\_profiler) | Enable cloud profiler. | `bool` | `false` | no |
Expand Down
41 changes: 41 additions & 0 deletions modules/workqueue/testing/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<!-- BEGIN_TF_DOCS -->

## Requirements

No requirements.

## Providers

| Name | Version |
| --------------------------------------------------------------------- | ------- |
| <a name="provider_ko"></a> [ko](#provider_ko) | n/a |
| <a name="provider_kubernetes"></a> [kubernetes](#provider_kubernetes) | n/a |

## Modules

No modules.

## Resources

| Name | Type |
| ----------------------------------------------------------------------------------------------------------------------------- | -------- |
| [ko_build.inmem](https://registry.terraform.io/providers/ko-build/ko/latest/docs/resources/build) | resource |
| [kubernetes_manifest.inmem-ksvc](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource |
| [kubernetes_manifest.svc-acct](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/manifest) | resource |

## Inputs

| Name | Description | Type | Default | Required |
| --------------------------------------------------------------------------------------- | ---------------------------------------------------------- | -------- | ------- | :------: |
| <a name="input_concurrent-work"></a> [concurrent-work](#input_concurrent-work) | The amount of concurrent work to dispatch at a given time. | `number` | n/a | yes |
| <a name="input_name"></a> [name](#input_name) | n/a | `string` | n/a | yes |
| <a name="input_namespace"></a> [namespace](#input_namespace) | n/a | `string` | n/a | yes |
| <a name="input_reconciler-service"></a> [reconciler-service](#input_reconciler-service) | The address of the k8s service to push keys to. | `string` | n/a | yes |

## Outputs

| Name | Description |
| ----------------------------------------------------------- | ----------- |
| <a name="output_receiver"></a> [receiver](#output_receiver) | n/a |

<!-- END_TF_DOCS -->

0 comments on commit 3fc478d

Please sign in to comment.