{"id":13615441,"url":"https://github.com/sercand/kuberesolver","last_synced_at":"2025-05-13T16:08:03.087Z","repository":{"id":9640467,"uuid":"62142665","full_name":"sercand/kuberesolver","owner":"sercand","description":"Grpc Load Balancer with Kubernetes resolver","archived":false,"fork":false,"pushed_at":"2025-04-07T15:09:43.000Z","size":145,"stargazers_count":573,"open_issues_count":4,"forks_count":79,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-04-12T10:57:00.616Z","etag":null,"topics":["grpc","kubernetes","resolver"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sercand.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2016-06-28T13:22:47.000Z","updated_at":"2025-04-10T20:49:49.000Z","dependencies_parsed_at":"2024-06-18T12:18:34.319Z","dependency_job_id":"05f8176d-8c60-41ee-a30c-af275c51d453","html_url":"https://github.com/sercand/kuberesolver","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sercand%2Fkuberesolver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sercand%2Fkuberesolver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sercand%2Fkuberesolver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sercand%2Fkuberesolver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sercand","download_url":"https://codeload.github.com/sercand/kuberesolver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250514156,"owners_count":21443204,"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":["grpc","kubernetes","resolver"],"created_at":"2024-08-01T20:01:13.725Z","updated_at":"2025-04-23T20:50:00.670Z","avatar_url":"https://github.com/sercand.png","language":"Go","readme":"# kuberesolver\n\nA Grpc name resolver by using kubernetes API.\nIt comes with a small ~250 LOC kubernetes client to find service endpoints. Therefore it won't bloat your binaries.\n\n\n### USAGE\n\n```go\n\n// Import the module\nimport \"github.com/sercand/kuberesolver/v6\"\n\t\n// Register kuberesolver to grpc before calling grpc.Dial\nkuberesolver.RegisterInCluster()\n\n// it is same as\nresolver.Register(kuberesolver.NewBuilder(nil /*custom kubernetes client*/ , \"kubernetes\"))\n\n// if schema is 'kubernetes' then grpc will use kuberesolver to resolve addresses\ncc, err := grpc.Dial(\"kubernetes:///service.namespace:portname\", opts...)\n```\n\nAn url can be one of the following, [grpc naming docs](https://github.com/grpc/grpc/blob/master/doc/naming.md)\n\n```\nkubernetes:///service-name:8080\nkubernetes:///service-name:portname\nkubernetes:///service-name.namespace:8080\nkubernetes:///service-name.namespace.svc.cluster_name\nkubernetes:///service-name.namespace.svc.cluster_name:8080\n\nkubernetes://namespace/service-name:8080\nkubernetes://service-name:8080/\nkubernetes://service-name.namespace:8080/\nkubernetes://service-name.namespace.svc.cluster_name\nkubernetes://service-name.namespace.svc.cluster_name:8080\n```\n_* Please note that the cluster_name is not used in resolving the endpoints of a Service. It is only there to support fully qualified service names, e.g._ `test.default.svc.cluster.local`.\n\n### Using alternative Schema\n\nUse `RegisterInClusterWithSchema(schema)` instead of `RegisterInCluster` on start.\n\n### Client Side Load Balancing\n\nYou need to pass grpc.WithBalancerName option to grpc on dial: \n\n```go\ngrpc.DialContext(ctx,  \"kubernetes:///service:grpc\", grpc.WithBalancerName(\"round_robin\"), grpc.WithInsecure())\n```\nThis will create subconnections for each available service endpoints.\n\n### How is this different from dialing to `service.namespace:8080`\n\nConnecting to a service by dialing to `service.namespace:8080` uses DNS and it returns service stable IP. Therefore, gRPC doesn't know the endpoint IP addresses and it fails to reconnect to target services in case of failure.  \n\nKuberesolver uses kubernetes API to get and watch service endpoint IP addresses. \nSince it provides and updates all available service endpoints, together with a client-side balancer you can achive zero downtime deployments.\n\n### RBAC\n\nYou need give `GET` and `WATCH` access to the `endpointslices` if you are using RBAC in your cluster.\n\n\n### Using With TLS\n\nYou need to a certificate with name `service-name.namespace` in order to connect with TLS to your services.\n","funding_links":[],"categories":["Language-Specific","Language-Specific Tools","Kubernetes生态工具与服务","Go"],"sub_categories":["Go"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsercand%2Fkuberesolver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsercand%2Fkuberesolver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsercand%2Fkuberesolver/lists"}