{"id":15554919,"url":"https://github.com/goyoo/node-k8s-client","last_synced_at":"2025-04-05T06:08:27.187Z","repository":{"id":35718726,"uuid":"39996850","full_name":"Goyoo/node-k8s-client","owner":"Goyoo","description":"kubernetes client of node.js","archived":false,"fork":false,"pushed_at":"2022-06-06T08:45:57.000Z","size":4770,"stargazers_count":164,"open_issues_count":13,"forks_count":57,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-29T05:07:38.851Z","etag":null,"topics":["kubernetes","node","nodejs"],"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/Goyoo.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}},"created_at":"2015-07-31T09:06:08.000Z","updated_at":"2024-08-23T23:04:22.000Z","dependencies_parsed_at":"2022-08-30T06:41:23.679Z","dependency_job_id":null,"html_url":"https://github.com/Goyoo/node-k8s-client","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Goyoo%2Fnode-k8s-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Goyoo%2Fnode-k8s-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Goyoo%2Fnode-k8s-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Goyoo%2Fnode-k8s-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Goyoo","download_url":"https://codeload.github.com/Goyoo/node-k8s-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247294539,"owners_count":20915340,"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":["kubernetes","node","nodejs"],"created_at":"2024-10-02T15:04:42.382Z","updated_at":"2025-04-05T06:08:27.169Z","avatar_url":"https://github.com/Goyoo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n# Nodejs Kubernetes client\n\n\nNode.js client library for Google's Kubernetes Kubectl And API\n\n\n# build\n``` \n    git clone https://github.com/Goyoo/node-k8s-client.git\n    npm install\n    npm run build\n```\n#test\n for test please install [minikube](https://github.com/kubernetes/minikube/releases)\n```\n    \n    mocha test\n```\n\n# Install:\n```\n    npm install k8s\n```\n# Usage\n\n## Create client\n\n```js\nvar K8s = require('k8s')\n\n// use kubectl\n\nvar kubectl = K8s.kubectl({\n    endpoint:  'http://192.168.10.10:8080'\n    , namespace: 'namespace'\n    , binary: '/usr/local/bin/kubectl'\n})\n\n//use restful api\nvar kubeapi = K8s.api({\n\tendpoint: 'http://192.168.10.10:8080'\n\t, version: '/api/v1'\n})\n\n// Configure using kubeconfig\nvar kubeapi = K8s.api({\n    kubeconfig: '/etc/cluster1.yaml'\n    ,version: '/api/v1'\n})\n\nvar kube = K8s.kubectl({\n\tbinary: '/bin/kubectl'\n\t,kubeconfig: '/etc/cluster1.yaml'\n\t,version: '/api/v1'\n});\n\n```\n\n### Options\n\nendpoint\n: URL for API\n\nversion\n: API Version\n\nbinary\n: Path to binary file\n\nkubeconfig\n: Path to kubeconfig\n\n:auth\nSee below authentication section\n\n:strictSSL\nIf set to false, use of the API will not validate SSL certificate. Defualt is true.\n\n#### Authentication\n\nAuthentication to REST API is done via the `auth` option. Currently supported authentication method types are username/password, token and client certificate. Presence of authentication details is checked in this order so if a token is specified as well as a client certificate then a token will be used.\n\nUsername/password:\n\n```\n{\n  \"auth\": {\n    \"username\": \"admin\",\n    \"password\": \"123123\"\n  }\n}\n```\n\nToken:\n\n```\n{\n  \"auth\": {\n    \"token\": \"hcc927ndkcka12\"\n  }\n}\n```\n\nClient certificate:\n\n```\n{\n  \"auth\": {\n    \"clientKey\": fs.readFileSync('k8s-client-key.pem'),\n    \"clientCert\": fs.readFileSync('k8s-client-cert.pem'),\n    \"caCert\": fs.readFileSync('k8s-ca-crt.pem')\n  }\n}\n```\n\n# kubeAPI\n\n#### using callback\n```js\n// method GET\nkubeapi.get('namespaces/default/replicationcontrollers', function(err, data){})\n\n// method POST\nkubeapi.post('namespaces/default/replicationcontrollers', require('./rc/nginx-rc.json'), function(err, data){})\n// method PUT\nkubeapi.put('namespaces/default/replicationcontrollers/nginx', require('./rc/nginx-rc.json'), function(err, data){})\n// method PATCH\nkubeapi.patch('namespaces/default/replicationcontrollers/nginx', [{ op: 'replace', path: '/spec/replicas', value: 2 }], function(err, data){})\n// method DELETE\nkubeapi.delete('namespaces/default/replicationcontrollers/nginx', function(err, data){})\n\n```\n#### using promise\n```js\n// method GET\nkubeapi.get('namespaces/default/replicationcontrollers').then(function(data){}).catch(function(err){})\n// method POST\nkubeapi.post('namespaces/default/replicationcontrollers', require('./rc/nginx-rc.json')).then(function(data){}).catch(function(err){})\n// method PUT\nkubeapi.put('namespaces/default/replicationcontrollers/nginx', require('./rc/nginx-rc.json')).then(function(data){}).catch(function(err){})\n// method PATCH\nkubeapi.patch('namespaces/default/replicationcontrollers/nginx', [{ op: 'replace', path: '/spec/replicas', value: 2 }]).then(function(data){}).catch(function(err){})\n// method DELETE\nkubeapi.delete('namespaces/default/replicationcontrollers/nginx').then(function(data){}).catch(function(err){})\n\n```\n#### using async/await\n```js\n\n!async function()\n{\n    try\n    {\n        // method GET\n        const data1 = await kubeapi.get('namespaces/default/replicationcontrollers')\n        // method POST\n        const data2 = await kubeapi.post('namespaces/default/replicationcontrollers', require('./rc/nginx-rc.json'))\n        // method PUT\n        const data3 = await kubeapi.put('namespaces/default/replicationcontrollers/nginx', require('./rc/nginx-rc.json'))\n        // method PATCH\n        const data4 = await kubeapi.patch('namespaces/default/replicationcontrollers/nginx', [{ op: 'replace', path: '/spec/replicas', value: 2 }])\n        // method DELETE\n        const data5 = await kubeapi.delete('namespaces/default/replicationcontrollers/nginx')\n    }\n    catch(err){\n        console.log(err)\n    }\n}()\n\n```\n\n#### method GET -\u003e watch\n###### using callback\n```js\nvar res = kubeapi.watch('watch/namespaces/default/pods', function(data){\n\t// message\n}, function(err){\n\t// exit\n}, [timeout])\n\n```\n\n###### using rxjs\n```js\nkubeapi.watch('watch/namespaces/default/pods', [timeout]).subscribe(data=\u003e{\n    // message\n}, err=\u003e{\n    // exit\n})\n```\n\n# kubectl (callback, promise, async/await)\n\n### example\n```js\n    //kubectl['type']['action]([arguments], [flags], [callback]): Promise\n\n    //callback\n    kubect.pod.delete('pod_name', function(err, data){})\n    kubect.pod.delete('pod_name', ['--grace-period=0'], function(err, data){})\n    //promise\n    kubect.pod.delete('pod_name').then()\n    kubect.pod.delete('pod_name', ['--grace-period=0']).then()\n    //async/await\n    const data = await kubect.pod.delete('pod_name')\n    const data = await kubect.pod.delete('pod_name',['--grace-period=0'])\n```\n\n### excute command\n```js\n    kubectl.command('get pod pod_name --output=json', function(err, data){})\n    kubectl.command('get pod pod_name --output=json').then()\n    const data = await kubectl.command('get pod pod_name --output=json')\n```\n\n## Pods\n\n### get pod list\n\n```js\nkubectl.pod.list(function(err, pods){})\n\n//selector\nvar label = { name: nginx }\nkubectl.pod.list(label, function(err, pods){})\n```\n\n### get  pod\n\n```js\nkubectl.pod.get('nginx', function(err, pod){})\n\n// label selector\nkubectl.pod.list({ app: 'nginx' }, function(err, pods){}) \n```\n\n### create a pod\n\n```js\nkubectl.pod.create('/:path/pods/nginx.yaml'), function(err, data){})\n```\n\n### delete a pod\n\n```js\nkubectl.pod.delete('nginx', function(err, data){})\n```\n\n### log\n\n```js\nkubectl.pod.log('pod_id1 pod_id2 pod_id3', function(err, log){})\n```\n\n## ReplicationController\n\n### get rc list\n\n```js\nkubectl.rc.list(function(err, pods){})\n```\n\n### get a rc\n\n```js\nkubectl.rc.get('nginx', function(err, pod){})\n```\n\n### create a rc\n\n```js\nkubectl.rc.create('/:path/pods/nginx.yaml'), function(err, data){})\n```\n\n### delete a rc\n\n```js\nkubectl.rc.delete('nginx', function(err, data){})\n\n```\n\n### rolling-update by image name\n\n```js\nkubectl.rc.rollingUpdate('nginx', 'nginx:vserion', function(err, data){})\n```\n\n### rolling-update by file\n\n```js\nkubectl.rc.rollingUpdateByFile('nginx', '/:path/rc/nginx-v2.yaml', function(err, data){})\n```\n\n### change replicas\n\n```js\nkubectl.rc.scale('nginx', 3, function(err, data){})\n```\n\n## Service\n\n### get service list\n\n```js\nkubectl.service.list(function(err, pods){})\n```\n\n### get a service\n\n```js\nkubectl.service.get('nginx', function(err, pod){})\n```\n\n### create a service\n\n```js\nkubectl.service.create('/:path/service/nginx.yaml'), function(err, data){})\n```\n\n### delete a service\n\n```js\nkubectl.service.delete('nginx', function(err, data){})\n```\n\n\n## Node\n\n### get node list\n\n```js\nkubectl.node.list(function(err, nodes){})\n```\n\n### get a node\n\n```js\nkubectl.node.get('node1', function(err, node){})\n```\n\n### create a node\n\n```js\nkubectl.node.create('/:path/nodes/node1.yaml'), function(err, node){})\n```\n\n### delete a node\n\n```js\nkubectl.node.delete('node1', function(err, node){})\n\n\n```\n\n## Namespace\n\n```js\n    kubectl.namespace['fn']\n\n```\n## Daemonset\n\n```js\n    kubectl.daemonset['fn']\n\n```\n## Deployment\n\n```js\n    kubectl.deployment['fn']\n\n```\n## Secrets\n\n```js\n    kubectl.secrets['fn']\n\n```\n## endpoint\n\n```js\n    kubectl.endpoint['fn']\n\n```\n## ingress\n\n```js\n    kubectl.ingress['fn']\n\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoyoo%2Fnode-k8s-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoyoo%2Fnode-k8s-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoyoo%2Fnode-k8s-client/lists"}