{"_id":"@codeanker/nodejs-helm","_rev":"5-b3e57a54ca64d9de579bd0343e36dfe0","name":"@codeanker/nodejs-helm","dist-tags":{"latest":"0.3.0"},"versions":{"0.3.0":{"name":"@codeanker/nodejs-helm","author":{"name":"CODEANKER GmbH"},"version":"0.3.0","description":"Node helm created for javascript developers that works with helm.sh package manager for Kubernetes.","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"repository":{"type":"git","url":"git+https://github.com/NikhilM98/nodejs-helm.git"},"license":"MIT","keywords":["helm","helm3","nodejs-helm","node-helm","yaml","kubectl"],"bugs":{"url":"https://github.com/NikhilM98/nodejs-helm/issues"},"homepage":"https://github.com/NikhilM98/nodejs-helm#readme","dependencies":{"yaml":"^1.10.0"},"gitHead":"191b12e5ad70437c1b5db170b58ee039db7a0ef2","_id":"@codeanker/nodejs-helm@0.3.0","_nodeVersion":"12.16.2","_npmVersion":"6.14.4","dist":{"integrity":"sha512-K1L2Zfqddz02Wd6e66NZRUQBSd7j/JjAuQJ1ymSm8JRXWjKW+mQ5gJEYAk64xkg0renKxjDlleeWdoAf5shr5Q==","shasum":"1c1e3f2fd41225db1eca03e4c35d36b0cc7a2365","tarball":"https://registry.npmjs.org/@codeanker/nodejs-helm/-/nodejs-helm-0.3.0.tgz","fileCount":10,"unpackedSize":18855,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfmFpxCRA9TVsSAnZWagAAp/MQAIRiq0evq+BYVPCmf+yq\nK3NY6ETzGrWvJYpjq3H5CRmqTQQhEwnTl+iOkCmo3QUkTSCw5cPd4kpM5BdL\nhHFA9igHL3tahKHWY0YcGYIwhb9H5RCfcs4Md6pwxNEyBeUlsehFIHdUMdXc\nQ8HV8iTGTNP0ZOq6O1vVbq4VI8cdr6kHoU/sxq3aPh1b75qWaBubd3hmPFmo\nwE5ZN/igQkCz/evsE97tJ3hEsyTgp2+WI/XeFO3KcnnoB/zxNyzdnx8f6kBv\nsSX+grAC2b7plAywvpRWsQtmUEdwAwqGUXTnbS9dS1dC/8DkDDakT2MXoDc6\nig8a032EYfh5wP2NKrQZMr+XBehGvBCFkvaTrTub1AoHnq/UrNJf6jYGVaii\n8uEyChQWgVK9x7nS0xYIHNLxy4reJ+EspP3jPm1pHZMtZWbEIwMscqXfGlJO\ngdy1z7EtgGgAgrB3Kry0/FbUH+bd+asAFJsmpOOEfp9sToun6FvQ8xsnGCz1\nB28qEP5GqyKgtTn802Txlj6fQVSerJ2Lm3txQMKAzeTXOK8ggEi0HL/iifFt\n/b7Q6yfmYHOtCSstyvbD8nNjeA2c9CyeW75zfAkAoDZf9CxM75goRZlcvYZL\nYZZq+N3o6LtvfN9XVrYQeddaFC5TM8NyXkASEGlGpkJwHdbzF8YW4TxQhjHv\n3vPs\r\n=geMT\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCt1tAE3ZLz3AxlQAAKtbOfjxdg5FMIIwTHGdQLXFeyxQIhANKu+y20cjZ/XpA1Zrnlr+vxmCO9bQDxJza9NNNsnuH4"}]},"maintainers":[{"name":"kimjongjonas","email":"jonas.leitner93@gmail.com"},{"name":"torge.juergensen","email":"torge.juergensen@codeanker.de"},{"name":"swiatek","email":"daniel.swiatek@codeanker.de"},{"name":"supermomme","email":"momme@juergensen.me"},{"name":"superbarne","email":"barne.juergensen@googlemail.com"}],"_npmUser":{"name":"swiatek","email":"daniel.swiatek@codeanker.de"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/nodejs-helm_0.3.0_1603820144579_0.7006859799009788"},"_hasShrinkwrap":false}},"time":{"created":"2020-10-27T17:35:44.407Z","0.3.0":"2020-10-27T17:35:44.786Z","modified":"2022-06-08T08:19:53.543Z"},"maintainers":[{"email":"barne.juergensen@googlemail.com","name":"superbarne"},{"email":"daniel.swiatek@codeanker.de","name":"swiatek"}],"description":"Node helm created for javascript developers that works with helm.sh package manager for Kubernetes.","homepage":"https://github.com/NikhilM98/nodejs-helm#readme","keywords":["helm","helm3","nodejs-helm","node-helm","yaml","kubectl"],"repository":{"type":"git","url":"git+https://github.com/NikhilM98/nodejs-helm.git"},"author":{"name":"CODEANKER GmbH"},"bugs":{"url":"https://github.com/NikhilM98/nodejs-helm/issues"},"license":"MIT","readme":"# nodejs-helm\r\n`nodejs-helm` was created for javascript developers who work with [helm.sh package manager for Kubernetes](https://helm.sh/).\r\nThe package is a wrapper that integrates with the helm.sh process.\r\n\r\n## Installation\r\n```\r\nnpm install nodejs-helm\r\n```\r\n\r\n## Get Started\r\nSetup your helm.sh file location - for linux or windows\r\n```\r\nlet helmBinary = '/usr/local/bin/helm';\r\n\r\nif (process.platform === \"win32\") {\r\n    helmBinary = 'helm';\r\n}\r\n```\r\n\r\nrequire Helm class\r\n```\r\nlet Promise = require(\"bluebird\");\r\nconst Helm = require(\"nodejs-helm\").Helm;\r\nlet helm = Promise.promisifyAll(new Helm({helmCommand: helmBinary}));\r\n```\r\n\r\n## API\r\n\r\n### List releases\r\nhttps://helm.sh/docs/helm/helm_list/\r\n```\r\nlet options = {\r\n    allNamespaces: true, // optional\r\n    max: 10,\r\n    offset: 20\r\n}; // all parameters are optional\r\nlet releases = await helm.listAsync(options);\r\n```\r\n\r\n### Get a release\r\nhttps://helm.sh/docs/helm/helm_get/\r\n```\r\nlet options = {\r\n    releaseName: 'myReleaseName',\r\n    subCommand: 'all',\r\n    namespace: 'dev' // optional\r\n}\r\nlet history = await helm.getAsync(options);\r\n```\r\nAvailable Sub-Commands:\r\n```\r\nall         download all information for a named release\r\nhooks       download all hooks for a named release\r\nmanifest    download the manifest for a named release\r\nnotes       download the notes for a named release\r\nvalues      download the values file for a named release\r\n```\r\n\r\n### Install a release\r\nhttps://helm.sh/docs/helm/helm_install/\r\n```\r\nlet options = {\r\n    chartName: \"sourceChartName\",\r\n    releaseName: \"myReleaseName\",\r\n    namespace: \"dev\", // optional\r\n    version: \"latest\", // optional\r\n    values: {\r\n        \"organisation\":\"Sugar Labs\"\r\n    } // custom values - optional\r\n};\r\nreturn installation = await helm.installAsync(options);\r\n```\r\n\r\n### Upgrade a release\r\nhttps://helm.sh/docs/helm/helm_upgrade/\r\n```\r\nlet options = {\r\n    reuseValues: shouldReuseValues, // boolean value (when upgrading, reuse the last release's values) - optional\r\n    resetValues: shouldResetValues, // boolean value (when upgrading, reset the values to the ones built into the chart) - optional\r\n    version: \"latest\", // optional\r\n    install: shouldInstall, // boolean value (if a release by this name doesn't already exist, run an install) -- optional\r\n    chartName: \"./chartFolder\",\r\n    releaseName: myReleaseName,\r\n    namespace: 'dev', // optional\r\n    values: {\r\n        \"organisation\":\"Sugar Labs\"\r\n    }\r\n}\r\nreturn await helm.upgradeAsync(options);\r\n```\r\n\r\n### Uninstall a release\r\nhttps://helm.sh/docs/helm/helm_uninstall/\r\n```\r\nlet options = {\r\n    releaseName: 'myReleaseName',\r\n    namespace: 'dev' // optional\r\n}\r\nreturn await helm.uninstallAsync(options);\r\n```\r\n\r\n### Get release history\r\nhttps://helm.sh/docs/helm/helm_history/\r\n```\r\nlet options = {\r\n    releaseName: 'myReleaseName',\r\n    namespace: 'dev' // optional\r\n}\r\nlet history = await helm.historyAsync(options);\r\n```\r\n\r\n### Test a release\r\nhttps://helm.sh/docs/helm/helm_test/\r\n```\r\nlet options = {\r\n    releaseName: 'myReleaseName',\r\n    namespace: 'dev' // optional\r\n}\r\nlet test = await helm.testAsync(options);\r\n```\r\n\r\n### Rollback a release to a previous revision\r\nhttps://helm.sh/docs/helm/helm_rollback/\r\n```\r\nlet options = {\r\n    releaseName: 'myReleaseName',\r\n    revision: 0 // number,\r\n    namespace: 'dev' // optional\r\n};\r\nlet rollback = await helm.rollbackAsync(options);\r\n```\r\n\r\n### Get a release status\r\nhttps://helm.sh/docs/helm/helm_status/\r\n```\r\nlet options = {\r\n    releaseName: 'myReleaseName',\r\n    namespace: 'dev' // optional\r\n}\r\nlet status = await helm.statusAsync(options);\r\n```\r\n","readmeFilename":"README.md"}