{"id":18662539,"url":"https://github.com/zcong1993/grpc-resolver-k8s","last_synced_at":"2025-04-11T21:31:53.361Z","repository":{"id":37798540,"uuid":"405819741","full_name":"zcong1993/grpc-resolver-k8s","owner":"zcong1993","description":"k8s resolver for @grpc/grpc-js","archived":false,"fork":false,"pushed_at":"2024-10-23T20:23:51.000Z","size":300,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-24T17:46:07.977Z","etag":null,"topics":["grpc","grpc-node","grpc-resolver","k8s"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/zcong1993.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}},"created_at":"2021-09-13T03:25:00.000Z","updated_at":"2024-10-23T20:23:54.000Z","dependencies_parsed_at":"2023-10-23T19:34:17.049Z","dependency_job_id":"70fed97c-2cb0-4e52-843e-d3bf6725aca3","html_url":"https://github.com/zcong1993/grpc-resolver-k8s","commit_stats":{"total_commits":101,"total_committers":4,"mean_commits":25.25,"dds":0.3465346534653465,"last_synced_commit":"b8b9251386f7940cb71548e695a4450b8c8342a2"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcong1993%2Fgrpc-resolver-k8s","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcong1993%2Fgrpc-resolver-k8s/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcong1993%2Fgrpc-resolver-k8s/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zcong1993%2Fgrpc-resolver-k8s/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zcong1993","download_url":"https://codeload.github.com/zcong1993/grpc-resolver-k8s/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223479567,"owners_count":17151931,"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","grpc-node","grpc-resolver","k8s"],"created_at":"2024-11-07T08:12:50.853Z","updated_at":"2024-11-07T08:12:52.017Z","avatar_url":"https://github.com/zcong1993.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grpc-resolver-k8s\n\n[![NPM version](https://img.shields.io/npm/v/@zcong/grpc-resolver-k8s.svg?style=flat)](https://npmjs.com/package/@zcong/grpc-resolver-k8s)\n[![NPM downloads](https://img.shields.io/npm/dm/@zcong/grpc-resolver-k8s.svg?style=flat)](https://npmjs.com/package/@zcong/grpc-resolver-k8s)\n\n\u003c!-- [![codecov](https://codecov.io/gh/zcong1993/grpc-resolver-k8s/branch/master/graph/badge.svg)](https://codecov.io/gh/zcong1993/grpc-resolver-k8s) --\u003e\n\n\u003e k8s resolver for @grpc/grpc-js\n\n## Install\n\n```bash\n$ yarn add @zcong/grpc-resolver-k8s\n# or npm\n$ npm i @zcong/grpc-resolver-k8s --save\n```\n\n## Usage\n\nMake sure the client pod service account have enough permissions to access k8s resource endpoints. Can see [account.yaml](./example/k8s/account.yaml).\n\n### client\n\n```ts\nimport { K8sScheme, setup } from '@zcong/grpc-resolver-k8s'\n\nsetup()\n\nconst serviceName = process.env.SERVICE_NAME || 'test-grpc-server'\nconst servicePort = process.env.SERVICE_PORT || '8080'\nconst serviceNs = process.env.SERVICE_NS || 'default'\n\nconst main = async () =\u003e {\n  const c = new HelloClient(\n    `${K8sScheme}://${serviceNs}/${serviceName}:${servicePort}`, // use service name with K8sScheme\n    grpc.credentials.createInsecure(),\n    { 'grpc.service_config': '{\"loadBalancingConfig\": [{\"round_robin\": {}}]}' } // don't forget use round_robin lb, default is pick first\n  )\n}\n```\n\nFor more details, please check [example](./example).\n\n### debug\n\nSet env `GRPC_NODE_TRACE=k8s_resolver` and `GRPC_NODE_VERBOSITY=DEBUG`.\n\n## License\n\nMIT \u0026copy; zcong1993\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcong1993%2Fgrpc-resolver-k8s","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzcong1993%2Fgrpc-resolver-k8s","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzcong1993%2Fgrpc-resolver-k8s/lists"}