[DISCUSSION] Roadmap to version 1.0.0

[l0nax]

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]

@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]

@rimusz Updated

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

[rimusz]

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]

Ah ok. Is the Xray API documentation public available?

[rimusz]

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]

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]

I have created the milestone and dev-1.0.0 branch

[l0nax]

Thanks :)

[lhotrifork]

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 :) ).

[l0nax]

Hey @lhotrifork currently this project – especially release v1 – has a very high priority on our internal (and personal) Task list.

So if you have any ideas/ features please post it here so we can discuss about it :D

[l0nax]

@rimusz could you please give me the privileges to push to the dev-1.0.0 branch? This would help me in my development cycle. But if it isn't possible it's not a big deal ^^

[l0nax]

And whats about the CI/CD? Which CI/CD service do you use? Is it possible that we can use Travis CI - since it's the defacto standard in OpenSource projects, also because everyone can check out the build logs, process, ...

[rimusz]

@l0nax github does not support privileges per branch :( We used TravisCI before but as JFrog acquired Shippable we have to use our products for CI/CD. Let me double check that again.

[l0nax]

@l0nax github does not support privileges per branch :(

Ok :(

Let me double check that again.

Ok, thanks :)

[l0nax]

@rimusz Can the helm chart be split into a separate repository? Or ie. (later) into the JFrog Charts.

[rimusz]

@l0nax yes, the chart will be moved to JFrog charts github repo

[l0nax]

Started working on those features on dev-1.0.0 branch.

[l0nax]

@rimusz Any updates about the Travis CI?

[rimusz]

@l0nax I have no update on Travis Ci yet

[rimusz]

@l0nax CircleCi will be used https://github.com/jfrog/kubenab/issues/42

[l0nax]

Top, thanks @rimusz :)

[l0nax]

I have now some "free" time so I will start integrating all those features – and update the chart, etc...

[l0nax]

Should the things we discussed separated in different Issues (and linked here) to discuss about them and create PR's which are related to them? But keep the "global" discussion about v1 in this Issue.

[rimusz]

Should the things we discussed separated in different Issues (and linked here) to discuss about them and create PR's which are related to them? But keep the "global" discussion about v1 in this Issue.

yes :)

[rimusz]

I have now some "free" time so I will start integrating all those features – and update the chart, etc...

I will take care of CircleCI integration

[cprivitere]

Just wondering if a path to 1.0.0 is still planned? Or did everyone jump ship to tugger or something?