Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README file #19

Merged
merged 1 commit into from
Sep 27, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This repository contains source code for the following container images.

## iPXE builder image

This repository provides the ability to build an OCI container that:
This directory provides the ability to build an OCI container that:

- Provides customizable custom IPXE firmware building functionality.

Expand Down Expand Up @@ -60,3 +60,17 @@ functionality:
- `IPXE_CHAIN_HOST` this ip will be used to start chainloading by a TLS enabled
iPXE firmware, this value is used to render the embed.ipxe.j2 script template
(default: `0.0.0.0`)

## Fake Ironic Python Agent

FakeIPA is a tool to help test ironic scalability.

FakeIPA simulate the IPA by:

- Running an API server with the needed real IPA endpoint.
- Send back fake inspection data when requested.
- Lookup the node and save tokens.
- Heartbeating to Ironic API with several threads looping over
a queue of fake agents.
- Faking the sync/async commands needed by ironic to inspect,
clean and provision a node.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a "read more" link to fake-ipa/README.md for more docs.