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

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 application. He decides to start with their current AWS configuration and to move from there: (Note: instance names must only contain lower-case letters.) image image image image
The resulting configurations populate the screen and can be tweaked or removed individually. image
Finally, Dave is happy with the configuration and commits the Terraform configuration file to his repository. * Ensure any open instance configurations are either added or deleted. image image image

Pull Request

Upon submitting the Terraform configuration to his GitHub Repository, Dave can navigate to this repository to finalize the Pull Request and merge the changes into his working branch. He can then fetch the file via Git and run the Terraform file to spin up his desired cloud services.

Pull Request * Navigate to the opened Pull Request in your chosen repository. image image
  • Typically, there will be no merge conflicts and the file can be merged automatically. Otherwise, Dave should follow normal protocol for merging with his main branch.
image image
TODO: Running Terraform file to spin up Cloud services

TODO: Troubleshooting

Clone this wiki locally