15:12:15 #startmeeting Ansible Public Core Meeting 15:12:15 Meeting started Thu Aug 18 15:12:15 2016 UTC. The chair is abadger1999. Information about MeetBot at http://wiki.debian.org/MeetBot. 15:12:15 Useful Commands: #action #agreed #halp #info #idea #link #topic. 15:12:15 The meeting name has been set to 'ansible_public_core_meeting' 15:12:16 * bcoca is picturing abadger1999 in a suit behind a desk on a tv set 15:12:27 #topic Roll call 15:12:30 who's here? 15:12:48 hi! 15:12:58 hiya 15:12:59 hi 15:13:06 #chair shertel bcoca Qalthos misc 15:13:06 Current chairs: Qalthos abadger1999 bcoca misc shertel 15:13:35 hello 15:14:12 linuxdynasty: 15:14:18 #chair linuxdynasty 15:14:18 Current chairs: Qalthos abadger1999 bcoca linuxdynasty misc shertel 15:14:30 #topic Open floor 15:14:45 Anyone have topics/issues/PRs they especially want to get to? 15:15:33 Any updates on https://github.com/ansible/ansible/pull/17039 ? I know I asked yesterday, but this is blocking me from creating new prs that is based on this decorator 15:15:49 bcoca: ^ 15:16:07 #topic CloudRetry/AWSRetry backoff decorator with unit tests https://github.com/ansible/ansible/pull/17039 15:17:01 Would be nice if in the 2.2 release, some of the AWS modules will not be plagued by those common issues anymore. 15:17:07 need to find time to come up with standard, got day full of meetings today 15:17:13 kk 15:17:23 so bear with us, abadger1999 can we make time tmrow? 15:17:54 Sure.... I don't have much to contribute unless you need info on how this interacts with ansiballz (which should be pretty transparent) 15:18:16 np at all, sorry for pestering on this, just trying to help out with the AWS modules :D 15:18:19 kind of that and what would be best pattern for reuse across modules 15:18:24 15:18:24 k 15:18:27 linuxdynasty: pester, its only way we'll keep on it 15:18:50 ryansb might be interested too since he's been working on AWS stuff in general 15:18:52 probably also want ryansb on this too 15:18:57 JINKX 15:18:57 jinx 15:19:08 :-) 15:19:10 oh hey 15:19:11 we spend waaay too much time toghether 15:19:13 hehe 15:19:22 work wife? 15:19:24 lol 15:19:25 jk 15:20:09 #action bcoca, ryansb, abadger1999 to talk about https://github.com/ansible/ansible/pull/17039 tomorrow. linuxdynasty to continue prodding with with a progressively hotter poker. 15:20:17 lol 15:21:32 We have a large number of proposals out there... I get the impression we haven't gone through them in a while. 15:22:23 we have not 15:22:26 1/2 seem to be mine, feel free to ignore 15:22:35 we' valready discussed most of those 15:22:38 k 15:22:56 https://github.com/ansible/proposals/issues/22 < = there is even pr that started implementing this 15:22:58 do we have a procedure for removing/cleaning up? we can kill the pub/sub one since it's implemented 15:23:42 jimi|ansible: I don't think we do -- Close with a comment that it's implemented is probably fine. 15:24:20 well, the PR creates a doc, and we accept the PR to create the doc... now we have to remove the doc 15:24:29 yeah if it's just an issue/PR we can close it 15:24:50 i guess technically we should open a PR to remove the doc 15:24:56 then if there are no comments merge it to remove it? 15:25:19 @gregdek ? 15:25:33 #info For community members, he Core team is going to choose between https://github.com/ansible/proposals/issues/30 and https://github.com/ansible/proposals/issues/28 (The Module metadata proposals) next week. 15:25:35 ^ probably community team needs to establish rule, i remember discussing this initially 15:26:03 * gregdek reads 15:26:36 Ah. 15:26:54 So if you have any thoughts on the metadata please add them to one of those two tickets ASAP 15:27:43 We've gone round and round on the proposal stuff, and in the end I don't know that we've clarified it much. I'm just happy to have a place where proposals can be seen. 15:27:47 also I shifted to using 'issues' not 'PR's for the proposals, i thought that was new way to go 15:27:58 It's ok. 15:28:35 so we can just 'make note: this was implemented in #XXXX' at top of docs? or when closing issue? 15:28:45 I like that. 15:29:09 yeah just having it be issues is a bit easier, nothing to clean up 15:30:08 Cool. 15:30:55 So proposals.... 15:31:13 i'll just nuke the pubsub one and we can close any other issue that's still open regarding that 15:31:18 I think this is the oldest one inthe list that hasn't been presented at a meeting: 15:31:32 #topic Define a standard way to document playbooks https://github.com/ansible/proposals/issues/19 15:32:07 https://github.com/ansible/proposals/commit/9d8c15811e200bb8918ca149d0d102cd489a8666 15:32:09 currently we only have 'name:' , drybed has created his own standard for debops 15:32:48 jimi|ansible: remove the doc? why not just comment, that way doc/discussion is easily accessed 15:33:05 it's in the git history 15:33:10 good enough 15:34:18 There's a lot of discussion there but much of it is for roles. 15:34:20 proposal 19 has a big problem, playbooks are not yaml files anymore 15:34:28 The original submitter wanted something inside of playbooks. 15:35:00 drybed's format uses # , which keeps the files as yaml, sadly no yaml multiline 15:35:01 so it sounds like we would instead need a new field in the yaml schema? 15:35:11 ah... using comments. 15:35:35 More documentation is always good. I am using a README.md in each role and in each directory in my vars. Having a standard would be awsome though 15:35:42 im not happy with any of the implementations, been thiking about a 'play level meta/ dir that can have conig.yml and readme.md 15:36:06 or playname.md 15:36:32 I'm unclear on what hte use cases are here. 15:37:04 I see it as useful in general but I'm not sure what we're trying to achieve other than "more documentation". 15:37:07 yeah, i don't see why the docs of that have to be ingrained in the playbook 15:37:08 or docs/ dir? 15:37:19 Who writes this? Who consumes this? How do they get access to it? 15:37:50 well, drybjed has his own system with those things worked out, but it does not work with any of our infra 15:38:03 it doesn't have to, it's a user-side thing 15:38:30 drybjed's case seems to be role author writes this. Users of galaxy consume it. They access it via a web page. 15:38:38 jimi|ansible: then it shoudl be ansible-doc compatible or something easy, not require users to have sphinx/readthedocs 15:38:48 It is a user side thing, but when you give the community a standard, it gives them something to strive for and than sharing playbooks/roles/etc is easier and well defined 15:38:50 imo 15:38:53 which is fine. But it isn't the same as the proposal author at all. 15:39:28 agreed, but i think most see initial prposal as lacking and not as usable 15:39:46 as you said, no consumer also 'breaks yaml' 15:40:22 linuxdynasty: Could you lay out the use case? Alice is a W and wants to document X in her playbooks. Bob uses Y to read the documentation so that he can Z. 15:41:14 i would ask that any documentation added, should be usable from ansible-doc or other cli tool, requiring a specific web app/service seems too onerous 15:43:39 Y being a CLI tool without web service backing it seems like this is for playbooks that I already have on my machine (slightly different from drybjed's case of documenting a role for people who might want to download it from galaxy) 15:44:26 im not saying w/o a webservice, i'm saying that require CLI tool ALSO 15:44:38 so people have the option to not need a webservice 15:45:09 you might want to look at 'shared' plays/roles or just check the one you are about to run 15:45:25 if we are gonig to add this documentation, it should be available at all points 15:45:34 s/available/accessible/ 15:46:44 #info requirement: have a way to view documentation in playbooks that are on your current machine via a cli tool. 15:47:04 bcoca: How does this differ from vim playbook.yml, read inline documentation? 15:47:25 that might be a way, if the doc format is legible that way 15:47:41 that assume that the doc is in 1 single place in the playbook 15:47:42 if there is any formatting/processing i would move to ansible-doc 15:47:54 what if that's split accross the file or something ? 15:48:03 misc: depends on standard adopted 15:48:09 bcoca: yeah 15:48:36 #info Would like some use cases "Alice is a W and wants to document X in her playbooks. Bob uses Y to read the documentation so that he can Z." That way we can understand the problemspace we want to address. 15:48:48 https://github.com/debops/ansible-environment < =drybed example, uses docs/ dir 15:49:10 agreed, we need example usages to narrow this down 15:49:27 original proposal is for 'inline in plays' 15:49:43 bcoca, misc: i would use same order in which ansible does play> role(in order of ref) 15:51:05 playbook?, we conflate playbook and play but they are diff units 15:51:16 playbook>play>role 15:52:40 ok, so to cut this short, the proposal seems insufficient, a more detailed one is needed, no one against the idea of more docs, just need a) use cases, b) more detailed proposal with consumers and dealing with playbooks/plays/roles 15:52:46 probably also include files 15:52:54 15:53:06 Sounds good, I'll post that to the ticket. 15:53:10 frankly, i'd prefer to see this as `ansible-playbook --docs` as opposed to extending ansible-doc 15:53:25 jimi|ansible: fine with that, as --list-tasks is currenlty the 'playbook doc' 15:53:37 ansible-doc is very much about the existing module documentation, and i don't really want it building things on the fly 15:53:57 well ... it does build those on fly right now 15:54:16 but diff discussion, i think we just need a more complete proposal first 15:54:22 #topic Open floor 15:54:36 One more call for other issues from anyone here. 15:54:46 https://github.com/ansible/proposals/pull/27 <= close as dupe of roles revamp? 15:54:57 We only have 7 minutes left which likely isn't enough to get through another ansible/proposal 15:55:12 #topic https://github.com/ansible/proposals/pull/27 Make role re-use easier 15:55:18 in my opinion the playbook documentation should be how the playbook works and what globals are set and why are some roles included etc.. and the role explains the tasks, includes, and vars 15:56:04 usecase, is the other engineers on my time, use to read my confluence page and they felt it was and overwhelming amount of information 15:56:27 But when I broke it down by playbooks, role, vars 15:56:30 that made alot more sense 15:56:34 to the team 15:57:31 linuxdynasty: we all agree feature is useful, just want a more 'usable proposal' 15:57:54 yep 15:58:20 linuxdynasty: k. So you're after some structured overall view of the playbook. 15:59:15 yes 15:59:20 so no objections on current topic? everyone prefers to discuss previous one? 16:00:16 closing as dupe of https://github.com/ansible/proposals/blob/master/roles_revamp.md then 16:00:19 bcoca: For proposal 27... it's a PR against your proposal. 16:00:43 but from the comments, it sounds like the author doesn't understand how your proposal is implemented in the playbook? 16:01:10 mostly 16:01:19 i added comment, which i should update the doc with 16:01:27 might just do PR and close this one as fixed by mine 16:02:21 ^ why i like 'issues' more as it can have all the current discussion in one place and not over several PRs 16:03:35 bcoca: Is there some aspects of the changes that are already part of what is being done and others that are not being implemented? 16:04:35 It seems like he covers a lot of ground and I'm not clear whether there's anything new or if it's all misunderstanding of what the role revamp proposal is. 16:05:21 both 16:05:50 he is hinting to something not clear in the proposal but that i'm already implementing, see my last comment 16:05:57 k 16:06:29 so yeah -- I suppose make a PR that clarifies those things that he's trying to point out that closes this PR. 16:06:32 i've been bad on posting updates, had design discussions during all hands, jimi|ansible and tima gave me good feedback 16:06:56 Probably the best way to leave a trail now. 16:07:09 yep 16:07:22 #topic Open floor 16:07:28 #undo 16:07:29 Removing item from minutes: 16:07:30 <- lunch, my only chance as i got backtoback meetings rest of day 16:08:05 #action bcoca to writeup new PR to clarify the points that proposal/27 is trying to address 16:08:09 #topic Open Floor 16:08:17 Anything else? Or I'll close in 60s 16:09:22 #endmeeting