diff options
| author | Gunnar Mills <gmills@us.ibm.com> | 2017-12-06 17:05:59 -0600 |
|---|---|---|
| committer | Gunnar Mills <gmills@us.ibm.com> | 2017-12-12 18:57:03 -0600 |
| commit | cbb67027703f39657b95f85f39485b093bf33f1c (patch) | |
| tree | 132c5bbd3ff590bd209f4020af31984fe256025d | |
| parent | f4d12d672ad6ac1e01e592acc31e973dfe35808d (diff) | |
| download | openbmc-docs-cbb67027703f39657b95f85f39485b093bf33f1c.tar.gz openbmc-docs-cbb67027703f39657b95f85f39485b093bf33f1c.zip | |
Add MANIFEST section
Define the format and what is included in the MANIFEST file.
Change-Id: Id60e7d586c8342529d294f172d143b4f1c3028d3
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
| -rw-r--r-- | code-update/ubi-code-update.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/code-update/ubi-code-update.md b/code-update/ubi-code-update.md index 925746d..5054d6a 100644 --- a/code-update/ubi-code-update.md +++ b/code-update/ubi-code-update.md @@ -242,6 +242,26 @@ curl -c cjar -b cjar -k -H "Content-Type: application/json" -X GET \ } ``` +### MANIFEST File + +A file named "MANIFEST" must be included in any image tar uploaded, downloaded +via TFTP, or copied to the BMC. + +The MANIFEST file format must be key=value (e.g. version=v1.99.10). +It should include the following fields: + +* version - The version of the image +* purpose - The image's purpose (e.g. +xyz.openbmc_project.Software.Version.VersionPurpose.BMC or +xyz.openbmc_project.Software.Version.VersionPurpose.Host). Accepted purpose +values can be found at +[Version interface](https://github.com/openbmc/phosphor-dbus-interfaces/blob/6f69ae5b33ee224358cb4c2061f4ad44c6b36d70/xyz/openbmc_project/Software/Version.interface.yaml) +under "VersionPurpose" values. + +Other optional fields are: +* extended_version - A more detailed version, which could include versions of +different components in the image. + ### Deleting an Image To delete an image: |
