iSharkFly-Docs
/
packer-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

website: document machine-readable types

This commit is contained in:
Mitchell Hashimoto 2013-08-12 11:33:57 -07:00
parent fd3bce0444
commit 928947f780
7 changed files with 256 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
website/source/docs/command-line/machine-readable.html.markdown
View File

@ -77,7 +77,7 @@ returns become a literal `\r`.
## Message Types
The set of machine-readable message types can be found in the
[machine-readable format](#)
[machine-readable format](/docs/machine-readable/index.html)
complete documentation section. This section contains documentation
on all the message types exposed by Packer core as well as all the
components that ship with Packer by default.

125
website/source/docs/machine-readable/command-build.html.markdown Normal file
View File

@ -0,0 +1,125 @@
---
layout: "docs_machine_readable"
page_title: "Command: build - Machine-Readable Reference"
---
# Build Command Types
These are the machine-readable types that exist as part of the output
of `packer build`.
<dl>
<dt>artifact (>= 2)</dt>
<dd>
<p>
Information about an artifact of the targetted item. This is a
fairly complex (but uniform!) machine-readable type that contains
subtypes. The subtypes are documented within this page in the
syntax of "artifact subtype: SUBTYPE". The number of arguments within
that subtype is in addition to the artifact args.
</p>
<p>
<strong>Data 1: index</strong> - The zero-based index of the
artifact being described. This goes up to "artifact-count" (see
below).
</p>
<p>
<strong>Data 2: subtype</strong> - The subtype that describes
the remaining arguments. See the documentation for the
subtype docs throughout this page.
</p>
<p>
<strong>Data 3..n: subtype data</strong> - Zero or more additional
data points related to the subtype. The exact count and meaning
of this subtypes comes from the subtype documentation.
</p>
</dd>
<dt>artifact-count (1)</dt>
<dd>
<p>
The number of artifacts associated with the given target.
</p>
<p>
<strong>Data 1: count</strong> - The number of artifacts as
a base 10 integer.
</p>
</dd>
<dt>artifact subtype: builder-id (1)</dt>
<dd>
<p>
The unique ID of the builder that created this artifact.
</p>
<p>
<strong>Data 1: id</strong> - The unique ID of the builder.
</p>
</dd>
<dt>artifact subtype: file (2)</dt>
<dd>
<p>
A single file associated with the artifact. There are 0 to
"files-count" of these entries to describe every file that is
part of the artifact.
</p>
<p>
<strong>Data 1: index</strong> - Zero-based index of the file.
This goes from 0 to "files-count" minus one.
</p>
<p>
<strong>Data 2: filename</strong> - The filename.
</p>
</dd>
<dt>artifact subtype: files-count (1)</dt>
<dd>
<p>
The number of files associated with this artifact. Not all
artifacts have files associated with it.
</p>
<p>
<strong>Data 1: count</strong> - The number of files.
</p>
</dd>
<dt>artifact subtype: id (1)</dt>
<dd>
<p>
The ID (if any) of the artifact that was built. Not all artifacts
have associated IDs. For example, AMIs built have IDs associated
with them, but VirtualBox images do not. The exact format of the ID
is specific to the builder.
</p>
<p>
<strong>Data 1: id</strong> - The ID of the artifact.
</p>
</dd>
<dt>artifact subtype: nil (0)</dt>
<dd>
<p>
If present, this means that the artifact was nil, or that the targetted
build completed successfully but no artifact was created.
</p>
</dd>
<dt>artifact subtype: string (1)</dt>
<dd>
<p>
The human-readable string description of the artifact provided by
the artifact itself.
</p>
<p>
<strong>Data 1: string</strong> - The string output for the artifact.
</p>
</dd>
</dl>

45
website/source/docs/machine-readable/command-version.html.markdown Normal file
View File

@ -0,0 +1,45 @@
---
layout: "docs_machine_readable"
page_title: "Command: version - Machine-Readable Reference"
---
# Version Command Types
These are the machine-readable types that exist as part of the output
of `packer version`.
<dl>
<dt>version (1)</dt>
<dd>
<p>The version number of Packer running.</p>
<p>
<strong>Data 1: version</strong> - The version of Packer running,
only including the major, minor, and patch versions. Example:
"0.2.4".
</p>
</dd>
<dt>version-commit (1)</dt>
<dd>
<p>The SHA1 of the Git commit that built this version of Packer.</p>
<p>
<strong>Data 1: commit SHA1</strong> - The SHA1 of the commit.
</p>
</dd>
<dt>version-prerelease (1)</dt>
<dd>
<p>
The prerelease tag (if any) for the running version of Packer. This
can be "beta", "dev", "alpha", etc. If this is empty, you can assume
it is a release version running.
</p>
<p>
<strong>Data 1: prerelease name</strong> - The name of the
prerelease tag.
</p>
</dd>
</dl>

29
website/source/docs/machine-readable/general.html.markdown Normal file
View File

@ -0,0 +1,29 @@
---
layout: "docs_machine_readable"
page_title: "General Types - Machine-Readable Reference"
---
# General Types
These are the machine-readable types that can appear in almost any
machine-readable output and are provided by Packer core itself.
<dl>
<dt>ui (2)</dt>
<dd>
<p>
Specifies the output and type of output that would've normally
gone to the console if Packer wasn't running in human-readable
mode.
</p>
<p>
<strong>Data 1: type</strong> - The type of UI message that would've
been outputted. Can be "say", "message", or "error".
</p>
<p>
<strong>Data 2: output</strong> - The UI message that would have
been outputted.
</p>
</dd>
</dl>

30
website/source/docs/machine-readable/index.html.markdown Normal file
View File

@ -0,0 +1,30 @@
---
layout: "docs_machine_readable"
page_title: "Machine-Readable Reference"
---
# Machine-Readable Reference
This is the reference for the various message categories for Packer
[machine-readable output](/docs/command-line/machine-readable.html).
Please read that page if you're unfamiliar with the general format and
usage for the machine-readable output.
The layout of this reference is split into where the types come from.
There are a set of core types that are from Packer core itself. Then
there are types that come from various components of Packer such as the
builders, provisioners, and more.
Within each section, the format of the documentation is the following:
<br>
<dl>
<dt>type-name (data-count)</dt>
<dd>
<p>Description of the type.</p>
<p>
<strong>Data 1: name</strong> - Description.
</p>
</dd>
</dl>

14
website/source/layouts/docs_machine_readable.erb Normal file
View File

@ -0,0 +1,14 @@
<% wrap_layout :inner do %>
<% content_for :sidebar do %>
<h2>Docs</h2>
<ul>
<li><h4>Machine-Readable Reference</h4></li>
<li><a href="/docs/index.html">&laquo; Back to Docs</a></li>
<li><a href="/docs/machine-readable/general.html">General Types</a></li>
<li><a href="/docs/machine-readable/command-build.html">Command: build</a></li>
<li><a href="/docs/machine-readable/command-version.html">Command: version</a></li>
</ul>
<% end %>
<%= yield %>
<% end %>

12
website/source/stylesheets/_styles.scss
View File

@ -122,6 +122,18 @@ a {
}
dt {
font-size: 18px;
}
dd {
font-family: $serif;
font-size: 17px;
line-height: 1.5;
letter-spacing: 1px;
margin-bottom: 30px;
}
ul,
ol {
margin: 0;