From ea1d54204af04ec9292c1a3f81bd54d34d114796 Mon Sep 17 00:00:00 2001 From: Taylor Ainsworth <31787196+F1uxCapacitor@users.noreply.github.com> Date: Wed, 29 May 2019 10:53:29 -0500 Subject: [PATCH] Modify markdown formatting and file name Changed file name to a more standard file extension for markdown README files Edited section header formatting Created code blocks --- README.markdown => README.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) rename README.markdown => README.md (94%) diff --git a/README.markdown b/README.md similarity index 94% rename from README.markdown rename to README.md index 3eb42b84..72348ae8 100644 --- a/README.markdown +++ b/README.md @@ -1,9 +1,9 @@ -#Image Factory# +# Image Factory Image Factory enables appliance creation and deployment to multiple virtualization and Cloud providers. -##Features## +## Features * Build guest images for a growing list of operating system and cloud combinations. * Current guest OS support: Fedora 7-19, RHEL 5.x and 6.x * Current cloud support: Red Hat Enterprise Virtualization, VMware vSphere, Amazon EC2, Rackspace, OpenStack, and more... @@ -11,12 +11,13 @@ and Cloud providers. * RESTful API makes integrating Image Factory into existing workflows simple. -##Using Image Factory## +## Using Image Factory Building an image begins with a template describing what to build. See an example of such a template below. See the [schema documentation for TDL](http://imgfac.org/documentation/tdl/TDL.html) for more detail on creating a template. Note that a template is **not** tied to a specific cloud. +```xml +``` Ensure to change the element to your desired root password. Next, use the imagefactory command and specify the template to use and for which clouds to build an image. The above template example was saved to a file name f12_64.tdl. +```bash $ sudo imagefactory --template f12_64.tdl --target ec2 +``` Once the image has been built, use the imagefactory command again, this time to push the image into the cloud. +```bash $ sudo imagefactory --provider ec2-us-west-1 --credentials ec2_credentials.xml +``` That's it! You can now launch an instance of this image using the cloud provider's management console. -##Installing Image Factory## +## Installing Image Factory## Installing Image Factory is quick and easy. See the [imagefactory rpm installation](http://imgfac.org/documentation/install.html#rpm) instructions for more detail. -## Dev Setup ## +## Dev Setup If you are wanting to use Imagefactory in a dev environment, then you can run from source. Run the 'imagefactory_dev_setup.sh' script found in the scripts directory. This will setup a dev environment which allows you to run from source. Once this is complete run ./imagefactoryd --foreground to start the server. -## Documentation ## +## Documentation More documentation on how to configure, use, and develop for imagefactory can be found on the [Image Factory website](http://imgfac.org).