Skip to content

Commit

Permalink
Docs gen
Browse files Browse the repository at this point in the history
  • Loading branch information
bonclay7 committed Oct 28, 2024
1 parent 1f54a69 commit a21c5e8
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 22 deletions.
30 changes: 15 additions & 15 deletions modules/eks-monitoring/README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions modules/eks-monitoring/add-ons/adot-operator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ the ADOT Operator.
| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_addon_config"></a> [addon\_config](#input\_addon\_config) | Amazon EKS Managed ADOT Add-on config | `any` | `{}` | no |
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br/> aws_caller_identity_account_id = string<br/> aws_caller_identity_arn = string<br/> aws_eks_cluster_endpoint = string<br/> aws_partition_id = string<br/> aws_region_name = string<br/> eks_cluster_id = string<br/> eks_oidc_issuer_url = string<br/> eks_oidc_provider_arn = string<br/> irsa_iam_role_path = string<br/> irsa_iam_permissions_boundary = string<br/> tags = map(string)<br/> })</pre> | n/a | yes |
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br> aws_caller_identity_account_id = string<br> aws_caller_identity_arn = string<br> aws_eks_cluster_endpoint = string<br> aws_partition_id = string<br> aws_region_name = string<br> eks_cluster_id = string<br> eks_oidc_issuer_url = string<br> eks_oidc_provider_arn = string<br> irsa_iam_role_path = string<br> irsa_iam_permissions_boundary = string<br> tags = map(string)<br> })</pre> | n/a | yes |
| <a name="input_enable_cert_manager"></a> [enable\_cert\_manager](#input\_enable\_cert\_manager) | Enable cert-manager, a requirement for ADOT Operator | `bool` | `true` | no |
| <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm provider config for cert-manager | `any` | <pre>{<br/> "version": "v1.8.2"<br/>}</pre> | no |
| <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm provider config for cert-manager | `any` | <pre>{<br> "version": "v1.8.2"<br>}</pre> | no |
| <a name="input_kubernetes_version"></a> [kubernetes\_version](#input\_kubernetes\_version) | EKS Cluster version | `string` | n/a | yes |

## Outputs
Expand Down
2 changes: 1 addition & 1 deletion modules/eks-monitoring/add-ons/aws-for-fluentbit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ See this [Helm Chart](https://github.com/aws/eks-charts/tree/master/stable/aws-f

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br/> aws_caller_identity_account_id = string<br/> aws_caller_identity_arn = string<br/> aws_eks_cluster_endpoint = string<br/> aws_partition_id = string<br/> aws_region_name = string<br/> eks_cluster_id = string<br/> eks_oidc_issuer_url = string<br/> eks_oidc_provider_arn = string<br/> tags = map(string)<br/> irsa_iam_role_path = string<br/> irsa_iam_permissions_boundary = string<br/> })</pre> | n/a | yes |
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br> aws_caller_identity_account_id = string<br> aws_caller_identity_arn = string<br> aws_eks_cluster_endpoint = string<br> aws_partition_id = string<br> aws_region_name = string<br> eks_cluster_id = string<br> eks_oidc_issuer_url = string<br> eks_oidc_provider_arn = string<br> tags = map(string)<br> irsa_iam_role_path = string<br> irsa_iam_permissions_boundary = string<br> })</pre> | n/a | yes |
| <a name="input_cw_log_retention_days"></a> [cw\_log\_retention\_days](#input\_cw\_log\_retention\_days) | FluentBit CloudWatch Log group retention period | `number` | `90` | no |
| <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm provider config aws\_for\_fluent\_bit. | `any` | `{}` | no |
| <a name="input_irsa_policies"></a> [irsa\_policies](#input\_irsa\_policies) | Additional IAM policies for a IAM role for service accounts | `list(string)` | `[]` | no |
Expand Down
2 changes: 1 addition & 1 deletion modules/eks-monitoring/add-ons/external-secrets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ This deploys an EKS Cluster with the External Secrets Operator. The cluster is p

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br/> aws_caller_identity_account_id = string<br/> aws_caller_identity_arn = string<br/> aws_eks_cluster_endpoint = string<br/> aws_partition_id = string<br/> aws_region_name = string<br/> eks_cluster_id = string<br/> eks_oidc_issuer_url = string<br/> eks_oidc_provider_arn = string<br/> irsa_iam_role_path = string<br/> irsa_iam_permissions_boundary = string<br/> tags = map(string)<br/> })</pre> | n/a | yes |
| <a name="input_addon_context"></a> [addon\_context](#input\_addon\_context) | Input configuration for the addon | <pre>object({<br> aws_caller_identity_account_id = string<br> aws_caller_identity_arn = string<br> aws_eks_cluster_endpoint = string<br> aws_partition_id = string<br> aws_region_name = string<br> eks_cluster_id = string<br> eks_oidc_issuer_url = string<br> eks_oidc_provider_arn = string<br> irsa_iam_role_path = string<br> irsa_iam_permissions_boundary = string<br> tags = map(string)<br> })</pre> | n/a | yes |
| <a name="input_enable_external_secrets"></a> [enable\_external\_secrets](#input\_enable\_external\_secrets) | Enable external-secrets | `bool` | `true` | no |
| <a name="input_grafana_api_key"></a> [grafana\_api\_key](#input\_grafana\_api\_key) | Grafana API key for the Amazon Managed Grafana workspace | `string` | n/a | yes |
| <a name="input_helm_config"></a> [helm\_config](#input\_helm\_config) | Helm provider config for external secrets | `any` | `{}` | no |
Expand Down
2 changes: 1 addition & 1 deletion modules/eks-monitoring/patterns/istio/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_pattern_config"></a> [pattern\_config](#input\_pattern\_config) | Configuration object for ISTIO monitoring | <pre>object({<br/> enable_alerting_rules = bool<br/> enable_recording_rules = bool<br/> enable_dashboards = bool<br/> scrape_sample_limit = number<br/><br/> flux_gitrepository_name = string<br/> flux_gitrepository_url = string<br/> flux_gitrepository_branch = string<br/> flux_kustomization_name = string<br/> flux_kustomization_path = string<br/><br/> managed_prometheus_workspace_id = string<br/> prometheus_metrics_endpoint = string<br/><br/> dashboards = object({<br/> cp = string<br/> mesh = string<br/> performance = string<br/> service = string<br/> })<br/> })</pre> | n/a | yes |
| <a name="input_pattern_config"></a> [pattern\_config](#input\_pattern\_config) | Configuration object for ISTIO monitoring | <pre>object({<br> enable_alerting_rules = bool<br> enable_recording_rules = bool<br> enable_dashboards = bool<br> scrape_sample_limit = number<br><br> flux_gitrepository_name = string<br> flux_gitrepository_url = string<br> flux_gitrepository_branch = string<br> flux_kustomization_name = string<br> flux_kustomization_path = string<br><br> managed_prometheus_workspace_id = string<br> prometheus_metrics_endpoint = string<br><br> dashboards = object({<br> cp = string<br> mesh = string<br> performance = string<br> service = string<br> })<br> })</pre> | n/a | yes |

## Outputs

Expand Down
2 changes: 1 addition & 1 deletion modules/eks-monitoring/patterns/java/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_pattern_config"></a> [pattern\_config](#input\_pattern\_config) | Configuration object for Java/JMX monitoring | <pre>object({<br/> enable_alerting_rules = bool<br/> enable_recording_rules = bool<br/> scrape_sample_limit = number<br/><br/> enable_dashboards = bool<br/><br/> flux_gitrepository_name = string<br/> flux_gitrepository_url = string<br/> flux_gitrepository_branch = string<br/> flux_kustomization_name = string<br/> flux_kustomization_path = string<br/><br/> managed_prometheus_workspace_id = string<br/> prometheus_metrics_endpoint = string<br/><br/> grafana_dashboard_url = string<br/> })</pre> | n/a | yes |
| <a name="input_pattern_config"></a> [pattern\_config](#input\_pattern\_config) | Configuration object for Java/JMX monitoring | <pre>object({<br> enable_alerting_rules = bool<br> enable_recording_rules = bool<br> scrape_sample_limit = number<br><br> enable_dashboards = bool<br><br> flux_gitrepository_name = string<br> flux_gitrepository_url = string<br> flux_gitrepository_branch = string<br> flux_kustomization_name = string<br> flux_kustomization_path = string<br><br> managed_prometheus_workspace_id = string<br> prometheus_metrics_endpoint = string<br><br> grafana_dashboard_url = string<br> })</pre> | n/a | yes |

## Outputs

Expand Down
2 changes: 1 addition & 1 deletion modules/eks-monitoring/patterns/nginx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ No modules.

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_pattern_config"></a> [pattern\_config](#input\_pattern\_config) | Configuration object for Java/JMX monitoring | <pre>object({<br/> enable_alerting_rules = bool<br/> enable_recording_rules = bool<br/> scrape_sample_limit = number<br/><br/> enable_dashboards = bool<br/><br/> flux_gitrepository_name = string<br/> flux_gitrepository_url = string<br/> flux_gitrepository_branch = string<br/> flux_kustomization_name = string<br/> flux_kustomization_path = string<br/><br/> managed_prometheus_workspace_id = string<br/> prometheus_metrics_endpoint = string<br/><br/> grafana_dashboard_url = string<br/> })</pre> | n/a | yes |
| <a name="input_pattern_config"></a> [pattern\_config](#input\_pattern\_config) | Configuration object for Java/JMX monitoring | <pre>object({<br> enable_alerting_rules = bool<br> enable_recording_rules = bool<br> scrape_sample_limit = number<br><br> enable_dashboards = bool<br><br> flux_gitrepository_name = string<br> flux_gitrepository_url = string<br> flux_gitrepository_branch = string<br> flux_kustomization_name = string<br> flux_kustomization_path = string<br><br> managed_prometheus_workspace_id = string<br> prometheus_metrics_endpoint = string<br><br> grafana_dashboard_url = string<br> })</pre> | n/a | yes |

## Outputs

Expand Down

0 comments on commit a21c5e8

Please sign in to comment.