Sha256: 7ee3ea3b205d6a52b87ce3e5393bb86ab832a125cc387e5633f7d1dc300f27fc

Contents?: true

Size: 1.58 KB

Versions: 3

Compression:

Stored size: 1.58 KB

Contents

---
title: Structure
---

Ufo creates a ufo folder within your project which contains the required files used by for ufo to build and deploy docker images to ECS.  The standard directory structure of the ufo folder looks like this:

```sh
ufo
├── output
├── settings.yml
├── task_definitions.rb
└── templates
    └── main.json.erb
```

The table below covers the purpose of each folder and file.

File / Directory  | Description
------------- | -------------
<code>output/</code>  | The folder where the generated task definitions are written to.  The way the task definitions are generated are covered in [ufo tasks build]({% link _docs/tutorial-ufo-tasks-build.md %}).
<code>settings.yml</code>  | Ufo's settings file, where you and adjust the default settings.
<code>task_definitions.rb</code>  | This where you define the task definitions and specify the variables to be used for the ERB templates.
<code>templates/</code>  | The ERB templates with the task definition json code.  The template are covered in more detail in [ufo tasks build]({% link _docs/tutorial-ufo-tasks-build.md %}).
<code>templates/main.json.erb</code>  | This is the main and starter template task definition json file that ufo initially generates.

Now that you know where the ufo configurations are located and what they look like.  Let use ufo!

<a id="prev" class="btn btn-basic" href="{% link _docs/install.md %}">Back</a>
<a id="next" class="btn btn-primary" href="{% link _docs/tutorial.md %}">Next Step</a>
<p class="keyboard-tip">Pro tip: Use the <- and -> arrow keys to move back and forward.</p>

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
ufo-1.6.2 docs/_docs/structure.md
ufo-1.6.1 docs/_docs/structure.md
ufo-1.6.0 docs/_docs/structure.md