SerAws - 0.0.0

-
I've delayed writing on SerAws until I had a minimum set of functionality that could be considered useful, and a level of code infrastructure withing the addin on which I could build upon.

I'm denominating this version as 0.0.0 in order to start somewhere.  I don't want to spend too much time on versioning schemes; hence settling on a standard Major.Minor.Patch scheme.  I will probably increase the minor version number if and when SerAws is first used in a commercial setting.  I will probably increase the major version number when it reaches nominal sentience.

In terms of available functionality, SerAws currently has at this moment, the following.
  • CloudFormation MDG, with elements for S3::Buckets
  • The MDG is loaded as part of the SerAws addin.  That is, it doesn't have to be manually loaded.
  • A "Set Profile" form to set the AWS security credentials to use in order to connect to an AWS account.
  • An "About" form, which is a straight plagiarisation of the Sparx Systems Addin TaggedCSV example (zip) example.
  • An "Import" feature that connects to an AWS account and imports AWS elements into EA.
    • At the moment it just creates corresponding class elements with the name set to the entity id withing AWS.
    • No links between entities are created yet.
    • Entities covered are VPCs, Subnets, Route Tables, Security Groups, Internet Gateways, Network ACLs and RDS DB Instances.
The 3rd party libraries used by the addin include the following.
I wont describe the internal structure of the addin as there is the odd bob class thrown in the mix at the moment.  I will do a detail description of the internals for the next version.

The following is what I currently have sketched out for the next two versions.
  • Version 0.0.1 - This will just be a reorganisation of the code base to remove or refactor the placeholder or debug code that got written as I proved out different aspects of the addin.
  • Version 0.0.2 - The aim with this version is to start fleshing out a sort of end-to-end round-tripping functionality, along the following lines.
    • An import functionality .  As described for version 0.0.0 (above), but with enough detail to enable model transformation to the equivalent CloudFormation model.
    • A profile/MDG to cover reflect the imported AWS entities.
    • A profile/MDG to create CloudFormation json constructs.  The scope of this will follow that in the AWS entities MDG.
    • A model transformation between the imported AWS Import profile and the CloudFormation MDG.
    • An export feature which will take a diagram with CloudFormation elements for which it will create a corresponding CloudFormation file to be used with AWS.
The Version 0.0.2 functionality, describes a minimum slice of functionality for the addin.  Once we have this vertical slice of functionality, what we'll need to do is increase the scope of AWS elements to be modelled in EA.  An initial low bar for version 0.0.2 will be to be able to "round-trip" a VPC element.

[Originally posted here.]

Comments

Post a Comment

Popular posts from this blog

Creating Items in Sparx EA via Java

-
Introduction This short post provides guidance on how to create "things" in a Sparx EA model via the Java API. Theory Creating "things" in EA via Java is driven by the Add New method and the Collection class. The first example in the code is adding a "view" to an existing root node. The code below will retrieve the root GUID if the "i" variable is set to 0; rootPackageID = rep . GetModels (). GetAt ( i ). GetPackageGUID (); After obtaining the root GUID it is possible to create a view under the root node. Note the process of retrieving the packages under the root and placing them in a collection. The Add New process is driven from the Collection. Importantly, for a view, the code needs to set a flag which indicates a particular icon. This process is only required for views. org . sparx . Package root = rep . GetPackageByGuid ( rootPackageID ); // get the root Collection < org . sparx . Package > subPackages = r
Read more

Module Management - Part 1 - getModule() Pattern

-
As discussed in  Module Management - Analysis , EA does not provide support for the ubiquitous Module Pattern .  This becomes an issue with an increase in complexity of model addins.  In order to a) Minimise the management of dependencies, and b) Cater for the use of 3rd party modules, The  framework  provides an analogous pattern, which I'm calling the getModule() pattern, because I lack imagination. The premise is straight forward.  Rather than having an anonymous self executing function returning a module object, we instead have module class elements which have a method called "getModule()"  and this returns a module object when the method is called. The getModule() method would be declared (via the EA interface) on a class element, and then we would place all of the module's code in the body of the getModule() method/operation.  The method would return a module object to the caller. The sample contents of a typical getModule() operation might look like this.
Read more

Traversing a EA Model via Java

-
Traversing an Enterprise Architect model from Sparx Systems is relatively simple. This blog introduces the concept of model traversal via the Java API. For information on Java Set-Up see this blog entry . The first step is to obtain the repository object as it provides the anchor from which all other operations are derived. In the example below, a repository is held on the file system. The variable "repoLocation" holds the file system location of the "eap" file.   rep = new Repository();  // get a repository   rep.OpenFile(repoLocation);  //open the repository file At the top of a model is a root node and it is typically where you want to start when traversing a model. From the root node you can then obtain a collection of packages. At this point, it is easy to traverse the collection pulling in the packages via a loop and in this example printing out their names. To see the complete example, go to GitHub .   org.sparx.Package myMode
Read more