Skip to content

An Example Workflow

Keanelek Enns edited this page Apr 15, 2022 · 9 revisions

Curious about using the DevXP Platform? This page should give you a good idea of how to get started. For more detailed information on how to configure settings in DevXP's tool manager, please visit the Tool Manager Configuration page of the wiki.

If you are tired of reading and would rather see the tool in action, take a look at this demo video. Otherwise, read on!

Meet Dave

I would like you to meet Dave (you can find Dave's persona document here). Dave has been tasked with building his team's Terraform configuration so they can migrate their cloud infrastructure workflow.

Dave's requirements are:

  • 4 EC2 medium instances running Linux
  • Two S3 buckets
  • One DynamoDB Database with a userID key
  • All resources inside a VPC and able to communicate with one another

All of this can be accomplished in minutes using DevXP, but first, Dave just wants to get something working before committing to using DevXP for the rest of his requirements...

If you want to follow along with Dave, there are a few prerequisites you will need to take care of first.

First, Dave will sign in to DevXP via GitHub OAuth to authenticate the app to communicate with his repositories. (Click to close screenshots)
landingPage oauth

DevXP only uses these privileges to display your repos, and create a temporary branch in the repositories you choose to submit changes to when using DevXP.

The previous step will bring Dave to the Tool Manager page, where he can select the tool he would like to configure.
ToolManager
Right now, DevXP only supports Terraform, but we plan to add more tools (reach out to us if you have a suggestion).

Thankfully, that is what Dave is here for, so he clicks on the Terraform tool card.

Dave can then create and configure different options he needs for his infrastructure.
1. He begins by selecting a repository to configure.
  1. He then chooses his provider, in this case AWS (Amazon).

  2. Finally, he can select the big plus button to add a new resource.


terraformManager
Dave is then presented with a list of AWS resources and some information about them.
So he clicks on the "Virtual Machine" option, which he sees will create an EC2 instance.

ResourceList

Dave is given the choice to customize his resource or create a quick start version with default values. Dave decides to test out the quick start button, because Dave is just that kind of guy.

quickstart

After successfully creating a resource, Dave sees a new resource card appear in the Terraform Manager page.
newResourceCard

Dave decides he would actually like to configure the VM a bit more rather than using the default values, so he clicks on the resource card and is presented with a configuration menu where he can make the necessary modifications. In particular, he would like to have 4 EC2 instances, so he adjusts the number of instances accordingly.

configurationMenu


After saving the changes, Dave sees 4 resource cards! Pretty cool eh?


multipleInstances

Dave is a curious guy, and he notices a small arrow on the right side of the page.
livePreviewArrow

Naturally, he clicks it...


livePreview


Woah, a live preview of the Terraform configuration file! This is what will be committed to a temporary branch on Dave's repository.

Though he doesn't have all his resources configured, Dave just wants to make sure DevXP can create something that will work for him, so he decides it's time to create a pull request with his configuration details.
createPR

Dave clicks the button and waits for the changes to be pushed to his repository...


image

HURRAY! Dave did it, we knew he could. And look at that, DevXP even gives him his next couple steps to get those servers up and running.

Dave wishes everything could be this easy. 😄 🥳 🚀 😎

Now you are probably tired of hearing about all the fun Dave is having with DevXP, so why don't you leave this page and start using it yourself! Find the tool here. Have fun!

Clone this wiki locally