Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify markdown formatting and file name #425

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions README.markdown → README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,23 @@
#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...
* Image Factory supports "build and upload" or snapshotting of existing images.
* 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
<template>
<name>f21</name>
<os>
Expand All @@ -29,29 +30,34 @@ a specific cloud.
<rootpw>p@55word!</rootpw>
</os>
</template>
```

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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not valid bash code with the prompt $ included, IMHO it would be nicer to remove the prompt. Everyone who understands what it should mean can probably also deduct this from sudo being used.

```

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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same issue with the prompt as above.

```

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).