From f688fb707ad626ab500955c176a995b74e4f6c04 Mon Sep 17 00:00:00 2001 From: Kristal Dale Date: Wed, 20 Feb 2019 15:57:37 -0800 Subject: [PATCH] Updates per feedback from @mvincerx. Revise example section to include prereq as part of steps. Update Prereq to template standard. Signed-off-by: Kristal Dale --- .../clear-linux/guides/maintenance/ister.rst | 42 ++++++++++--------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/source/clear-linux/guides/maintenance/ister.rst b/source/clear-linux/guides/maintenance/ister.rst index db1b6938..65aa925d 100644 --- a/source/clear-linux/guides/maintenance/ister.rst +++ b/source/clear-linux/guides/maintenance/ister.rst @@ -38,38 +38,41 @@ image, for example when you want to: * Customize the bundles preinstalled in an image. * Run your own post installation script. -Prerequisites -============= - -#. |CL| installed. - -#. :command:`os-installer` bundle is installed. - -#. ister.py has sudo privilege. - -Recreate upstream image -======================= - Follow these steps to recreate an upstream image based on the image's JSON configuration file: +#. Make sure you have all prerequisites: + + * |CL| + + :ref:`bare-metal-install`. + + * :command:`os-installer` bundle + + `Install a bundle`_. + +#. Download the `ister.py tool`_ and grant it sudo privileges. + #. Download the JSON configuration file for the desired image: * `Configuration files for the current release`_ * `Previous releases`_ (only after March 2017) - For a previous release, the configuration file for the specific release is - located at - ``https://cdn.download.clearlinux.org/releases//clear/config/image/`` + For a previous release, navigate to `Previous releases`_, select the version + you want, and find the JSON configuration file under + :file:`/clear/config/image`. For example: + ``https://cdn.download.clearlinux.org/releases/15700/clear/config/image/`` -#. The JSON configuration file for the image may have an accompanying +#. Download “PostNonChroot” script (if applicable). + + The JSON configuration file for the image may have an accompanying “PostNonChroot” script that is executed at the end of the image creation - process. If it does, download the script as well and make it executable. + process. If it does, download the script and make it executable. #. Edit the JSON configuration file as needed. #. If your configuration file has an accompanying "PostNonChroot" script, change - the default path of the script to match yours. + the default path of the script to match your path. #. Generate the new image with the following command: @@ -86,4 +89,5 @@ Related topics .. _ister.py tool: https://github.com/bryteise/ister .. _image types for different environments: https://cdn.download.clearlinux.org/image/README-IMAGES.html .. _Configuration files for the current release: https://cdn.download.clearlinux.org/current/config/image/ -.. _Previous releases: https://cdn.download.clearlinux.org/releases/ \ No newline at end of file +.. _Previous releases: https://cdn.download.clearlinux.org/releases/ +.. _Install a bundle: https://clearlinux.org/documentation/clear-linux/guides/maintenance/swupd-guide#adding-a-bundle \ No newline at end of file