better README

Author: yacut

README.md

@@ -1,6 +1,6 @@
 # Qdrant Terraform Module
 
-[![Terraform Registry URL](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white)](https://registry.terraform.io/modules/ilert/qdrant/kubernetes/latest)
+[![Terraform Registry URL](https://img.shields.io/badge/terraform-%235835CC.svg?style=for-the-badge&logo=terraform&logoColor=white)](https://registry.terraform.io/modules/iLert/qdrant/kubernetes/latest)
 
 Terraform module to deploy Qdrant vector DB on kubernetes
 
@@ -12,7 +12,7 @@ Create a `main.tf` file with the following content:
 
 ```terraform
 module "qdrant" {
-  source       = "ilert/qdrant/kubernetes"
+  source       = "iLert/qdrant/kubernetes"
   version      = "0.1.0"
   name         = "qdrant"
   namespace    = "default"
@@ -27,3 +27,24 @@ terraform init
 terraform apply
 ```
 
+## Modules
+
+No modules.
+
+## Inputs
+
+| Name                                                                     | Description                             | Type     | Default   | Required |
+| ------------------------------------------------------------------------ | --------------------------------------- | -------- | --------- | :------: |
+| <a name="input_name"></a> [name](#input\_name)                           | Kubernetes resources name               | `string` | `qdrant`  |    no    |
+| <a name="input_namespace"></a> [namespace](#input\_namespace)            | Kubernetes namespace                    | `string` | `default` |    no    |
+| <a name="input_replicas"></a> [replicas](#input\_replicas)               | Replicas count for the Qdrant instances | `number` | `2`       |    no    |
+| <a name="input_memory_limit"></a> [memory\_limit](#input\_memory\_limit) | Memory limit for the Qdrant instances   | `string` | `128Mi`   |    no    |
+| <a name="input_storage_size"></a> [storage\_size](#input\_storage\_size) | Storage size for the Qdrant instances   | `string` | `10Gi`    |    no    |
+
+## Outputs
+
+| Name                                                                                          | Description                                                |
+| --------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
+| <a name="output_service_name"></a> [service\_name](#output\_service\_name)                    | The name of the Qdrant service in the kubernetes namespace |
+| <a name="output_api_key"></a> [api\_key](#output\_api\_key)                                   | The generated api key for the Qdrant API                   |
+| <a name="output_read_only_api_key"></a> [read\_only\_api\_key](#output\_read\_only\_api\_key) | The generated read only api key for the Qdrant API         |

output.tf

@@ -0,0 +1,14 @@
+output "service_name" {
+  value       = kubernetes_service.this.metadata[0].name
+  description = "The name of the Qdrant service in the kubernetes namespace"
+}
+
+output "api_key" {
+  value       = random_password.qdrant-api-key.result
+  description = "The generated api key for the Qdrant API"
+}
+
+output "read_only_api_key" {
+  value       = random_password.qdrant-read-only-api-key.result
+  description = "The generated read only api key for the Qdrant API"
+}

statefulset.tf

@@ -123,6 +123,11 @@ resource "kubernetes_stateful_set" "this" {
             value = "/qdrant/init/.qdrant-initialized"
           }
 
+          # env {
+          #   name  = "QDRANT__TELEMETRY_DISABLED"
+          #   value = "true"
+          # }
+
           lifecycle {
             pre_stop {
               exec {

variables.tf

@@ -11,16 +11,19 @@ variable "name" {
 }
 
 variable "replicas" {
-  type    = number
-  default = 2
+  type        = number
+  description = "Replicas count for the Qdrant instances"
+  default     = 2
 }
 
 variable "memory_limit" {
-  type    = string
-  default = "128Mi"
+  type        = string
+  description = "Memory limit for the Qdrant instances"
+  default     = "128Mi"
 }
 
 variable "storage_size" {
-  type    = string
-  default = "10Gi"
+  type        = string
+  description = "Storage size for the Qdrant instances"
+  default     = "10Gi"
 }