{"id":20761401,"url":"https://github.com/philips-labs/terraform-cloudfoundry-promregator","last_synced_at":"2025-03-11T17:19:50.266Z","repository":{"id":49968198,"uuid":"331269808","full_name":"philips-labs/terraform-cloudfoundry-promregator","owner":"philips-labs","description":"Terraform module to deploy promregator to cloudfoundry","archived":false,"fork":false,"pushed_at":"2021-06-07T14:50:51.000Z","size":21,"stargazers_count":1,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-18T05:30:48.955Z","etag":null,"topics":["cloudfoundry","terraform"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/philips-labs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2021-01-20T10:22:53.000Z","updated_at":"2021-06-07T14:49:55.000Z","dependencies_parsed_at":"2022-07-31T00:07:51.801Z","dependency_job_id":null,"html_url":"https://github.com/philips-labs/terraform-cloudfoundry-promregator","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-labs%2Fterraform-cloudfoundry-promregator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-labs%2Fterraform-cloudfoundry-promregator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-labs%2Fterraform-cloudfoundry-promregator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philips-labs%2Fterraform-cloudfoundry-promregator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/philips-labs","download_url":"https://codeload.github.com/philips-labs/terraform-cloudfoundry-promregator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243076603,"owners_count":20232438,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudfoundry","terraform"],"created_at":"2024-11-17T10:19:26.597Z","updated_at":"2025-03-11T17:19:50.248Z","avatar_url":"https://github.com/philips-labs.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# terraform-cloudfoundry-promregator\n\nTerraform module to deploy promregator to cloudfoundry.\n\nThis module will deploy a promregator instance to cloudfoundry and will configure it to aggregate for the org and space name configured in the settings.\n\nYou can configure the targets by adding a map to the promregator_targets property with the properties that you would like to configure for that target. The possible values can be seen in [the promregator config](https://github.com/promregator/promregator/blob/master/docs/config.md)\n\nThis module does not configure any internal network policies required to allow promregator or prometheus to connect to the apps being monitored. You will need to configure these manually.\n\n## Example usage\n\n```tf\nmodule \"promregator\" {\n  source = \"github.com/philips-labs/terraform-cloudfoundry-promregator\"\n\n  domain          = \"my.domain\"\n  org_name        = \"my-deployment-org\"\n  space_id        = \"my-deployment-space-id\"\n  cf_api_host     = \"api.mycf.com\"\n  cf_username     = \"myuser\"\n  cf_password     = \"mypassword\"\n  docker_username = \"docker-user\"\n  docker_password = \"docker-password\"\n\n  promregator_targets = [{\n    orgname             = \"org-to-be-promregated\"\n    spacename           = \"spacetobepromregated\"\n    protocol            = \"http\"\n    preferredrouteregex = \".*.apps.internal\"\n    anotherconfig       = \"my value\"\n  }]\n}\n```\n\n## Requirements\n\n| Name         | Version     |\n| ------------ | ----------- |\n| terraform    | \u003e= 0.13.0   |\n| cloudfoundry | \u003e= 0.1206.0 |\n\n## Providers\n\n| Name         | Version     |\n| ------------ | ----------- |\n| cloudfoundry | \u003e= 0.1206.0 |\n| random       | n/a         |\n\n## Inputs\n\n| Name                     | Description                                                                                                                          | Type                                                                                                  | Default                           | Required |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- | --------------------------------- | :------: |\n| cf_api_host              | The cf api host to use for discovery of the apps in the metrics org and space                                                        | `string`                                                                                              | n/a                               |   yes    |\n| cf_password              | Credentials for cf_api_host                                                                                                          | `string`                                                                                              | n/a                               |   yes    |\n| cf_username              | Credentials for cf_api_host                                                                                                          | `string`                                                                                              | n/a                               |   yes    |\n| disk_quota               | The amount of disk space that should be allocated to the promregator app by CloudFoundry                                             | `number`                                                                                              | `1024`                            |    no    |\n| docker_password          | The docker password used to pull the promregator_docker_image                                                                        | `string`                                                                                              | `\"\"`                              |    no    |\n| docker_username          | The docker username used to pull the promregator_docker_image                                                                        | `string`                                                                                              | `\"\"`                              |    no    |\n| domain                   | The cf domain that will be used for the route on the promregator app                                                                 | `string`                                                                                              | `\"apps.internal\"`                 |    no    |\n| environment              | Environment variables to be passed to the promregator instance. These will be merged with and overwrite the vars set in this module. | `map(any)`                                                                                            | `{}`                              |    no    |\n| instances                | The number of instances of the promregator app to be run                                                                             | `number`                                                                                              | `1`                               |    no    |\n| memory                   | The amount of memory that should be allocated to the app by CloudFoundry                                                             | `number`                                                                                              | `512`                             |    no    |\n| name_postfix             | The postfix string to append to the space, hostname, etc. Prevents namespace clashes                                                 | `string`                                                                                              | `\"\"`                              |    no    |\n| network_policies         | The container-to-container network policies to create with Promregator as the source app                                             | \u003cpre\u003elist(object({\u003cbr\u003e destination_app = string\u003cbr\u003e protocol = string\u003cbr\u003e port = string\u003cbr\u003e }))\u003c/pre\u003e | `[]`                              |    no    |\n| org_name                 | The name of the cf organisation to create the promregator instance in                                                                | `string`                                                                                              | n/a                               |   yes    |\n| promregator_docker_image | The docker image to use for promregator                                                                                              | `string`                                                                                              | `\"promregator/promregator:0.8.5\"` |    no    |\n| promregator_targets      | A list of maps representing the properties of the target to be configured. These are the config values from propergator targets      | `list(map(any))`                                                                                      | n/a                               |   yes    |\n| space_id                 | The id of the cf space to create the promregator instance in                                                                         | `string`                                                                                              | n/a                               |   yes    |\n\n## Outputs\n\n| Name                 | Description                                 |\n| -------------------- | ------------------------------------------- |\n| promregator_endpoint | The endpoint where Promregator is reachable |\n| promregator_id       | The Promregator app id                      |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips-labs%2Fterraform-cloudfoundry-promregator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilips-labs%2Fterraform-cloudfoundry-promregator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilips-labs%2Fterraform-cloudfoundry-promregator/lists"}