actions/fluxcd-flux2
3
0
Fork 0
mirror of https://github.com/fluxcd/flux2.git synced 2026-02-10 17:57:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #134 from bia/132-beautify-roadmap

Browse source
This commit is contained in:
Hidde Beydals 2020-07-30 22:50:28 +02:00 committed by GitHub
commit 50d2eb7d57
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 120 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
docs/_static/custom.css vendored
View file

@ -22,3 +22,76 @@ body {
.md-header-nav__title {
font-size: .85rem;
}
.check-bullet {
color:#07bfa5;
background-color: white;
margin-left:-22px;
}
/* Progress bar styling */
.progress-label {
position: absolute;
text-align: center;
font-weight: 700;
width: 100%;
/* remove original styling for thin styling
margin: 0 ! important; */
margin-top: -0.4rem ! important;
line-height: 1.2rem;
white-space: nowrap;
overflow: hidden;
}
.progress-bar {
/*remove original styling for thin styling
height: 1.2rem; */
height: 0.4rem;
float: left;
background: repeating-linear-gradient(
45deg,
rgba(255, 255, 255, 0.2),
rgba(255, 255, 255, 0.2) 10px,
rgba(255, 255, 255, 0.3) 10px,
rgba(255, 255, 255, 0.3) 20px
) #2979ff;
border-radius: 2px;
}
.progress {
display: block;
width: 100%;
/* remove original styling for thin styling
margin: 0.5rem 0;
height: 1.2rem; */
margin-top: 0.9rem;
height: 0.4rem;
background-color: #eeeeee;
position: relative;
border-radius: 2px;
}
.progress-100plus .progress-bar {
background-color: #00c853;
}
.progress-80plus .progress-bar {
background-color: #64dd17;
}
.progress-60plus .progress-bar {
background-color: #fbc02d;
}
.progress-40plus .progress-bar {
background-color: #ff9100;
}
.progress-20plus .progress-bar {
background-color: #ff5252;
}
.progress-0plus .progress-bar {
background-color: #ff1744;
}

76
docs/roadmap/index.md
View file

@ -10,76 +10,84 @@
### Flux read-only feature parity
[= 50% "50%"]
This would be the first stepping stone: we want the GitOps Toolkit to be on-par with today's Flux in
[read-only mode](https://github.com/fluxcd/flux/blob/master/docs/faq.md#can-i-run-flux-with-readonly-git-access)
and [FluxCloud](https://github.com/justinbarrick/fluxcloud) notifications.
Goals
- Offer an in-place migration tool for those that are using Flux in read-only mode to synchronize plain manifests
- Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays
- ~~Offer a dedicated component for forwarding events to external messaging platforms~~
- Offer an in-place migration tool for those that are using Flux in read-only mode to synchronize plain manifests
- Offer a migration guide for those that are using Flux in read-only mode to synchronize Kustomize overlays
- <span class="check-bullet">:material-check-bold:</span> Offer a dedicated component for forwarding events to external messaging platforms
Non-Goals
- Migrate users that are using Flux to run custom scripts with `flux.yaml`
- Automate the migration of `flux.yaml` kustomize users
- Migrate users that are using Flux to run custom scripts with `flux.yaml`
- Automate the migration of `flux.yaml` kustomize users
Tasks
- ~~Design the events API~~
- ~~Implement events in source and kustomize controllers~~
- ~~Make the kustomize-controller apply/gc events on-par with Flux v1 apply events~~
- ~~Design the notifications and events filtering API~~
- ~~Implement a notification controller for Slack, MS Teams, Discord, Rocket~~
- Implement Prometheus metrics in source and kustomize controllers
- Review the git source and kustomize APIs
- Implement the migration command in tk
- Create a migration guide for `flux.yaml` kustomize users
- [x] <span style="color:grey">Design the events API</span>
- [x] <span style="color:grey">Implement events in source and kustomize controllers</span>
- [x] <span style="color:grey">Make the kustomize-controller apply/gc events on-par with Flux v1 apply events</span>
- [x] <span style="color:grey">Design the notifications and events filtering API</span>
- [x] <span style="color:grey">Implement a notification controller for Slack, MS Teams, Discord, Rocket</span>
- [ ] Implement Prometheus metrics in source and kustomize controllers
- [ ] Review the git source and kustomize APIs
- [ ] Implement the migration command in tk
- [ ] Create a migration guide for `flux.yaml` kustomize users
### Flux image update feature parity
[= 0% "0%"]
Goals
- Offer components that can replace Flux v1 image update feature
- Offer components that can replace Flux v1 image update feature
Non-Goals
- Maintain backwards compatibility with Flux v1 annotations
- Maintain backwards compatibility with Flux v1 annotations
Tasks
- [Design the image scanning and automation API](https://github.com/fluxcd/toolkit/discussions/107)
- Implement an image scanning controller
- Design the automation component
- Implement the image scan/patch/push workflow
- Integrate the new components in the toolkit assembler
- Create a migration guide from Flux annotations
- [ ] [Design the image scanning and automation API](https://github.com/fluxcd/toolkit/discussions/107)
- [ ] Implement an image scanning controller
- [ ] Design the automation component
- [ ] Implement the image scan/patch/push workflow
- [ ] Integrate the new components in the toolkit assembler
- [ ] Create a migration guide from Flux annotations
## The road to Helm Operator v2
### Helm v3 feature parity
[= 33% "33%"]
Goals
- Offer a migration guide for those that are using Helm Operator with Helm v3 and Helm repositories
- Offer a migration guide for those that are using Helm Operator with Helm v3 and Helm repositories
Non-Goals
- Migrate users that are using Helm v2
- Migrate users that are using Helm v2
Stretch-Goals
- [Migrate users that are using Helm charts from Git](https://github.com/fluxcd/toolkit/discussions/75#discussioncomment-38589)
- [Migrate users that are using Helm charts from Git](https://github.com/fluxcd/toolkit/discussions/75#discussioncomment-38589)
Tasks
- ~~Implement a Helm controller for Helm v3 covering all the current release options~~
- Discuss and design Helm releases based on source API:
+ [Providing values from sources](https://github.com/fluxcd/toolkit/discussions/100)
+ [Conditional remediation on failed Helm actions](https://github.com/fluxcd/toolkit/discussions/102)
+ [Support running Helm test actions on an interval](https://github.com/fluxcd/toolkit/discussions/103)
- Review the Helm release, chart and repository APIs
- ~~Implement events in Helm controller~~
- Implement Prometheus metrics in Helm controller
- Create a migration guide for Helm Operator users
- [x] <span style="color:grey">Implement a Helm controller for Helm v3 covering all the current release options</span>
- [ ] Discuss and design Helm releases based on source API:
* [ ] [Providing values from sources](https://github.com/fluxcd/toolkit/discussions/100)
* [ ] [Conditional remediation on failed Helm actions](https://github.com/fluxcd/toolkit/discussions/102)
* [ ] [Support running Helm test actions on an interval](https://github.com/fluxcd/toolkit/discussions/103)
- [ ] Review the Helm release, chart and repository APIs
- [x] <span style="color:grey">Implement events in Helm controller</span>
- [ ] Implement Prometheus metrics in Helm controller
- [ ] Create a migration guide for Helm Operator users

5
mkdocs.yml
View file

@ -35,6 +35,11 @@ markdown_extensions:
highlight_code: true
- pymdownx.tabbed
- pymdownx.tilde
- pymdownx.progressbar
- pymdownx.tasklist
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
nav:
- Introduction: index.md