This repository has been archived by the owner on Jan 19, 2018. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 70
Update file handling doc. Fixes #285 #561
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,43 @@ | ||
## Fetch | ||
|
||
Fetching an Atomic App means to download the artifacts and sample answerfile. | ||
Fetching an Atomic App means to download the metadata files: artifacts and | ||
sample answerfile for an Atomic App. By default, it downloads the metadata | ||
files for the atomicapp to a directory of the form | ||
``/var/lib/atomicapp/<atomic app name>-<uuid>``. If needed, | ||
you can also specify a target directory to download the metadata for the | ||
Atomic App using the ``--destination`` option. | ||
|
||
## Developing and Debugging | ||
|
||
Image developers may run the root container and point to a Nulecule directory on the local system. | ||
|
||
## Directories | ||
|
||
* `/tmp/<atomicapp_name>`: Host directory for temporary Nulecule files. May be overridden. | ||
* `/tmp/<atomicapp_name>/.workdir`: Host directory for artifact template files with variable substitution. | ||
* `/var/lib/atomicapp/<atomic app name>-<uuid>`: This is where an Atomic App | ||
and it's dependencies are fetched when fetching or running the Atomic App, | ||
unless, a specific destination is specified. | ||
* `/var/lib/atomicapp/<atomic app name>-<uuid>/external`: | ||
External Atomic Apps, if any, for the given Atomic App are | ||
fetched into ``external`` directory inside the directory of | ||
the Atomic App, during, fetching the Atomic App with | ||
dependencies or running the Atomic App. | ||
|
||
## Artifact path | ||
|
||
Local path to an artifact file or a directory containing artifact files as its | ||
immediate children. | ||
|
||
## Runtime answers file | ||
|
||
When running an Atomic App, it asks the users for missing values for | ||
parameters defined in the Atomic App and it's child Atomic Apps. This | ||
aggregated answers data is used to run the Atomic App, and is dumped | ||
to a file: ``answers.conf.gen`` in the Atomic App's directory, to be | ||
used later when stopping the Atomic App. | ||
|
||
## Rendered artifact files | ||
|
||
Artifact files are rendered with runtime answers data along side the original | ||
artifact files, but with the filenames prefixed with a `.` (dot), to make | ||
them hidden. | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Atomic App