search

fabric8-services / fabric8-tenant-jenkins

Generates Jenkins tenant namespace YAML
Apache License 2.0
2 stars 14 forks source link

Delete dead code and add basic documentation for what is actually used #78

Open jaseemabid opened 6 years ago

jaseemabid commented 6 years ago

There is a just a lot of configuration files in this repository that makes it very hard for anyone new to understand what is going on. Adding some basic docs (like apps vs packages, what is being deployed etc) will also help.

A few things I can think of are,

  1. How are the yaml files applied? Are all of them used? Where is the code for it?
  2. What is apps vs packages?
  3. What is the pom.xml, release.groovy and jenkins file really doing there? Are we shipping all the files as a maven package and then downloading it back to osio while being deployed?
  4. Can we remove all the maven bits from here? Is it really necessary?
  5. Is apps/jenkins-test used at all?

cc: @aslakknutsen

aslakknutsen commented 6 years ago

  1. No, we primarly use apps/jenkins apps/contentrepo apps/bayesian-link packages/fabric8-tenant-jenkins fabric8-tenant-jenkins-quotas-oso as far as OSiO is concerned.

  2. A package contain multiple Apps. A Package is a 'software collection' if you will. A distribution package. A way to bundle Apps. etc etc

  3. The whole thing is 'compiled' by the fmp into a template set per package, pushed to Maven Central and consumed by Tenant service on provisoning. So yes.

  4. Debatable. It's required in the current form.

  5. It was intended to be used when running the BDD tests. Unsure about the state of those.