wilas / vbkick

Tool for building and maintaining VirtualBox VMs described as a code in a single definition file.
Other
8 stars 5 forks source link

Rename definition.cfg vbkickfile or vbkickfile.cfg? #56

Closed gregelin closed 10 years ago

gregelin commented 10 years ago

The name definition.cfg makes sense, but definition is also a very generic term.

Vagrant has a Vagrantfile. Git has .git directory. Word has word (or document) files. ESRI GIS has shape files.

This suggests two major naming patters:

  1. Name the key data file after the application
  2. Name the key data file that represents the object being represented (e.g., created) by the application.

Some ideas: vbkickfile, vbkickfile.cfg, machinefile, virtualmachine.cfg, machinedef.cfg

wilas commented 10 years ago

I was expecting this ticket :) I was thinking for a while about changing definition.cfg to something else and choosing a proper moment for this. There is not too many vbkick users at the moment so I think we can safely make a change before v0.7. I though that Vbkickfile - similar to Vagrantfile is a good name, but now sound for me a bit like configuration file for the vbkick. What about vbmachine.cfg ? It always leave a space for vbcluster.cfg

gregelin commented 10 years ago

I like vbmachine.cfg and vbcluster.cfg.

I don't think Vbkickfile would be confused with a configuration file for the app itself. Config files are often called config, or in hidden directories or as hidden files. The key tie is between the application (vbkick) and the file the application consumes as input (Vbkickfile). The pairing will be better.

Does vbkick only work with virtual box, hence "vb"kick? Or have you also thought of vmware in the future?

I would definitely find it easier to understand and explain the pairing of "vbkick" and "Vbkickfile" or "vbmachine.cfg. It's conceptually easier. The symbolic linking is a nice benefit of your structure, but I think most people will want a repo with a particular file defined like you are pursuing now. (I think the common.cfg is nice, too.)

gregelin commented 10 years ago

While discussing names, I do find "vbkick" a touch awkward to type and remember. I had to practice.

My theory, FWIW. The first two key strokes involve the same finger of left index striking v then b. Third and fourth key strokes use same finder also, right middle finger striking k then i. So it is not a rolling finger combination like many words, but two taps with left index followed by two taps with right middle.

Also, "vbkick" consist two "words" together. The first word "vb" is an acronym for "virtual box" plus a shortened word and three syllables to say with 4 hard sound. This all sounds picky, I know. The observation is that vbkick has more complexity than "docker" or "vagrant" or "chef" or "puppet". "vbkick" is very descriptive to sysadmins (virtual box + kickstart). Very few developers think much about kickstart files, however. It depends on who you are targeting.

Finally, "v" and "b" sound a lot alike over the phone and with accents. It's clear when when reading of course.

Just my opinion. I'm not sure I have an alternative suggestion. I love what vbkick does!

wilas commented 10 years ago

vbkick works only with the virtualbox and there is no plans to support other platforms. It should do one thing but well. I think virtualbox is enough good to use it as a personal lab (e.g. simulate bare metal with linux container or solaris zone on board). The real production infrastructure should be designed and implemented for the needs of organization including costs etc. - big topic :)

Ok, I'm going with the vbmachine.cfg name for one more reason - in one template may be defined multiple machines: vbmachine-7.5-x86_64-noX.cfg, vbmachine-7.6-i386-beta.cfg

Well vbkick mean - kick the VirtualBox ;-)

gregelin commented 10 years ago

Iol.

I thought vbkick stood for "virtual box kickstart."

"Kick the virtual box" is a sensible, memorable visual. An action rather than the two nouns that I thought it meant.

Kickvb is also nice. "kickvb" is easier to type and remember than vbkick. The stories are in a nice circle and begin with a word.

Kicking the vb also explains the structure of the code better. I can kick it to do pieces, from get started, to run the post install scripts to export a vagrant box.

That image makes vbkick easier to remember.

Greg Elin P: 917-304-3488 E: gregelin@gitmachines.com

Sent from my iPhone

On Jun 2, 2014, at 1:45 PM, Kamil Wilas notifications@github.com wrote:

vbkick works only with the virtualbox and there is no plans to support other platforms. It should do one thing but well. I think virtualbox is enough good to use it as a personal lab (e.g. simulate bare metal with linux container or solaris zone on board). The real production infrastructure should be designed and implemented for the needs of organization including costs etc. - big topic :)

Ok, I'm going with the vbmachine.cfg name for one more reason - in one template may be defined multiple machines: vbmachine-7.5-x86_64-noX.cfg, vbmachine-7.6-i386-beta.cfg

Well vbkick mean - kick the VirtualBox ;-)

— Reply to this email directly or view it on GitHub.

wilas commented 10 years ago

Maybe kickvb sounds better but vbkick follows vb* naming theme. convert_2_scancode.py will be renamed in near future to vbtyper.py. Maybe I should write somewhere what "vbkick" mean :)

gregelin commented 10 years ago

What's the 1 paragraph story behind vbkick? I could edit.

Greg Elin P: 917-304-3488 E: gregelin@gitmachines.com

Sent from my iPhone

On Jun 2, 2014, at 2:01 PM, Kamil Wilas notifications@github.com wrote:

Maybe kickvb sounds better but vbkick follows vb* naming theme. convert_2_scancode.py will be renamed in near future to vbtyper.py. Maybe I should write somewhere what "vbkick" mean :)

— Reply to this email directly or view it on GitHub.

wilas commented 10 years ago

It's a description in README.md - feel free to add 2nd paragraph within description section.

wilas commented 10 years ago

This was done.