Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fireblinkltd/fbl-plugins-k8s-helm
FBL plugin for K8s Helm CLI
https://github.com/fireblinkltd/fbl-plugins-k8s-helm
automation fbl helm k8s kubernetes kubernetes-deployment plugins
Last synced: about 2 months ago
JSON representation
FBL plugin for K8s Helm CLI
- Host: GitHub
- URL: https://github.com/fireblinkltd/fbl-plugins-k8s-helm
- Owner: FireBlinkLTD
- License: mit
- Created: 2019-04-13T12:59:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-06T09:07:12.000Z (4 months ago)
- Last Synced: 2024-10-13T11:44:02.670Z (2 months ago)
- Topics: automation, fbl, helm, k8s, kubernetes, kubernetes-deployment, plugins
- Language: TypeScript
- Size: 1.36 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# FBL Plugins: K8s Helm
Install, Update, Delete helm chart releases with ease in your [fbl](https://fbl.fireblink.com) flows.
[](https://github.com/FireBlinkLTD/fbl-plugins-k8s-helm/actions?query=workflow%3ATests)
[](https://snyk.io/test/github/FireBlinkLTD/fbl-plugins-k8s-helm)
[](https://codecov.io/gh/FireBlinkLTD/fbl-plugins-k8s-helm)
[](https://lgtm.com/projects/g/FireBlinkLTD/fbl-plugins-k8s-helm/alerts/)
[](https://lgtm.com/projects/g/FireBlinkLTD/fbl-plugins-k8s-helm/context:javascript)
## Purpose
[fbl](https://fbl.fireblink.com) is a **flow** automation tool. That generally means it can automate any kind of routine processes and allows to create some really complex combinations of actions, even non related to deployment (probably, the main reason why you're currently reading this now).
While cluster deployment is in some cases really simple and some PaaS providers already support cluster creation withing few commands / mouse clicks, service deployment into the cluster is not trivial like that.
At FireBlink we generally treat entire cluster as a single product. As any other software product update of any of its dependencies may lead to unexpected behaviour. We never trust 3rd party vendors to have backward compatibility. So the only way we can be sure that all the services will work consistantly across environment is lock of the versions.
As cluster is a product, it has it's own version, migration scripts, and set of helm/kubectl commands required to stand up / update the cluster.
To help with that 2 main plugins for FBL has been created:
- [@fbl-plugins/k8s-kubectl](https://github.com/FireBlinkLTD/fbl-plugins-k8s-kubectl) - allows to create/update/delete ConfigMaps, Secrets, CRDs, etc.
- [@fbl-plugins/k8s-helm](https://github.com/FireBlinkLTD/fbl-plugins-k8s-helm) - install/update or delete of helm releases
Generally both plugins are used together, as Secrets should be created outside the helm chart.
Sensitive information can be hosted inside the Git repo and encrypted with [@fbl-plugins/crypto](https://github.com/FireBlinkLTD/fbl-plugins-crypto).
Flexibility of the deployment is the key concept of FBL and plugins, as we never know what challenges we need to resolve the following day.
## Examples
Check [fbl-examples](https://github.com/FireBlinkLTD/fbl-examples) repository for usage examples.
## Integration
There are multiple ways how plugin can be integrated into your flow.
### package.json
This is the most recommended way. Create `package.json` next to your flow file with following content:
```json
{
"name": "flow-name",
"version": "1.0.0",
"description": "",
"scripts": {
"fbl": "fbl"
},
"license": "UNLICENSED",
"dependencies": {
"@fbl-plugins/k8s-helm": "1.1.1",
"fbl": "1.12.0"
}
}
```
Then you can install dependencies as any other node module `yarn install` depending on the package manager of your choice.
After that you can use `yarn fbl ` to execute your flow or even register a custom script inside "scripts".
### Global installation
`npm i -g @fbl-plugins/k8s-helm`
### Register plugin to be accessible by fbl
- via cli: `fbl -p @fbl-plugins/k8s-helm `
- via flow:
```yaml
requires:
fbl: '>=1.12.0 <2.0.0'
plugins:
'@fbl-plugins/k8s-helm': '>=1.1.1'
pipeline:
# your flow goes here
```
## Action Handlers
- Helm V3 only: [helm update --install](./docs/UpdateOrInstall.md)
- Helm V2 only: [helm update --install](./docs/UpdateOrInstall_V2.md)
- Helm V2 and V3: [helm delete](./docs/Delete.md)
- Helm V2 and V3: [helm test](./docs/Test.md)
- Helm V2 and V3: [helm repo add](./docs/RepoAdd.md)