From 2690a0945585900a984ec03fcf9673c326ee66b0 Mon Sep 17 00:00:00 2001 From: Mike Heald Date: Wed, 25 Jun 2014 09:04:26 +0100 Subject: [PATCH] Converted documentation in md format to rst Change-Id: I88c642a24fb032b6e0920c8ba378127f8e12116c Closes-Bug: 1332741 --- README.md => README.rst | 5 ++- coreos/README.md | 67 ---------------------------------- coreos/README.rst | 81 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 84 insertions(+), 69 deletions(-) rename README.md => README.rst (65%) delete mode 100644 coreos/README.md create mode 100644 coreos/README.rst diff --git a/README.md b/README.rst similarity index 65% rename from README.md rename to README.rst index 7aa6cf3..449fd48 100644 --- a/README.md +++ b/README.rst @@ -1,4 +1,5 @@ ironic-python-agent images -================== +========================== -coreos - Builds a CoreOS Ramdisk and Kernel suitable for running ironic-python-agent +coreos - Builds a CoreOS Ramdisk and Kernel suitable for running +ironic-python-agent diff --git a/coreos/README.md b/coreos/README.md deleted file mode 100644 index 9434f80..0000000 --- a/coreos/README.md +++ /dev/null @@ -1,67 +0,0 @@ -# ironic-python-agent CoreOS Image builder. - -Builds a CoreOS image suitable for running the ironic-python-agent on a server. - -# Requirements - -Must be run from a linux machine with a working docker installation and python-pip - -Run the following locally or from a virtualenv to install the python requirements -``` -pip install -r requirements.txt -``` - -# Booting the agent with this image - -To boot the image, it should be booted via PXE. Here's an example ipxe -configuration (replace my-web-server with the IP/hostname of the http server -hosting your image): - -``` -#!ipxe - -dhcp -kernel http://my-web-server/coreos_production_pxe.vmlinuz -initrd http://my-web-server/coreos_production_pxe_image-oem.cpio.gz -boot -``` - -You can either embed a configuration file into the image, or set configuration -options via the kernel command line. The only value most people will need is: - - - `ipa-api-url=http://ironic-api-server:6385` - -But any config value supported in the agent can be given to the agent via the -kernel command line, which allows the use of the same agent image across -environments because it contains no state. - -# Getting the agent - -## Download - -If you don't want to build your own image, you can download a copy of -ironic-python-agent, embedded into a CoreOS pxe image, at - - -## Build instructions - -To create a docker repository and embed it into a CoreOS pxe image: -``` -make -``` - -To just create the docker repository in oem/container.tar.gz: -``` -make docker -``` - -To embed the oem/ directory into a CoreOS pxe image: - -Note: In order to have the ability to ssh into the created image, you need to -pass ssh keys in via the kernel command line for CoreOS, or create -oem/authorized_keys with the keys you need added before building the image. -``` -make coreos -``` - - diff --git a/coreos/README.rst b/coreos/README.rst new file mode 100644 index 0000000..9b7f507 --- /dev/null +++ b/coreos/README.rst @@ -0,0 +1,81 @@ +ironic-python-agent CoreOS Image builder. +========================================= + +Builds a CoreOS image suitable for running the ironic-python-agent on a +server. + +Requirements +============ + +Must be run from a linux machine with a working docker installation and +python-pip + +Run the following locally or from a virtualenv to install the python +requirements + +:: + + pip install -r requirements.txt + +Booting the agent with this image +================================= + +To boot the image, it should be booted via PXE. Here's an example ipxe +configuration (replace my-web-server with the IP/hostname of the http +server hosting your image): + +:: + + #!ipxe + + dhcp + kernel http://my-web-server/coreos_production_pxe.vmlinuz + initrd http://my-web-server/coreos_production_pxe_image-oem.cpio.gz + boot + +You can either embed a configuration file into the image, or set +configuration options via the kernel command line. The only value most +people will need is: + +- ``ipa-api-url=http://ironic-api-server:6385`` + +But any config value supported in the agent can be given to the agent +via the kernel command line, which allows the use of the same agent +image across environments because it contains no state. + +Getting the agent +================= + +Download +-------- + +If you don't want to build your own image, you can download a copy of +ironic-python-agent, embedded into a CoreOS pxe image, at +http://tarballs.openstack.org/ironic-python-agent/coreos/ipa-coreos.tar.gz + +Build instructions +------------------ + +To create a docker repository and embed it into a CoreOS pxe image: + +:: + + make + +To just create the docker repository in oem/container.tar.gz: + +:: + + make docker + +To embed the oem/ directory into a CoreOS pxe image: + +Note: In order to have the ability to ssh into the created image, you +need to pass ssh keys in via the kernel command line for CoreOS, or +create oem/authorized\_keys with the keys you need added before building +the image. + +:: + + make coreos +