{"id":35365630,"url":"https://github.com/sparkfabrik/terraform-typesense-keys","last_synced_at":"2026-01-13T20:03:23.991Z","repository":{"id":327755485,"uuid":"1110645942","full_name":"sparkfabrik/terraform-typesense-keys","owner":"sparkfabrik","description":"Terraform module to manage Typesense keys","archived":false,"fork":false,"pushed_at":"2025-12-16T09:36:07.000Z","size":31,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-07T11:41:15.033Z","etag":null,"topics":["iac","infrastructure-as-code","terraform","typesense"],"latest_commit_sha":null,"homepage":"","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sparkfabrik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-12-05T14:04:39.000Z","updated_at":"2025-12-16T09:35:15.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/sparkfabrik/terraform-typesense-keys","commit_stats":null,"previous_names":["sparkfabrik/terraform-typesense-keys"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/sparkfabrik/terraform-typesense-keys","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfabrik%2Fterraform-typesense-keys","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfabrik%2Fterraform-typesense-keys/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfabrik%2Fterraform-typesense-keys/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfabrik%2Fterraform-typesense-keys/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sparkfabrik","download_url":"https://codeload.github.com/sparkfabrik/terraform-typesense-keys/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfabrik%2Fterraform-typesense-keys/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28399442,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-13T14:36:09.778Z","status":"ssl_error","status_checked_at":"2026-01-13T14:35:19.697Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["iac","infrastructure-as-code","terraform","typesense"],"created_at":"2026-01-02T01:53:15.753Z","updated_at":"2026-01-13T20:03:23.986Z","avatar_url":"https://github.com/sparkfabrik.png","language":"HCL","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typesense Keys Module\n\nThis module creates Typesense API keys and optionally a Kubernetes secret.\n\n## What it creates\n\n- **Read-only API key**: For document search operations.\n- **Full access API key**: For all Typesense operations. \n- **Kubernetes secret**: Contains host URL, API keys, and collection prefix (optional).\n\n## Diagram\n```mermaid\nflowchart LR\n  typesense_module[\"Typesense Keys Module\"] -- \"generates\" --\u003e api_keys[\"API Keys (RO + Full Access)\"]\n  api_keys -- \"stored in\" --\u003e k8s_secret[\"Kubernetes Secret\"]\n  terraform_config[\"Terraform Config\"] -- \"configures\" --\u003e typesense_provider[\"Typesense Provider\"]\n  typesense_provider -- \"manages\" --\u003e typesense_module\n  projects[\"Projects\"] -- \"consumes\" --\u003e k8s_secret\n```\n## Usage\n\n### Basic usage with collection prefix\n\n```terraform\nmodule \"typesense_keys\" {\n  source = \"github.com/sparkfabrik/terraform-typesense-keys?ref=X.Y.Z\"\n  \n  collection_prefix        = \"myproject\"\n  secret_namespace         = \"myproject-stage\"\n  secret_name              = \"myproject-typesense\"\n  typesense_external_host  = \"typesense.example.com\"\n  typesense_external_port  = 443\n  typesense_external_proto = \"https\"\n  typesense_internal_host  = \"typesense.default.svc.cluster.local\"\n  typesense_internal_port  = 8108\n  typesense_internal_proto = \"http\"\n}\n```\n\n### Without collection prefix (all collections)\n\nIf you omit the `collection_prefix`, the API keys will have access to all collections (`*`):\n\n```terraform\nmodule \"typesense_keys\" {\n  source = \"github.com/sparkfabrik/terraform-typesense-keys?ref=X.Y.Z\"\n  \n  secret_namespace         = \"myproject-stage\"\n  secret_name              = \"myproject-typesense\"\n  typesense_external_host  = \"typesense.example.com\"\n  typesense_internal_host  = \"typesense.default.svc.cluster.local\"\n}\n```\n\n### Without Kubernetes secret\n\nIf you only need the API keys without creating a Kubernetes secret, omit the `secret_name`:\n\n```terraform\nmodule \"typesense_keys\" {\n  source = \"github.com/sparkfabrik/terraform-typesense-keys?ref=X.Y.Z\"\n  \n  collection_prefix        = \"myproject\"\n  typesense_external_host  = \"typesense.example.com\"\n  typesense_internal_host  = \"typesense.default.svc.cluster.local\"\n}\n```\n\n\u003c!-- BEGIN_TF_DOCS --\u003e\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_kubernetes\"\u003e\u003c/a\u003e [kubernetes](#provider\\_kubernetes) | \u003e= 2.21 |\n| \u003ca name=\"provider_random\"\u003e\u003c/a\u003e [random](#provider\\_random) | \u003e= 3.4.3 |\n| \u003ca name=\"provider_typesense\"\u003e\u003c/a\u003e [typesense](#provider\\_typesense) | 0.0.5 |\n\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.2 |\n| \u003ca name=\"requirement_kubernetes\"\u003e\u003c/a\u003e [kubernetes](#requirement\\_kubernetes) | \u003e= 2.21 |\n| \u003ca name=\"requirement_random\"\u003e\u003c/a\u003e [random](#requirement\\_random) | \u003e= 3.4.3 |\n| \u003ca name=\"requirement_typesense\"\u003e\u003c/a\u003e [typesense](#requirement\\_typesense) | 0.0.5 |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_collection_prefix\"\u003e\u003c/a\u003e [collection\\_prefix](#input\\_collection\\_prefix) | The collection prefix for Typesense keys | `string` | `\"\"` | no |\n| \u003ca name=\"input_secret_name\"\u003e\u003c/a\u003e [secret\\_name](#input\\_secret\\_name) | The name of the Kubernetes secret | `string` | `\"\"` | no |\n| \u003ca name=\"input_secret_namespace\"\u003e\u003c/a\u003e [secret\\_namespace](#input\\_secret\\_namespace) | The Kubernetes namespace where the secret will be created | `string` | `\"\"` | no |\n| \u003ca name=\"input_typesense_external_host\"\u003e\u003c/a\u003e [typesense\\_external\\_host](#input\\_typesense\\_external\\_host) | The Typesense host URL | `string` | n/a | yes |\n| \u003ca name=\"input_typesense_external_port\"\u003e\u003c/a\u003e [typesense\\_external\\_port](#input\\_typesense\\_external\\_port) | The Typesense port | `number` | `443` | no |\n| \u003ca name=\"input_typesense_external_proto\"\u003e\u003c/a\u003e [typesense\\_external\\_proto](#input\\_typesense\\_external\\_proto) | The Typesense protocol | `string` | `\"https\"` | no |\n| \u003ca name=\"input_typesense_internal_host\"\u003e\u003c/a\u003e [typesense\\_internal\\_host](#input\\_typesense\\_internal\\_host) | The Typesense host URL | `string` | n/a | yes |\n| \u003ca name=\"input_typesense_internal_port\"\u003e\u003c/a\u003e [typesense\\_internal\\_port](#input\\_typesense\\_internal\\_port) | The Typesense port | `number` | `8108` | no |\n| \u003ca name=\"input_typesense_internal_proto\"\u003e\u003c/a\u003e [typesense\\_internal\\_proto](#input\\_typesense\\_internal\\_proto) | The Typesense protocol | `string` | `\"http\"` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_secret_name\"\u003e\u003c/a\u003e [secret\\_name](#output\\_secret\\_name) | The name of the created Kubernetes secret |\n| \u003ca name=\"output_secret_namespace\"\u003e\u003c/a\u003e [secret\\_namespace](#output\\_secret\\_namespace) | The namespace of the created Kubernetes secret |\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [kubernetes_secret_v1.typesense_credentials](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/secret_v1) | resource |\n| [random_password.full_access_key](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |\n| [random_password.readonly_key](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/password) | resource |\n| [typesense_key.full_access](https://registry.terraform.io/providers/cysp/typesense/0.0.5/docs/resources/key) | resource |\n| [typesense_key.readonly](https://registry.terraform.io/providers/cysp/typesense/0.0.5/docs/resources/key) | resource |\n\n## Modules\n\nNo modules.\n\n\u003c!-- END_TF_DOCS --\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfabrik%2Fterraform-typesense-keys","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparkfabrik%2Fterraform-typesense-keys","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfabrik%2Fterraform-typesense-keys/lists"}