Skip to main content

As a Dev Ops Coordinator I would like a tool which allows central creation of diagrams which "live update" in several places.

Part of the CI/CD Development Series

In order to achieve your goal, you need to a) have one and then b) find the best way to clarify that goal into some tangible medium. Paper and doodling is a great start but eventually those doodles need to be put into a some clear communication format which is accessible to yourself, your team and anyone else who needs to see what you are striving for.

There are several diagrams that go into communicating the plans and specifics of software projects. UML has several diagram listings including Deployment Diagrams, such as the one below, Component Diagrams, Activity Diagrams and more.

This inevitably leads to the multiple problems of
 - How to develop the diagrams
 - How to publish the diagrams in locations which can be referenced by the target audience
 - How to update the diagrams which have been distributed or published.

This last item is probably the most difficult since it is easy to put off publishing the new diagrams until it is "finished" or accidentally overlooking locations where it has been published or distributed.

Many of the online documentation tools allow exporting of diagrams  in various formats including a "live embed" such as the one below. This was created with Lucid Chart ( https://lucidchart.com ). I created a draft of this Deployment Chart and then chose the "embed" option which created HTML for a div and an iframe. After copying and pasting that code into this entry, the chart updates automatically each time that the page loads. Using this approach, I was able to also include this into Confluence in a section called Key Diagrams. We'll discuss the specifics of the diagram in a later post but the immediate point is the live updating of diagram in the key locations to allow accurate and timely information to be communicated.
Labels:

Comments

Post a Comment

Popular posts from this blog

Creating Stories and Tasks in Jira: Personas and our Software Development Team

Part of the CI/CD Development Series The next step is developing who is on our hypothetical development team. Given that it has a React front end and ColdFusion as the Server Side language, I came up with the following personas, all of which have their own needs and considerations for our development environment. I've listed all the jobs that need doing, not the people involved since, even on a small team or a team of one, these "hats" are all worn by someone, even if it's the same person. Personas for our Project Dev Ops Coordinator - The person responsible for smooth and accurate deployments CF Developer - The person responsible for the API and fulfillment code development and maintenance. React Developer - The person responsible for the front end development Database Coordinator - The person responsible for the schema, data, up time and, presumably the testing databases used by the developers. Lead Developer - The person responsible for coordinat...
6 comments
Read more

As the Dev Ops Manager, I need to start planning our CI/CD release process

Part of the CI/CD Development Series Once we have our Deployment Diagram designed, we need to figure out out to get from here to there. If the end point is the appropriate server environment, the starting point is the developer with his/her hand on the keyboard. These steps take place on a variety of machines, within various process and can changes based on what files are checked in or not. At the moment, we've only created the early basics as seen below. The Beginning of our Deployment Activity Chart Even though there is quite a long way to go there are some elements which we have already been determined. For example We have determined the broad strokes of our technology stack. This is going to be React on the front end and ColdFusion on the server side. We have determined that we are going to be using linting on both the CF and React paths. CFLint for the CF and ESLint for the Javascript We have determined that we are going to be formatters - CFFormat for CF and...
Post a Comment
Read more

As the Dev Ops Coordinator, I need to set up our git repo into several branches with the appropriate permissions for each one

Part of the CI/CD Development Series The core of every CI/CD process is the code repository whether it be Git, Mercurial, SVN or whatever. The general idea is that it allows multiple developers (or whomever) to access your code in the appropriate way in the appropriate level. This can either be the ability for anyone to pull an open source project but not write to the repo directly or full access to a developer on your team to create branches, push to master or anything that needs doing. For our project, we're using git although the hosting provider was up for discussion between Github, Bitbucket by Atlassian or CodeCommit on AWS. We decided to go with AWS for two reasons. 1. We are going use other tools in AWS as part of the build so we decided to keep it all together. 2. We needed to solidify the ins and outs of using IAM for the process. Basic Steps Create the Repo Create the branches we need Use IAM to apply the appropriate permissions to each branch and to set up ...
1 comment
Read more