Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flux-web/flux-web
flux-web is used for manuall actions against flux api
https://github.com/flux-web/flux-web
Last synced: 3 months ago
JSON representation
flux-web is used for manuall actions against flux api
- Host: GitHub
- URL: https://github.com/flux-web/flux-web
- Owner: flux-web
- License: mit
- Created: 2019-08-23T21:03:14.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T02:49:36.000Z (almost 2 years ago)
- Last Synced: 2024-05-29T03:27:35.993Z (6 months ago)
- Language: Go
- Homepage:
- Size: 9.89 MB
- Stars: 145
- Watchers: 6
- Forks: 24
- Open Issues: 46
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# flux-web
[](http://hits.dwyl.io/flux-web/flux-web) [](https://github.com/dwyl/esta/issues) [](https://goreportcard.com/report/github.com/flux-web/flux-web) [](https://travis-ci.com/flux-web/flux-web)
> If you don't know what *GitOps* is then we highly encourage you to read [Weavework blog](https://www.weave.works/technologies/gitops/) and [flux](https://github.com/fluxcd/flux) for the implemention.
flux-web is used for manual actions against flux's api:
* list current workloads
* dynamic namespaces overview
* workload's version promotion or rollback
## Reasoning
When using `flux` our pipelines, or to be more precise, our Continues Deployments are fully automated and that's great.
But, sometimes we would like to have more stable environments with fewer deployments and with more control, for example, production.
That's mean we need to do some manual actions against `flux` which have his own CLI tool `fluxctl`.
flux-web is intended to be the UI approach to this problem. With flux-web we can view at our workloads per namespace with their available versions and with a single click we can promote a workload or to perform a rollback.
## Getting Started
The easiest way to deploy flux-web is with helm:
```shell
git clone [email protected]:flux-web/flux-web.git
cd flux-web/chart/flux-web
kubectl create ns flux
helm install . --name flux-web \
--set namespace=flux
--set frontend.env.API_EXTERNAL_URL=//flux-web.my-domain/api/v1
--set frontend.env.WS_URL=wss://flux-web.my-domain/ws/v1
```
Or, for an example we can deploy flux-web as readonly mode:
```shell
helm install . --name flux-web \
--set namespace=flux
--set frontend.env.API_EXTERNAL_URL=//flux-web.my-domain/api/v1
--set frontend.env.WS_URL=wss://flux-web.my-domain/ws/v1
--set frontend.env.READ_ONLY=true
```
Deploying flux-web with `HelmRelease`:
```
---
apiVersion: flux.weave.works/v1beta1
kind: HelmRelease
metadata:
name: flux-web
namespace: flux
spec:
releaseName: flux-web
chart:
git: [email protected]:flux-web/flux-web.git
path: chart/flux-web
ref: master
values:
frontend:
env:
API_EXTERNAL_URL: //flux-web.my-domain/api/v1
WS_URL: wss://flux-web.my-domain/ws/v1
ingress:
enabled: true
hosts:
- host: flux-web.my-domain
paths:
- frontend: /
- backend: /api
- backend: /ws
```
## Continued Development
Basically a roadmap.
### Coming soon
- filter workloads - ✓
- scroll over workload's versions - ✓
- readonly mode - ✓
- turn on/off flux automation on a workload - ✓
- features you'd like to see?
### Maybe in the future, if people want it
- user access and authentication
### Probably in the future
- select and release multiple workloads
## Built With
* [beego](https://beego.me/) - Backend framework
* [go](https://golang.org/) - Programing language
* [vue.js](https://vuejs.org/) - Frontend framework
* [nuxt.js](https://nuxtjs.org/) - Giving vue.js the ability to do ssr
* [docker](https://www.docker.com/) - Containerized with docker
* [helm](https://www.helm.sh/) - Packaged with helm
## Contributing
Code contributions are very welcome. If you are interested in helping make flux-web great then feel free!
## Authors
* [Ido Braunstain](https://github.com/idobry) - *Initial work
* [derkinderfietsen](https://github.com/derkinderfietsen) - *Initial work