Improve readme for CoreOS imagebuild

This:
  - includes a link to new gate-built images
  - updates the kernel command line options (none needed in newer
    images)

Change-Id: I79e9a0ab7de1dc61dd035bebf81c87136e4c3202
This commit is contained in:
Jay Faulkner 2014-06-20 15:53:51 -07:00
parent 432c65dcbe
commit d132a50afc
1 changed files with 34 additions and 24 deletions

View File

@ -11,7 +11,40 @@ Run the following locally or from a virtualenv to install the python requirement
pip install -r requirements.txt
```
# Build Instructions
# 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. Values most people will need are:
- `ipa-api-url=http://ironic-api-server:6385`
- `ipa-advertise-host=ip-of-server-running-agent`
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:
```
@ -32,27 +65,4 @@ oem/authorized_keys with the keys you need added before building the image.
make coreos
```
# 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 root=squashfs: state=tmpfs:
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. Values most people will need are:
- `ipa-api-url=http://ironic-api-server:6385`
- `ipa-advertise-host=ip-of-server-running-agent`
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.