[DISCUSSION] Roadmap to version 1.0.0

l0nax commented 5 years ago

Since I can not create a Milestone this Issue is a Request to create such a Milestone.

This Project uses Semantic Versioning and the "declaration" of Version 1.0.0 is that the Project is production ready. All Versions below 1.0.0 is "tagged" as breaking-changes may occur.

Here are some breaking Changes which I want to make to get this Project (really?) production-ready:

Documentation [#45]
- Use the GitHub Pages Feature to serve a static HTML Documentation-Site
- Document all available Features, Setup, Contribution, ...
- The README.md is big and it would be better to split some parts in own Documentation Sections (Point Documentation -> 1 and 2)
Project Structure
- changelog-go tool to maintain a consistent CHANGELOG.md
- Currently the Project Structure isn't very nice (eg. the kubenab Source Code is under cmd/kubenab, K8s related things under deployment, chart, tls and webhook)
kubenab
- Add CI/CD [#42]
- Secure/ Optimize Dockerfile/ resulting Image
- non-root User
- scratch Image
- We are using the default log Library of golang (which isn't bad) but there are better/ faster libraries especially for Microservices
- More Error Checking
- Using (eg.) fasthttp instead of the default http Library of golang (=> faster)
- *_test.go Fieles for Unit-Testing and Benchmarking of single Functions
- Function, struct and Field Documentation
- More Configuration possibilities (eg. per Namespace Config, etc..)
- Add Xray Funktionality
- Move helm chart to https://github.com/jfrog/charts [#43]

So @rimusz is this a good goal for Version 1.0.0?

rimusz commented 5 years ago

@l0nax first thanks a lot for all your contributions to the project, we really appreciate it.

Documentation - I agree on all of it
Project Structure - it should one have source code, k8s related ones, the chart will be moved to https://github.com/jfrog/charts/tree/master/stable and as non helm install way install will be documented using helm template
kubenab - one more feature has to be added to the roadmap #16 as optional feature

l0nax commented 5 years ago

@rimusz Updated

Can you explain me what the Xray Feature is? As I understood it's a advanced Feature of the JFrog Artifactory.

rimusz commented 5 years ago

JFrog Xray scans artefacts in Artifactory, by Xray feature I mean to implement https://github.com/jfrog/kubexray into Kubenab. e.g. Kubenab checks image against Xray and if the image has security issues Kubenab will fail the image usage.

l0nax commented 5 years ago

Ah ok. Is the Xray API documentation public available?

rimusz commented 5 years ago

yup https://www.jfrog.com/confluence/display/XRAY/Xray+REST+API but you could take a look to https://github.com/jfrog/kubexray it has all that implemented already :) https://github.com/jfrog/kubexray/blob/master/cmd/kubexray/handler.go#L593 @DarthFennec could help you there

l0nax commented 5 years ago

Okay thanks

Could you create a Milestone and a develop branch? So we can keep track and other Users will have the stable Version of kubenab after cloning.

rimusz commented 5 years ago

I have created the milestone and dev-1.0.0 branch

l0nax commented 5 years ago

Thanks :)

lhotrifork commented 4 years ago

Hi, Is anybody working on this? There doesn't seem to be any activity on dev-1.0.0 branch I'd love to help out in any way I can (also because I have some features that I would like to see :) ).