Welcome!

SDN Journal Authors: Jeremy Geelan, Pat Romanski, Elizabeth White, Patrick Pushor, Mark van Rijmenam

Related Topics: Virtualization, SOA & WOA, Web 2.0, Cloud Expo, Big Data Journal, SDN Journal

Virtualization: Blog Feed Post

Design Docs, Code Comments, and . . .

We need to treat our projects more like research projects, and keep a “notebook” somewhere

When first you build a bookshelf from raw wood, on your own, you learn a lot. While the first may be the only one you ever want to build, by the time you’re done, you know you could have done X, Y, or Z better. This is true of so many crafts. You get better by doing, in large part because you learn new tricks, figure out how to make useful tools, get more efficient because you purchased more useful tools… I know that while I would never consider myself an artist, painting models and miniatures has made me progress to where some have called me one. (Picture is a battery of M7 “Priest” artillery I painted up – models by Brittania miniatures)

The thing is, when it’s a hobby, or you’re a one man shop, or the job is not particularly taxing, this knowledge is easy to keep around. You have that jig you built to make cool shelf angles hanging on the wall, or the box of perfect fasteners is still on the shelf. The glue or stain you settled on is what you kept when the last shelf was built, etc.

But when the job is complex, and the problems increasingly so, it is not so simple. When the tools used to achieve a solid solution – the things used to learn and used to improve your productivity – are on a disk somewhere in the org, things get a little more complex.

But not irretrievably. You just need to pay a little more attention.

When you’re developing an app or configuring a network, there is the design, showing what is to be done, the code comments describing what was done, and the finished product for use by the enterprise. You have accumulated knowledge, which is good for you and the organization, but you also did some other things that normally fall through the cracks. That tool you cobbled together to check the validity of file formats, or the browser plug-in that helped you resolve network issues, or the DNS tool you downloaded that helped you get redirection correct… These things are important. Just as important as the tool I discovered to make the mud up the side of that vehicle. More important, because in a hobby I have time to mess around and reinvent the wheel if I must. in the enterprise, I’ve never met the IT staffer that went “you know, I did this seven months ago, I think I’ll just go figure out how to do it all over again, I’ve got the free time”. Never.

So what you need to do is keep track of these things. Put them in version control, store them on a special share for just such tools under a heading/directory that associates the tool with the project it helped with. Even silly little things. And put them in a word document if they’re things like links to a web page. Sure the page may be gone when next the word doc is opened, but that’s true of bookmarks in your browser too, and your word doc is likely to have greater longevity. This is for you – because in many orgs if you created it, it’s your problem for eternity – but it is also for the organization, because eventually it will not be your problem, and it will save the next poor person from figuring out how to do the same things. I’m not talking about tools like lint, if you don’t have a corporate standard to use that type of thing though, you could include it. I’m talking about that library you found that does what you wanted, but was a nightmare to configure. So document it. While you’re celebrating that you got it going. Save someone else the headache. Or yourself, should something horrendous happen and you have to configure it from scratch again.

Devops has helped in this regard with networking, by stressing repeatable processes, but developers are asked to do something different almost every app. Patterns are great, but it’s rarely patterns that trip us up, it’s some weird exception case that only occurs in this language/environment/requirements document. Much more difficult to turn into repeatable, when if it was simply repeatable you’d have found source or used a library to achieve it quickly.

What we do is more science than art. We need to treat our projects more like research projects, and keep a “notebook”. somewhere. Those tools, random observations, difficult to discern but very profound solutions… All of that could be part of the intellectual property of the app/tool/network in question, making everyone more productive. But document it in English (or the tongue spoken by the bulk of your coworkers, for my international friends), not in your “from here I understand a ton, I’ll write about the bit I just learned”.

Sometime soon – hopefully next week – I will be writing up my solution (and recommended more generic solution) to the several issues found in Android SSL. By writing about it out here, I am documenting what I went through, and have to write about it in plain English. You need to do the same (but normally internally only, so you don’t have to explain the entire environment/problem-set), so that five years from now, the local Intern can figure out how to work on your app/network. Or you can remember what the heck you did to make it work. ;-)

You’ll thank yourself. Most good developers I know have forgotten more coding projects than they remember, and this might provide the clues to get back up to speed when it circles around and you have to work on the solution again. I assume network admins have the same problem. Your employer will thank you, because you (and potentially anyone else asked to work on it) will be more productive, just like using that jig over again is more productive. It’s not necessarily part of the solution, but it makes building the solution far easier.

Meanwhile, keep building the next generation of apps and networks, we’re expecting lots, and even though complaints are louder than compliments, no one can argue that developers and network admins as a whole haven’t responded in astounding ways over the last 30 years. Unless you prefer disconnected mainframes I suppose...

Read the original blog entry...

More Stories By Don MacVittie

Don MacVittie is a Technical Marketing Manager at F5 Networks. In this role, he supports outbound marketing, education, and evangelism efforts around development, storage, and IT management topics related to F5 solutions. His role includes authoring technical materials, participating in social and community-based forums, and providing guidance for the development of marketing resources. As an industry veteran, MacVittie has extensive programming experience along with project management, IT management, and systems/network administration expertise.

Prior to joining F5, MacVittie was a Senior Technology Editor at Network Computing, where he conducted product research and evaluated storage and server systems, as well as development and outsourcing solutions. He has authored numerous articles on a variety of topics aimed at IT professionals. MacVittie holds a B.S. in Computer Science from Northern Michigan University, and an M.S. in Computer Science from Nova Southeastern University.

Cloud Expo Breaking News
With Cloud Expo New York | 12th Cloud Expo [June 10-13, 2013] hurtling towards us, let's take a look at the distinguished individuals in our incredible Speaker Faculty for the technical and strategy sessions at the conference coming up June 10-13 at the Jacob Javits Center in New York City. We have technical and strategy sessions for you all four days dealing with every nook and cranny of Cloud Computing and Big Data, but what of those who are presenting? Who are they, where do they work, wha...
The new open source cloud orchestration platform called OpenStack is the promise of flexible network virtualization, and network overlays are looking closer than ever. The vision of this platform is to enable the on-demand creation of many distinct networks on top of one underlying physical infrastructure in the cloud environment. The platform will support automated provisioning and management of large groups of virtual machines or compute resources, including extensive monitoring in the cloud.
In his session at the 12th International Cloud Expo, Dave Eichorn, Global Data Center Practice Head at Zensar, will share a case study describing how a utility services company handled the migration of its Microsoft platform to the cloud. Challenged with the time-consuming task of opening operations out of temporary offices, this company struggled with the need to simultaneously access data that was accumulated from a vast amount of data-intensive jobs. Zensar migrated the company’s application ...
At pennies per virtual machine-hour, the economics of cloud computing are both compelling and daunting to replicate. Whether you are building your own cloud infrastructure, building a public cloud or choosing a cloud service, there are key strategy and technology decisions that make the difference between success and failure. In his General Session at the 12th International Cloud Expo, Jason Waxman, VP in the Intel Architecture Group and general manager of the Cloud Platforms Group within Inte...
You're getting pitched every day from your legacy enterprise software and hardware vendors about "cloud." They're doing an amazing job of convincing your CIO and CTO about what cloud is and how you should use it. The reality is they're defending their shrinking market share and keeping you on the legacy treadmill for as long as they can by selling you solutions that aren't "cloud." In her session at the 12th International Cloud Expo, Niki Acosta, Cloud Evangelista for Rackspace, will talk thro...
The rise of cloud computing has exposed hard drive-based storage as the new data center bottleneck. Combating this, data center managers have deployed SSDs to gain the performance needed to provide real-time access to data. However, due to budget constraints, many have turned to consumer-grade SSDs without understanding that they wear out quickly when processing enterprise workloads. In this session, Esther Spanjer will discuss recent endurance advancements in SSD technology that enable usage of...
SYS-CON Events announced today that Wowrack will exhibit at SYS-CON's 12th International Cloud Expo, which will take place on June 10–13, 2013, at the Javits Center in New York City, New York. Wowrack’s core expertise lies in high-availability Private and Public Cloud IaaS Hosting Solutions. Wowrack provides a true Hybrid service – where business release all IT management and hardware provisioning – taking the data center and server system administrative headaches off our customer’s shoulders. ...
Organizations across the world are increasingly starting to see the benefits of moving more and more services to the cloud. The focus on the cost-saving potential of cloud is rapidly shifting to completely transforming the business with cloud. As organizations are investing enormous sums on technology they are starting to realize that in order to maximize the return on investment and accelerate the business transformation process the first area of focus should be people. By ensuring the organiza...
"Since Cloud Expo is running the week of June 10, we thought it'd be a great idea to schedule our Meetup this week. That way, if you have colleagues, friends, or family in town that week for the Expo, you can invite them to join you!" With those words, the OpenStack New York Meetup Group's organizer's launched a landing page this week where anyone interested can register for the June 12 evening event.
Organizations want extraordinary results from their IT units. Today's mantra is faster delivery, better quality, cheaper solutions, and safer environments. Many CIOs are implementing cloud computing enterprise architectures to address these challenges with results varying greatly. Why are some organizations seeing only limited results from cloud computing implementations while others are increasing market share, decreasing costs, generating value, and innovating faster?