Converted documentation in md format to rst

Change-Id: I88c642a24fb032b6e0920c8ba378127f8e12116c
Closes-Bug: 1332741
This commit is contained in:
Mike Heald 2014-06-25 09:04:26 +01:00
parent b5cd83b13c
commit d26bb42059
5 changed files with 90 additions and 72 deletions

View File

@ -1,3 +0,0 @@
# ironic-python-agent
An agent for rebuilding and controlling Ironic nodes. To contribute, start here: [Openstack: How to contribute](https://wiki.openstack.org/wiki/How_To_Contribute).

6
README.rst Normal file
View File

@ -0,0 +1,6 @@
ironic-python-agent
===================
An agent for rebuilding and controlling Ironic nodes. To contribute,
start here: `Openstack: How to
contribute <https://wiki.openstack.org/wiki/How_To_Contribute>`__.

View File

@ -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

View File

@ -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
<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
```

View File

@ -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