15:31:32 #startmeeting Helium_M3_Developer_Meeting 15:31:32 Meeting started Wed Jul 9 15:31:32 2014 UTC. The chair is phrobb. Information about MeetBot at http://ci.openstack.org/meetbot.html. 15:31:32 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 15:31:32 The meeting name has been set to 'helium_m3_developer_meeting' 15:31:36 * edwarnicke looks appropriately innocent 15:32:00 hello all :-) 15:32:03 chair edwarnicke regXboi colindixon 15:32:08 #info Mathieu Lemay is present representing the reservation project 15:32:17 #chair edwarnicke regXboi colindixon 15:32:17 Current chairs: colindixon edwarnicke phrobb regXboi 15:32:28 #info Paul Zimmerman here for documentation 15:32:28 #info Ed Warnicke - controller 15:32:31 #info colindixon is present representing the TTP project 15:32:43 I'm not going to info in, I'm not representing anybody :) 15:32:43 phrobb: Could we start with some agenda bashing? 15:32:50 #info Frank Brockners is here representing SNBI (secure network bootstrapping infra) 15:32:54 phrobb: I know that for example I'd like to try to understand what to do for docs 15:32:55 #info Madhu Venugopal for ovsdb 15:33:01 #info Luis Gomez from Integration 15:33:02 #Info Amit Mandke here for L2 Switch 15:33:02 #info Sarath for VTN 15:33:04 phrobb: And we have the question of Release Vehicles etc 15:33:05 #info dkehn representing opflex 15:33:05 Yes, let's get everyone to #info in for their projects first 15:33:07 #info Liem for AAA 15:33:09 #info Hideyuki Tai for VTN project 15:33:09 #info Rafat Jahan for ODL-SDNi App 15:33:13 phrobb: Awesome :) 15:33:27 @ed & phrobb can we also talk documentation? 15:33:30 #info Paul Quinn is here representing SFC 15:33:37 #info Christine Hsieh for SNMP4SDN project 15:34:13 #info Abhijit Kumbhare OpenFlow Plugin project 15:34:56 is that everybody? 15:35:05 mlemay: I want to talk docs badly :) 15:35:16 regXboi: Who are we missing? 15:35:16 #info Harman Singh dlux project 15:35:23 #info oflibMichal for openflowjava 15:35:29 let's go look 15:36:26 so think we are missing BGPCEP, defense4all, GBP, Lisp, PacketCable, plugin2oc, toolkit, and yangtools 15:36:46 do we need to add a feature to the odl_meetbot to have report in with expected strings 15:36:47 ? 15:36:53 did I incorrectly call out someone who is here? 15:36:55 maybe worth seeing if we can 15:37:00 that looks right to me phrobb 15:37:19 Pinging folks to round them up 15:37:29 so, let’s #info that and we can move on with them chiming in as we go? 15:37:44 I know that PacketCable can't make it 15:37:50 #info Dana for bgpcep 15:38:26 #info Dana for Southbound plugin to the OpenContrail Platform 15:38:47 #info Priyanka Chopra for Southbound plugin to the OpenContrail Platform 15:39:15 #info missing projects are: defense4all, GBP, Lisp, PacketCable, toolkit, and yangtools 15:39:46 moving on to agenda bashing.... 15:39:53 #topic Agenda Bashing 15:40:10 #info Tony for YANGTools 15:40:10 #info Those that have topics they want to be sure we discuss, please #info them in now 15:40:17 welcome Tony 15:40:28 #info release vehicles (read karaf) 15:40:32 #info documentation production 15:40:41 #info and documentation "ambering" 15:40:57 is there a call for this? I've been suddenly told to join this meeting 15:41:18 No -its over IRC 15:41:32 No call readams 15:42:00 OK thanks 15:42:08 readams: info in for GBP :) 15:42:22 Any other agenda topics? 15:42:22 #info readams for GBP 15:42:55 phrobb: What do we have so far for agenda topics? 15:43:13 phrobb: I see them now 15:43:20 regXboi: please define "ambering" 15:43:28 Do we have someone here form OpenFlow Plugin? 15:43:30 @regXboi.. on documentation there is the question of documentation location (what is in docs project vs what projects should provide) dunno if you want to add that in or it’s part of that discsuion item 15:43:43 Yes 15:43:46 I think that's when they post notices on freeway signs looking for information leading to documentation 15:43:51 thanks abhijitkumbhare 15:43:57 by ambering I mean I want the documentation to be in a place where it is *FIXED* for all time 15:44:05 and subsequent development won't change it 15:44:15 we don't have any such location for Hydrogen docs now 15:44:28 regXboi: Understood 15:44:28 and it's going to be part of the fun and frolic of the stable release 15:44:44 #info we are still missing Defense4All, Lisp Flow Mapping Service, and Toolkit 15:45:11 #info Thomas Kee for PacketCable 15:45:17 #info secondary topic after all others: stable/hydrogen, are we good to go? 15:45:20 akim: can u info in for Toolkit ? 15:45:37 #topic Release Vehicles (aka Karaf) 15:45:40 #info everything looking good 15:46:11 akim: I think Madhu wanted you to info in about representing the toolkit project 15:46:27 (see what xsited did above) 15:46:27 #info akim for Toolkit :) 15:46:28 #info OK, so everyone is here except Defense4All 15:46:39 Just got off the phone with the Lisp Flow Mapping Guys. They are on their way 15:46:40 :-) 15:46:55 hi 15:46:58 regXboi: want to kick off Release Vehicle discussion? 15:47:04 goldavberg: Could you #info in for Lisp Flow Mapping? 15:47:06 Ah good, thanks edwarnicke 15:47:25 here for lisp :) 15:47:43 goldavberg: you need a “pound” info 15:47:46 (see above) 15:47:53 #info goldavberg for Lisp Flow Mapping 15:47:56 :) 15:47:57 #info lispflowmapping is on schedule, and everything is green 15:48:05 edwarnicke and Madhu: doing the proxy work :) 15:48:07 ok folks 15:48:21 about the only RV idea I've seen that makes sense is the pure karaf stuff 15:49:04 #link https://wiki.opendaylight.org/view/CrossProject:Helium_Release_Vehicle_Brainstorming - Release Vehicle (RV) ideas to date 15:49:16 but that means we need to define features 15:49:17 #link https://wiki.opendaylight.org/view/CrossProject:Helium_Release_Vehicle_Brainstorming:Pure_Karaf - Pure Karaf Proposal 15:50:27 Is there anyone who doesn't know about the Release Vehicle Discussion or the Pure Karaf proposal? 15:50:34 @regXboi: need to define features but also the dependencies between them.. right now most of the controller features are in .. also we have openflow related features ready, ovsdb one in the works.. all other projects don’t have it 15:50:45 edwarnicke: my guess is that most people have not followed this closesly 15:50:59 @colin: I’d + 1 that 15:51:07 colindixon: +1 that 15:51:24 mlemay: Would you like to explain Pure Karaf, you are its original advocate (though lots of folks, including me, like it) 15:51:44 I've been watching it from afar; I've been waiting for some example of how you would actually do the Karaf stuff 15:51:58 @ed : ok let me take a stab at this.. 15:52:17 Pardon my ignorance on Karaf, but would we need some type of config tool to allow the pick&choose of componentry as well? 15:52:25 Does it mean we'd need to have depedencies twice: once in pom and once in features.xml? 15:52:40 @phrobb: not necessarily 15:53:05 OK, then config-file based then I assume 15:53:41 @readams: pom doesn’T specify dependencies for runtime it only specifies the bundle’s current compile deps for almost all bundles out there.. and most project import the .zip for controller which is a huge runtime blob 15:53:43 do we still need to have “editions" 15:54:21 readams: mlemay poms are also notoriously inaccurate at really figuring out runtime dependencies :( They rock for building, but not so much for the runtime stuff. 15:54:21 phrobb: right now we have minimal container which doesn’t run anything from the startup but you can then specify what you want running at startup 15:54:50 @colindixon: I don't think so 15:54:59 #link https://wiki.opendaylight.org/view/CrossProject:Helium_Release_Vehicle_Brainstorming:Pure_Karaf#User_Driven_Feature_Selection - colindixon: the pure karaf proposal is no Hard Editions 15:55:20 as part of the DLUX ui we’ve done a small feature installer screen which allows user to turn on / off components at runtime 15:55:37 edwarnicke: does it mean we have no editions in Helium? 15:55:37 #link https://s3.amazonaws.com/uploads.hipchat.com/32585/802758/yx0ltRFqA5enZsW/features.png - Sample Feature management in DLUX UI 15:56:20 mlemay: Anyway we could get that to represent 'high level' features 15:56:21 ? 15:56:35 so, the next question is how far along are features and karaf? 15:56:40 however we need to choose “where” we put the artifacts (most likely .kar packages.. or can also be provided via any PAX-URL ) 15:56:41 well actually we'll have dependencies three times, once in karaf, once in pom, and once in config subsystem 15:56:41 and how do we test thigs 15:56:49 One of the things AAA is interested in is OSGi security... How is that different between Karaf vs the OSGi kernel we are using today? I think a "Karaf for dummies" Wiki would be helpful. 15:57:06 hideyuki: I think the suggestion is that rather than trying to pull together editions, which is both hard, and unlikely to actually end up with the combinations users want... we would give them the ability to get the features they actually want 15:57:31 on security: loading/unloading OSGi bundles at runtime is not something we should be trying to do 15:57:49 edwarnicke: I see. 15:57:53 @liemm: OSGi security stays OSGi security however you do have container JAAS support and stuff which we could link to AAA project 15:57:53 edwarnicke: howdy 15:57:57 edwarnicke: this is made harder by the fact that currently everything depends on everything else 15:58:22 @mlemay, thanks 15:58:24 mlemay could you describe the additional work that would be needed by all the projects to support Karaf? 15:58:25 icbts: Welcome... guys icbts is a core karaf guy who may be able to answer some of our questions 15:58:39 readams: Not actually true for everything... 15:58:50 readams: not really true.. 15:58:57 In case we don't have editions any more, does that mean that any possible combination of features would be tested (would karaf help with that?) 15:58:58 I attempted to make a trimmed distribution but I couldn't effectively remove much 15:59:26 * icbts reading above a quickly as possible 15:59:38 phrobb: work needed is inclusion of a features file and proper .kar packaging by the project which outlines properly its dependencies 15:59:49 The model would be presumably any particular application would test its configuration 15:59:58 So GBP would pull in some set of dependencies and we'd test with that 16:00:24 You still want a sane tested core platform but we're still a long way from that 16:00:24 * icbts We discussed security concerns in the security analysis meetings a few weeks ago https://wiki.opendaylight.org/view/CrossProject:OpenDaylight_Security_Analysis#OSGi_Runtime_Container_Security_-_OpenDaylight_Apache_Karaf_Distribution 16:00:33 the other major problem about not having editions is that then we have to test 2^f “editions” if we have f features 16:00:38 phrobb: for most projects out there it is trivial… the hard one was controller and it’.s 90% complete some NSFs are still troublesome and we need to revisit the old builtin Webapp the rest is currently in 16:01:01 brockners: https://wiki.opendaylight.org/view/CrossProject:Helium_Release_Vehicle_Brainstorming:Pure_Karaf#Testing_Strategy - the idea is to test the feature in isolation and with everything else 16:01:10 colindixon: no that problem is not about editions it’S about the lock of proper componentization within ODL 16:01:16 *lack 16:01:22 brockners: So not full combinatronics, just 'does the feature work by itself' 'does the feature work with everything else' 16:01:44 colindixon: it's not useful to think of all subsets of features. A particular application will have specific requirements. You test the applications 16:01:52 also this can be easily done via PAX-exam tests 16:01:57 makes testing much easier in fact 16:02:12 edwarnicke: So what if someone pulls together subsets... - does this mean "it may work"? 16:02:14 OSGi makes testing very hard in general of course 16:02:22 I am also told that features fix a lot of the crazy fragileness of pax-exam that has vexed us 16:02:33 brockners: A feature defines all the things it needs to work 16:02:34 readams: ?? Use Pax-Exam 16:02:39 The best solution is, of course, to not use OSGi 16:02:40 So if you test the feature, it works 16:02:55 Testing agains the kitchen sync is to make sure it doesn't get stomped by something else 16:02:56 readams: https://wiki.opendaylight.org/view/CrossProject:Helium_Release_Vehicle_Brainstorming:Pure_Karaf#Testing_Strategy — that strategy has been used by many prohjects 16:03:14 readams: install what you need into the distribution and then test 16:03:15 readams, mlemay: I get that the issue is that we *need* to test some combinations fo things to “bless” them and we need to define those combinations, I think those become editions 16:03:17 am I wrong? 16:03:26 yea, great, I can't write actual unit tests. Wonderful... 16:03:29 brockners: Am I getting your question... or talking past your question? ;) 16:03:59 colindixon: The problem is... nobody has come up with *any* sensible suggestions for Editions for Helium that I am aware of 16:04:03 readams: You can write unit tests 16:04:04 colindixon: I don't think the "edition" thing makes sense. You can't just lump together a bunch of stuff 16:04:04 It turns out to be hard 16:04:05 readams: I don’T see OSGi going anywhere for ODL.. especially with the current way projects are structured… 16:04:11 Thus the Pure Karaf proposal 16:04:23 I don’t think we’re going solve this here 16:04:34 colindixon: Solve which thing particularly? 16:04:35 :-/ 16:04:35 I would like to suggest putting little time on the next TWS meeting agenda after reviewing the wiki 16:04:40 mlemay: It would solve a lot of problems, but I agree we're unlikely to fix that immediately 16:05:01 edwarnicke: answer the question “what are our release vehicles and how can we test them?" 16:05:04 xsited: I think that's a good suggestion 16:05:07 which I think is the question 16:05:15 LuisGomez: Could you explain the need from integration to figure something out here? 16:05:18 the TWS agenda is empty to my knowledge 16:05:24 For Helium, for example, for vtn users, we describe "vtn feature", we describe what bundles should be included in "vtn feature". And we put the feature description in Integration group git repo. is my understanding right? 16:05:32 becuase it was going to be XSQL, but Sharon is out 16:05:34 colindixon: The Pure Karaf proposal has concrete answers to those questions 16:05:38 OSGi provides modularity, runtime management, and sanity. Karaf enhances it with easier to admin features and friendly interface - our Pax Exam integration makes testing large integrations sane. 16:06:01 @hideyuki the best is for projects to provide features locally 16:06:08 icbts: +1 . lot of scars using non-karat Pax-Exam 16:06:12 karaf 16:06:18 OSGi provides nondeterministic loading, incorrect semantics for a controller, slowless, and testing challenges 16:06:19 I like karaf way of going things but i still think we need to test some feature combinations that we think are going to be very used 16:06:28 then in integration we integrate the features by adding the different feature repositories to the config / pacakaging 16:06:31 mlemay: what do you mean "locally 16:06:33 ? 16:06:34 hideyuki: You would define the "vtn feature". It would describe what bundles (and other features) the "vtn feature" needs. You probably want to keep that feature file in your vtn project, but we can aggregate a registry in the integration project 16:06:45 @hideyuki local to the project sorry 16:06:45 colindixon I think Luis wanted making the OF plugin default on TWS agenda - but now the change to default is done anyway (so not sure if its needed) 16:07:01 so I'll wade back in here 16:07:07 LuisGomez: Do we have any idea what those really are? (the feature combinations that will be used)... the feedback I've heard from customers has led me to believe we don't guess that well. 16:07:21 edwarnicke: +1 16:07:28 @Luis : Yes.. we should test some default combinations based on what the test is actually doing 16:07:56 edwarnicke: Thank you! I can understand it! 16:07:56 i will have to think about this 16:07:57 @ed: I’ve gotten the same comment 16:08:07 mlemay: Thank you! I can got it! 16:08:08 Probably it is good idea to note what things will absolutely not work together 16:08:26 LuisGomez: Can we agree that *minimally* tests for a feature should run against *just* that feature and against *all features installed* ? 16:08:34 abhijitkumbhare: yes, but that's (unfortunately) likely to be Lithium 16:08:51 abhijitkumbhare: Do we know which things won't work together? 16:08:53 edwarnicke: "all features installed" is a nonsensical concept 16:09:11 I remember VTN, OpenDove and Affinity did not work together in Hydrogen 16:09:11 edwarnicke: I can't run two things that both manage the OF data plane, for example 16:09:13 readams: For deployment yes, for detecting features stepping on each other... its actually the best I can think of 16:09:30 just the feature means with all recommended dependencies, yes i agree with that 16:09:32 edwarnicke: my point is that features _do_ step on each other and this is expected 16:09:32 readams: Doing so is actually explicitely in our goals for ODL 16:09:51 readams: Then we should identify those places directly 16:09:55 testing with all features is impossible today 16:09:55 edwarnicke: This is an unsolved research problem that people have tried and failed to solve for years 16:10:16 readams: So I amend to 'just the feature' and 'the feature and everything else not explicitly identified as conflicting' 16:10:39 @all: Features is about packaging, the fact that features step on each other is a lack of internal componentizaiton guidelines and should be provided by a proper component model / metadata at a “add-on” level , features should be able to contribute one or many of these “add-ons” these concepts are orthogonal but linked 16:10:55 what features avoid a huge .zip blob that we’ve been having for editions 16:11:05 *is a huge* 16:11:11 mlemay: +1 16:11:32 edwarnicke: well you can't really define all things that might conflict easily. Though if you can do virtual packages you might be able to. For example when I did the packaging for the Big Switch internal floodlight platform, I had a virtual "floodlight-application" package that was provided by and conflicted with anything that needed to control the data plane 16:11:33 I'm here now, sorry for the delay 16:11:48 So... folks other than edwarnicke LuisGomez mlemay icbts readams (who have been vocal)... we'd like to hear your thoughts... would you please speak up? 16:11:51 edwarnicke: Can Karaf handle a similar concept to enforce "exactly one of something"? 16:11:56 also people can download standlaone .kar package drop it in “/deploy” and make add-ons etc.. or otherwise can do feature:install from official repositories 16:12:17 colindixon and madhu: Can we reserve next Monday's TWS call for this Karaf discussion? So that testing, configuration methods, docs and per-project work needed for pure-Karaf implementation can be discussed more deeply? 16:12:27 I had some internal stuff to take care off... can we repeat this entire discussion ;) 16:12:28 phrobb: yes. lets do it 16:12:33 phrobb: 16:12:34 readams: A sigleton pattern or do you mean only one HTTPD, only one JMS Server ? 16:12:36 am quiet because am listening :) 16:12:37 I’ll put that on the agenda now 16:13:03 readams: has a valid point on features stepping on each other. 16:13:09 and that is unresolved still 16:13:11 icbts: I mean give an error if the user tries to load, for example, two things that do the same thing 16:13:17 Madhu: That's fine... listening is good... just speaking as one of the vocal folks... I worry about not leaving room for others to get a word in edgewise 16:13:20 but the concept of editions that we had for Hydrogen helped 16:13:23 also I don’t know if everyone saw my proposition but a role I would see TSC doing in the future is determining feature level lifecycle to a “stable” feature repository.. because project-level is not appropriate (I might have experimental features in my project) I know it’s out of scope o fthis meeting but it’s an important thing to see where the released feature repositories will be.. now it willl likely b 16:13:24 locally pacakaged for helium 16:13:50 with Karaf... I don't think it changes the notion. 16:13:55 Ultimately the actual useful unit here is going to be RPM and deb packages 16:14:09 +1 readams yes. 16:14:15 Nobody really wants to deploy by downloading bundles from nexus 16:14:16 mlemay: I think part of that for helium will be identifying the 'top level features' a project wants to represent to the world... for example, OFplugin has lots of cool testing features you should *not* drop into a production deployment... but they are mega handy 16:14:31 readams: I disagree entirely with your point no rpms 16:14:40 They are important, but not the end all be all 16:14:44 readams: +1 16:14:53 edwarnicke: You're against the concept of RPMs? 16:15:29 having two things that do the same job is fine under OSGi - karaf won’t prevent that. If two features want to grab port 61616 then standard port bind error will happen. Other than that the usual service version rules apply 16:15:33 windows 16:15:52 readams: Please read my comment again. They are important, but they are not the end all be all. They are deeply natural to Linux Sysadmins, and deeply unnatural to folks used to deploying services written in Java. Also, work rather poorly and are very difficult to do for Java stuff 16:15:57 tbachmanBrb: having RPM packages doesn't preclude ZIP or whatever 16:15:59 tbachmanBrb: That too :) 16:16:17 So... we've been talking about this for 45 minutes, what can we conclude? 16:16:21 edwarnicke: I've done it before and it works fantastically 16:16:46 readams: I have the scars, and also know the folks who have the accumumlated scars at the distro level. Consider yourself lucky 16:16:57 i think if every project declares what is needed for ‘just the feature' and ‘what is conflicting’, we can probably do some testing around but it is possible that with this approach we do not hit the most used feature combination, therefore my concern 16:17:14 readams: rpm / deb could drop at right place but I’d only wrap a kar for that as deb/rpms have no link with the osgi framework 16:17:18 edwarnicke: well you have to do it right. When the project fights against you it's harder 16:17:35 OSGi is one of the ways the project can fight against you 16:18:05 LuisGomez: +1 16:18:25 Folks this is a great discussion, but may go faster, and we'll have more time for it on the TWS call. Shall we table this discussion until then? 16:18:41 yeah 16:18:44 please 16:18:50 I’m putting it on the agenda 16:18:52 ++ 16:18:54 thanks colindixon 16:18:55 Any opposed….. 16:19:00 Quick check for the global folks... are you comfortable with this discussion continuing on the TWS? 16:19:08 Luis: I think it would be hard to test all projects just looking at the list.. TEsting interproject deps will get exponentially difficult… any suggestion? 16:19:10 edwarnicke: yes. 16:19:20 Moving to next topic….. 16:19:27 #topic Documentation 16:19:31 edwarnicke: yes 16:19:41 thanks David 16:20:05 paulz: could you give us a rundown on current doc state and needs? 16:20:12 phrobb: another can of worms ;) hahaha ok on docs.. did everyone see what recommended level of docs from the docs project? 16:20:27 mlemay: No, link? 16:20:44 mlemay: i will propose some test strategy for karaff offline after this meeting 16:21:27 #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:Docs_and_Structure#Recommended_Documentation_for_Helium 16:21:30 LuisGomez: Thanks 16:21:34 Sure... we have been working on setting up the tooling for structured docs. (Mathieu has been leading that) We had an OK-sized crew when we kicked this off in Feb, but have lost most of the folks due to competing needs. Currently, we need more folks to help pull the docs together 16:22:09 It has been suggested that we have a member from each project help with the docs, which would be great. 16:22:35 @all I was wondering are most of the projects using the parent pom project pom file? 16:22:37 mlemay: A lot of that templating looks good... but only seems to reflect Hydrogen projects 16:22:48 (related to documentation) 16:23:04 mlemay: related how? (curious ;) ) 16:24:09 from a “structured” docs standpoint (especially from an API point of view I need to get access to a .WADL file for any northbound) moreover I need to potentially create additional scaffolding for RESTconf + models based off apidoc 16:24:24 mlemay: Good to know 16:24:45 right now we have some of the manuals in docs.. however we need proper “chapters” for each of the projects 16:24:52 mlemay paulz Do we have immediately executable recommendations... we were all on the line for doc start for M3, but I for one didn't know what to do for it 16:25:21 the question I have for this community at this meeting is would projects rather commit documentation to the “docs” project or would they prefer to have a “standard” location within their repository? 16:25:32 On documentation: just writing something coherent on the wiki would be a 5233% improvement 16:25:47 mlemay readams: no to wiki 16:25:47 mlemay: It would depend... but my instincts would be in the project and have something like docs gather it. 16:26:00 documentation for a release needs to be in a place where it doesn't change on the fly 16:26:03 regXboi: Got something else workable now? 16:26:10 it only changes on a release point 16:26:26 I've done work with the site target 16:26:28 in maven 16:26:34 regXboi 16:26:35 yes 16:26:40 and put up wiki pages, etc. on it 16:26:43 regXboi: the problem is we've made it too hard to document anything 16:26:46 and we really need to use that 16:26:46 regXboi: Is it in a state folks could adopt it? 16:26:50 it is the reason I was asking about parent pom as I wanted to provide a parent Site config 16:26:53 to projectds 16:26:55 regXboi: there's no structure where you can create documentation that's findable 16:27:06 readams: sorry - wiki loses 16:27:10 anything editable loses 16:27:20 because then you can't trust it 16:27:24 regXboi: the alternative is, I suspect, no documentation 16:27:37 regXboi: I agree it should be snapshot like everything else 16:27:39 edwarnicke: I think it is consumable 16:27:53 mlemay: no release needs it's own place 16:27:55 regXboi: Got a pointer to how folks can do it in their projects? 16:28:01 +1 to readams point of wiki - we usually would end up in the alternative of no documentation 16:28:05 edwarnicke: let me go dig 16:28:12 ok, I'll be blunt 16:28:18 #link http://asciidoctor.org/docs/asciidoc-writers-guide/ 16:28:23 -2 TO WIKI FOR THIS DOCUMENTATION - ITS A BAD IDEA 16:28:30 and yes I'm shouting 16:28:31 regXboi: I think that a 'site' solution like what you are proposing gets both... because SNAPSHOT if the site act like SNAPSHOTS, and releases like releases 16:28:45 regXboi: I don't disagree about the desirability of your proposal 16:28:50 regXboi: from a docs project standpoint I would like Ascidoc content + WADL files for API and I’m all set 16:28:52 I am pressing on 'how do we get this done' 16:28:59 We have some info on how to set up the tooling: 16:28:59 can we just archive documentation periodically? 16:29:03 * edwarnicke dislikes stuff that can't be done ;) 16:29:04 #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:Tools 16:29:10 mlemay: I've not done anything with repect to Ascidoc 16:29:19 regXboi: these ahve to be versioned along side the code (stable, snapshot, etc..) and pushed to nexus.. 16:29:20 I was working within javadoc 16:29:39 Asciidoc is for “instructions” (chapters, etc..) 16:29:43 javadoc is necessary but not sufficient. We need a sane developer guide 16:29:51 Can we look at how openstack has done docs ? 16:29:52 looking for where I linked this in 16:29:54 javadoc is API documentation only 16:30:00 alagalah: oh please no 16:30:06 I'm looking at that right now 16:30:14 regXboi: Why? Its nice 16:30:15 algalah: it is already based a bit off it but a little btter I hope 16:30:20 We used the OpenStack methodology as a base for our original setup 16:30:22 mlemay: I agree... javadoc is often *not* the most useful thing 16:30:33 alagalah: sure it's nice - it's wrong quite a bit of the time 16:30:34 regXboi: I'm not saying adopt wholesale, but we could take ideas 16:30:52 paulz: what is the scope of documentation group? global/cross project related documentation or you also cover project specific documentation? if the second i agree you need people from every project to work with you. 16:30:54 Openstack docs are really hard for developers to contribute to. 16:30:58 alagalah: not clear we can cherrypick 16:31:02 rockyg: +1 16:31:04 alagalah: we have different tools, technology and infra setup.. the openstack way 100% doesn’T apply but we did build off some of their stylesheets 16:31:07 It's possible to make really good javadoc but pretty rare. And you do need a guide to point you in the right directions. With ODL though javadoc is close to useless because of the 10 million bundles 16:31:07 alagalah: I go way back with docbook... so I expect to find asciidoc workable... but maven sites are also *mega* nice, and very familiar to folks as its the way 3/4 of the java world is doced 16:31:22 ok 16:31:24 @all 16:31:33 here is what I would like 16:31:36 if possible 16:31:36 edwarnicke: did you just make the claim that maven sites are nice? 16:31:57 #1 Maven Site for each project, #2 Asciidoc chapter for guides, #3 WADL for APIO 16:31:58 readams: Very compared to most everything else I've seen. And familiar to most folks who do any kind of java dev. 16:31:59 *API 16:32:15 that would actually cover all that is required for a proper release IMHO 16:32:26 mlemay: Not sure WADL is the best solution for APIO as models can be dynamically augmented... 16:32:30 LuisGomez - I think it's both... 16:32:35 So... question 16:32:36 edwarnicke: I've really only seen them used for maven plugins 16:32:36 so, I have two jenkins jobs around site deploy 16:32:41 #link https://jenkins.opendaylight.org/opendove/job/opendove-stable-site-deploy/ 16:32:48 Could we have maven sites with standard sections that point to asciidoc generated guides? 16:32:58 and #link https://jenkins.opendaylight.org/opendove/job/opendove-master-site-deploy/ 16:33:02 ed: yes I need something else for RESTconf but right now for non-restconf at least I have a scalfolding for it 16:33:11 Template for each doc type with needed scaffolding and an example (cut and past real stuff) would help a lot 16:33:30 rockyg: +1M 16:33:41 rockyg: Do we have templates for each doc type? 16:33:59 rockyg: +1 on that.. thus the reason I was asking about parent pom or whatver.. I want to provide concrete “sample” 16:34:04 for all these artifacts 16:34:30 ed: I don’t think so 16:34:42 The parent POM is the only thing that makes docs in Openstack even editable for devs 16:34:51 heh 16:34:53 #link https://lists.opendaylight.org/pipermail/discuss/2014-April/001976.html 16:34:55 OK... so I think the proposal is something like this: 16:35:10 and #link https://wiki.opendaylight.org/view/OpenDaylight_Controller:How_To:_Site_Deploy 16:35:11 1) Everybody should put up a maven site for their project (at least for their java bits) 16:35:31 2) Someone should come up with templates for the 'guides' sections in asciidoc 16:35:44 3) Projects should start keeping their guides in their repos 16:35:52 4) Roll the 'guides' into the maven sites 16:36:07 5) REST - still some open questions there 16:36:10 Did I get that right? 16:36:14 no quite 16:36:17 er not quite 16:36:21 Amostly standard TOC with chapters, sections, subsections would go a long ways for consistency 16:36:23 on #1: Two maven sites 16:36:25 hum ed I’d avoid full guides in projects if posssible 16:36:26 https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=tree 16:36:29 release and snapshot 16:36:39 and concentrate on “chapters" 16:36:49 mlemay: That sounds very smart 16:36:52 But either way 16:36:57 as in docs we collate the final guides 16:37:00 I think it would be good to link them into the maven sites 16:37:14 I agree with links in the maven site 16:37:17 I can do something with that yes 16:37:19 I honestly don't even care of the maven sites point to the central collated docs 16:37:27 but I still want 2 maven sites 16:37:34 regXboi: Please say more 16:37:46 I also want multiple sites 16:37:47 we need a maven site for snapshot documentation 16:37:54 and we need a maven site for release documentation 16:37:58 for release and for snaphosts 16:38:02 we have to make sure they go different places 16:38:08 mlemay and I are saying the same thing 16:38:10 I agree 1000% with Ryan 16:38:17 if we don't have two, then release docs get lost 16:38:24 which is what happened with Hydrogen 16:38:49 edwarnicke: note - this is a gate on stable/H too :( 16:38:53 regXboi: So basically release and SNAPSHOT repos, right? 16:39:00 edwarnicke: yes 16:39:02 regXboi: ??? re stable/hydrogen 16:39:03 yes 16:39:13 regXboi: I see those as simply two repos for the same docs... 16:39:23 Mlemay, paulz could you augment edwarnicke's proposal or make a different one? We are running over and I'd like to get an actionable proposal from the docs team for folks to consider before departing this mtg 16:39:25 it's a matter of history 16:39:34 k 16:39:49 Madhu: colindixon networkstatic Could we get the concrete docs proposal for the second half of TWS on Monday? 16:40:06 you can think of it as two repos, but as maven says sites - I think of it as sites 16:40:17 #info new agenda request... there is a request for respin of stable/hydrogen... 16:40:30 regXboi: Tomato, Tomatoe 16:40:37 Or you can think of it as trunk and release branch 16:40:55 respin of stable/hydrogen? 16:40:56 what? 16:40:58 1) Create maven site by inherinting from a Maven Site configuration from default parent if possible for consistency (look & feel, reports, etc.) actual confent may change… 16:41:01 edwarnicke: if we have the time after the feature discussion, we can add it to the agenda 16:41:02 See the release list 16:41:11 #link https://lists.opendaylight.org/pipermail/release/2014-July/000037.html 16:41:20 Madhu: I'm fine with that :) 16:41:30 2) Create chapters for guides (install, operations, user guide) so they can be imported in final documentation guides 16:41:42 mlemay: OK... so who has what actions for docs? 16:41:50 edwarnicke: oh that :( 16:42:04 So really important then is template for chapter 16:42:20 rockyg: I agree... and overall 'what chapters do we need from the projects' 16:42:22 3) Link guides and any other relevant artifacts + info in sites 16:42:37 4) Document the API accordingly (RESTconf will need special attention) 16:42:51 mlemay ++ 16:43:01 OK... I hate to be the action item guy 16:43:10 But what are the concrete actions, who is doing them, and by when? 16:43:16 ed: on action item.. it’s me doing that in docs project.. :S 16:43:33 mlemay: You have a lot on your plate, anyone else able to help guys? 16:43:41 mlemay is doing our tooling... maybe there is someone who can help? 16:43:45 mlemay: And I don't think all the action items are on you 16:44:06 ed: exactly a bit much on the plate at the moment ;) 16:44:12 edwarnicke: I agree... I think some of that is on the projects themselves 16:44:25 @ed: I can at least give out templates 16:44:26 ? 16:44:32 I would expect for example that #1 and #2 are on the projects 16:44:35 I'm not well-versed in the tooling... need someone more in tune with Maven, etc 16:44:36 So.. here's what I think I heard that could be made useful AIs: 16:44:40 @ed: action me on the default site structure if you wish 16:44:47 Tmeplates move responsibilities to projects :-) 16:44:54 1) Clear directions on how to do a maven site for your project (regXboi? maybe already done) 16:45:03 I already have potential template for guides 16:45:06 2) Each project needs to get someone named responsible for getting that up 16:45:08 kewl 16:45:30 what I can do is setup how to do it in “reservation” project and send that off 16:45:30 3) Templates need to be written for chapters (rockyg?) 16:45:30 #link https://wiki.opendaylight.org/view/OpenDaylight_Controller:How_To:_Site_Deploy (for #1) 16:45:34 I have to do it anwyays 16:45:47 Does it make sense to have a person from each project as a contact for the docs team?.. for both cross-project coordination and as the contact for per-project-content? Shall we have the docs team send a note to release to get those names? 16:45:49 4) Clear directions on how projects can start contributing their chapters 16:46:00 5) Projects need to identify a responsible person for their chapters 16:46:10 phrobb +1 a contact point per project on dos 16:46:12 6) Someone should actually get this stuff clearly on a simple wiki page that can be referenced 16:46:17 ^dos^docs 16:46:20 phrobb: +1 that would be great 16:46:23 edwarnicke: I think #1 is done - see above link 16:46:24 So... does that sounds reasonable to folks? 16:46:33 +1 16:46:33 edwarnicke: +1 16:46:40 regXboi: Awesome, we just need to get it int #6 then :) 16:47:01 regXboi: I am inclined to count #1 as assigned to you and completed then :) 16:47:05 * regXboi confused - I just gave a wiki link 16:47:24 I can do the documentation on the wiki pafe once 1-5 are done... 16:47:27 I don't know if it's "simple" but it walks through the whole thing 16:47:36 oh... n/m I get it 16:47:48 @reg / @ed: making sure that project site-deploy via jenkins should be part of M4? 16:47:55 at least with respect to #6 16:48:07 #action regXboi 1) Clear directions on how to do a maven site for your project 16:48:07 and yes _ I have #1 and I think it's done 16:48:23 #info regXboi Completed "1) Clear directions on how to do a maven site for your project" 16:48:36 #link https://wiki.opendaylight.org/view/OpenDaylight_Controller:How_To:_Site_Deploy - for "1) Clear directions on how to do a maven site for your project" 16:48:38 #info note: that will modify based on the template changes 16:49:00 phrobb: Would you mind doing the cat herding for #2 ? 16:49:06 #action mlemay to provide maven site template for consistency across projects 16:49:12 mlemay: can I look to work with you on adapting that link when we have the template? 16:49:22 regXboi: of course 16:49:30 #action phrobb to work with projects for contacts to the docs group 16:49:39 phrobb: many thanks 16:49:42 #action regXboi and mlemay to adapt site deploy how to wiki once the template is available 16:49:51 mlemay: thanks :) 16:49:55 @all just out of sanity on my behalf.. which is higher priority docs template vs karaf instructions? 16:49:56 phrobb: What is the goal date for #2? 16:50:03 rockyg: Are you willing to pick up #3? 16:50:12 (or is someone else) 16:50:19 mlemay: karaf 16:50:21 edwarnicke: when do APIs have to be frozen? 16:50:26 M4, right? 16:50:31 regXboi: M4 if memory serves 16:50:54 yes - then M4 is deadline for docs 16:51:01 we freeze the APIs and put them in docs 16:51:13 edwarnicki: I think a docs person needs to do the template. 16:51:36 But I can work with a docs person... 16:51:39 Guys... who can do the templates for chapters? (not mlemay ... love you dude... but to much on your plate already) 16:51:39 @all to know on the TODO from a API poitn of view.. what is the propostion of projects using RESTconf vs Jersey Northbounds? Anyone knows that? 16:51:40 edwarnicke: since I've been pestering everybody over the past week or so, I'll just continue on immediately. Let's say 1 week to get all the cats identified (7/16) 16:52:09 mlemay: right now, that wiki page is based on Jersey for REST northbound 16:52:11 Cool, could you #action in with the date? 16:52:25 we can update it once we collectively figure out RESTconf 16:52:42 regxboi: yes I know, I’m asking as it affects tooling.. 16:52:45 regXboi: I think we have something figured out with swagger, just need to dig it out and link it in :) 16:52:56 edwarnicke: you beat me to the question 16:52:56 k 16:52:59 Is there a dependency on the pure-karaf decision that ties to how docs are done? 16:52:59 So... guys... seriously... who can do #3? 16:53:10 phrobb: I don't think so...mlemay, thoughts? 16:53:18 I'm not familiar with #3 enough to step up 16:53:37 phrobb: pure-karaf decision will have impact on install guides and user guides from the docs projects 16:53:43 Do we have a chapter people like we can pattern on? 16:53:50 OK... so we are blocked at #3... can we take the beg to the lists/TSC? 16:53:57 yes 16:53:59 I think we need to 16:54:03 you have a smaple book from docs 16:54:14 mlemay: link? 16:54:16 phrobb: Could you take the action to ask dmm to add the docs stuff to the TSC agenda? 16:54:33 #link https://git.opendaylight.org/gerrit/gitweb?p=docs.git;a=tree;f=manuals/sample-guide;hb=HEAD Sample Guide in Asciidoc 16:54:34 @all: Anything else addressable on docs? 16:54:41 edwarnicke: I can take that action 16:54:44 if you want to give to me 16:54:47 tell dmm about docs 16:54:53 (I mean right now on this meeting... because if not I'd like to briefly discuss the stable/hydrogen respin) 16:54:56 #action phrobb to send a mail and go searching for someone to create docs template for per-project content 16:55:14 #action colindixon to ask dmm to add docs to TCS agenda 16:55:17 Will the sample ascii doc work as a template? 16:55:31 rockyg: Might, I don't know 16:55:41 yes 16:55:48 so we want projects to put together just chapters, correct/ 16:55:51 er correct? 16:55:53 yes 16:55:58 regXboi: That was my understanding, yes 16:56:13 Guys, can we switch to stable/hydrogen respin as the topic now? 16:56:13 If no more questions/comments, we'll move to hydrogen respin…. 16:56:15 Cool. That's #3. At least good enough for the moment? 16:56:15 um... then isn't it just extracting out the chapter portion of that source and linking it? 16:56:21 ideally this way I can aggregate the projects in a “part” of the Book which would start with “common” stuff then dig in project specifics 16:56:25 phrobb:... give me a moment 16:56:32 regXboi: ok 16:56:41 yes 16:56:46 @regXboi : yes 16:56:57 then people can write anything using this: 16:57:15 ok... then I can step up to #3 and create an adoc which is just the chapter section from that sample doc and contribute it back to the docs project 16:57:22 because it's just a simple copy/edit 16:57:34 (unless I misunderstand how things work) 16:57:46 http://asciidoctor.org/docs/asciidoc-writers-guide/ 16:57:50 regXboi: sounds good, are we ready to switch topics? 16:57:54 yes 16:58:04 phrobb: yes ;) 16:58:06 ok... then action me with #3 16:58:08 and we can move on 16:58:34 @phrobb: will you mail the minutes link to release ML when we are done? 16:58:36 #action regXboi to "Write templates needfor chapters" 16:58:50 #topic Hydrogen Respin 16:59:12 regXboi: Yes 16:59:28 edwarnicke: you want to lead this topic off? 16:59:36 #link https://lists.opendaylight.org/pipermail/release/2014-July/000037.html 16:59:40 @phrobb: thanks 16:59:49 We have a request to respin stable/hydrogen 16:59:58 We have not yet released stable/hydrogen 17:00:09 A respin can be done 17:00:14 How would we like to proceed with it? 17:00:22 We have not yet released the 1st stable/hydroegn, right? 17:00:27 hideyuki: Correct 17:00:32 Folks have been testing the release candidate 17:00:35 edwarnicke: Thanks :) 17:00:39 Which is the origin of the request for respin 17:00:55 I think a respin is fair 17:01:03 since this is from testing of the RC 17:01:22 So... how should we handle it? 17:02:06 I'm not getting the point of the q? 17:02:07 I would tend to give some appropriate notice to release (24 hours, 48 hours?) and then set a 'last call for objections to release' for some point next week - say Tuesday. Then the TSC can consider it next Thursday 17:02:08 Thoughts? 17:02:46 notice to release or notice to respin? 17:03:00 and I'll make an objection to release now :) 17:03:08 notice email of respin to release@lists.opendaylight.org 17:03:20 edwarnicke: does that mean all the projects must retest it ? 17:03:31 Madhu: A respin would mean a new release candidate. 17:03:44 so the answer is yes :) 17:03:46 I would recommend that projects test the release candidate 17:03:55 (I can't *make* them ;) ) 17:04:05 email notice of respin: +1, 24 hours: +1, retest: yes, objection: documentation 17:04:24 And we call Tuesday the cutoff for folks to object to that release candidate being published as the release 17:04:40 Madhu: Does that make sense? 17:05:03 * regXboi ducks on this one 17:05:09 @edwarnicke which Tuesday? 17:05:21 I think 7/15 17:05:21 general question to all. 17:05:27 so how do we decide on these dates ? 17:05:28 regXboi: Can I action you to raise the stable/hydrogen docs things at *this* weeks TSC? 17:05:35 we had the same discussion 2 weeks back 17:05:39 edwarnicke: sure 17:05:43 Madhu: I am simply making a proposal 17:05:45 and last TSC was the date to cut the release artifacts 17:06:11 Madhu: Last TSC the question of whether to release the release candidate was brought to the TSC 17:06:25 edwarnicke: yes. 17:06:35 My recollection of the consensus was that folks were not comfortable it had been sufficiently tested, and so we bumped the issue a week 17:06:48 edwarnicke: okay. 17:06:51 If you are suggesting that the TSC make the call on a respin, I'm fine with that 17:07:02 I still think that notice to release that the question is up is appropriate 17:07:21 Madhu: does that split the difference? :) 17:07:47 this meeting has gone way past 60 mins :) and don't understand the differences :) 17:08:12 Madhu: Its simple: the TSC makes the call tomorrow on whether to respin. We let release know the TSC is making that call tomororw. 17:08:22 (so if folks want to be part of that discussion they can) 17:08:37 Madhu: Does that make sense? 17:09:13 okay. back to TSC 17:09:20 and each project to retest 17:09:23 thanks 17:09:27 If a respin is done, yes 17:09:40 Makes sense to me. Will there be someone from the group who is making the case for the need for the respin? 17:09:43 But no respin till after the TSC discussion 17:09:56 I can try to arrange for that, yes 17:10:00 I'll make the case if nobody else does 17:10:13 thanks edwarnicke 17:10:19 but then again, I'll also make the case that the release isn't ready :( 17:10:35 even after the respin and assuming all the tests pass 17:10:42 With that, are we concluded? 17:11:04 I'll move to adjourn 17:11:12 * edwarnicke seconds 17:11:20 any opposed?..... 17:11:22 no I meant I'm going to go find lunch :) 17:11:33 #endmeeting