Skip to content
This repository was archived by the owner on Sep 2, 2020. It is now read-only.

README improvements #3

Open
rollandf wants to merge 1 commit into
base: master
Choose a base branch
from
Open

README improvements #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
26 changes: 13 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# coreos_installation_iso

This image is a tool to create a coreOS image with a passed ignition file.
The output of the container is a ISO live CD image that will be uploaded to s3 of your choice.
This image is a tool to create a CoreOS image with a passed ignition file.
The output of the container is a ISO live CD image that will be uploaded to a S3 storage service of your choice.

Building a builder image:
* Update the COREOS IMAGE in the Docker file to the coreOS live CD ISO of you'r choice
* Build the docker image and push to you registry
* Update the `COREOS_IMAGE` in the Docker file to the CoreOS live CD ISO of your choice.
* Build the Docker image and push to your registry.

### Using the image:
the parameters are passed to the image via env vars,
to build a image the passed params are:
```
IGNITION_CONFIG : the ignition.conf file
IMAGE_NAME : the name of your choice for the image
S3_BUCKET : s3 bucket where the image will be uploaded (default: test)
S3_ENDPOINT_URL : s3 endpoint url
The parameters are passed to the image via env vars.
To build a image the passed parameters are:

aws_access_key_id
aws_secret_access_key
```
IGNITION_CONFIG : the ignition.conf file
IMAGE_NAME : the name of your choice for the image
S3_BUCKET : S3 bucket where the image will be uploaded (default: test)
S3_ENDPOINT_URL : S3 endpoint url
aws_access_key_id : S3 access key ID
aws_secret_access_key : S3 access key
```