From 972d274af92bd26b4520af04a43378f2ec12061d Mon Sep 17 00:00:00 2001 From: Fred Rolland Date: Tue, 16 Jun 2020 12:06:35 +0300 Subject: [PATCH] README improvements --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6754408..7bca8f5 100644 --- a/README.md +++ b/README.md @@ -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 ```