PE-7997 : fix condition added for config.yaml (#532)

Updated README

Author: akhilesh2410

Earthfile

@@ -948,7 +948,7 @@ cloud-image:
     WORKDIR /workdir
 
     # Create a default config.yaml if it doesn't exist. This is needed to avoid auroraboot from creating its own default cloud-config.
-    RUN [ ! -f /config.yaml ] && echo "#cloud-config" > /config.yaml
+    RUN if [ ! -f /config.yaml ]; then echo "#cloud-config" > /config.yaml; fi
     WITH DOCKER \
         --pull $AURORABOOT_IMAGE \
         --load index.docker.io/library/palette-installer-image:latest=(+iso-image --IS_CLOUD_IMAGE=true)

README.md

@@ -268,29 +268,99 @@ To build just the installer image
 ./earthly.sh +iso --ARCH=amd64
 ```
 
-To build public cloud images(currently only aws is supported)
-aws cloud credentials should be passed in the `.secret` file on the repo dir
-example:
-```shell
-/workspace/spectrocloud/CanvOS$ cat .secret
-AWS_PROFILE=""
-AWS_ACCESS_KEY_ID="xxxxxx"
-AWS_SECRET_ACCESS_KEY="xxxxxxx"
-```
-Also region and bucket details need to be passed in .arg file
-```shell
-#aws cloud
-REGION="us-east-1"
-S3_BUCKET="test-bkp"
-S3_KEY=""
-```
-user-data should be kept under `cloud-images/config/user-data.yaml`
+### Building AWS Cloud Images
+
+CanvOS can build Amazon Machine Images (AMIs) for AWS EC2 deployment. The build process converts the raw disk image into an AMI that can be launched directly in AWS.
+
+#### Prerequisites
+
+1. **AWS Credentials**: Configure AWS credentials in the `.secret` file in the repo directory.
+
+   **Option 1: Using AWS Profile (Recommended)**
+   ```shell
+   AWS_PROFILE="production"
+   ```
+
+   **Option 2: Using Access Keys**
+   ```shell
+   AWS_PROFILE=""
+   AWS_ACCESS_KEY_ID="ACCESS_EXAMPLE_KEY"
+   AWS_SECRET_ACCESS_KEY="SECRET_EXAMPLE_KEY"
+   ```
+
+2. **AWS Configuration**: Add the following to your `.arg` file:
+   ```shell
+   # AWS Cloud Image Configuration
+   REGION="us-east-1"
+   S3_BUCKET="my-canvos-images"
+   S3_KEY=""  # Optional: defaults to raw file name if not set
+   ```
+
+3. **User Data Configuration**: Create or update `user-data` in the CanvOS root directory with your cloud-init configuration:
+   ```yaml
+   #cloud-config
+   install:
+     device: /dev/sda
+     reboot: true
+     poweroff: false
+   stylus:
+     debug: true
+     site:
+       paletteEndpoint: xxxx.spectrocloud.com
+       autoRegister: true
+       edgeHostToken: xxxxxxxxxxx
+       insecureSkipVerify: false
+   ```
+
+#### Building the AWS Cloud Image
+
+Run the following command to build the AWS cloud image:
 
-To build AWS cloud image:
 ```shell
-./earthly.sh -P +aws-cloud-image --ARCH=amd64
+earthly -P +aws-cloud-image --ARCH=amd64
 ```
 
+The `-P` flag enables privileged mode (required for Docker-in-Docker operations).
+
+#### Build Process
+
+The AWS cloud image build consists of two steps:
+
+1. **Step 1**: Builds the cloud image (raw disk image) using auroraboot
+   - Creates a raw disk image from the installer image
+   - Includes user-data configuration
+   - Supports content bundles and cluster configs
+
+2. **Step 2**: Converts raw image to AMI
+   - Uploads raw image to S3 bucket
+   - Imports snapshot from S3
+   - Registers AMI in EC2
+   - Returns AMI ID upon completion
+
+#### Output
+
+After a successful build, the AMI will be registered in your AWS account. The build output will display:
+- AMI ID (e.g., `ami-0123456789abcdef0`)
+- AMI Name (based on `S3_KEY` or auto-generated)
+- Snapshot ID (created during import)
+
+#### IAM Permissions Required
+
+The AWS credentials must have the following permissions:
+- `s3:PutObject`, `s3:GetObject`, `s3:ListBucket` on the S3 bucket
+- `ec2:ImportSnapshot`, `ec2:DescribeImportSnapshotTasks`
+- `ec2:DescribeSnapshots`, `ec2:RegisterImage`
+- `ec2:DescribeImages`, `ec2:CreateTags`
+
+#### Troubleshooting
+
+- **"RAW file not found"**: Ensure `+cloud-image` target completed successfully
+- **"Missing required configuration variables"**: Verify `REGION` and `S3_BUCKET` are set in `.arg` file
+- **"AWS credentials not found"**: Check `.secret` file has valid AWS credentials
+- **"Snapshot import failed"**: Verify IAM permissions and S3 bucket accessibility
+
+For more detailed information, see [AWS Cloud Image Design Document](docs/aws-cloud-image-design.md).
+
 To build the provider images
 
 ```shell

docs/aws-cloud-image-design.md

@@ -174,7 +174,7 @@ AWS_SECRET_ACCESS_KEY=<secret-key>
 
 #### Dependencies
 - `+cloud-image` target must be executed first (provides raw image)
-- `cloud-images/config/user-data.yaml` must exist (used by cloud-image)
+- `user-data` must exist in the CanvOS root directory (used by cloud-image)
 
 ### 4.2 Outputs
 
@@ -223,7 +223,7 @@ AWS_SECRET_ACCESS_KEY="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"
 
 ### 5.3 user-data.yaml Configuration
 
-Located at: `cloud-images/config/user-data.yaml`
+Located at: `user-data` (in the CanvOS root directory)
 
 ```yaml
 #cloud-config
@@ -378,7 +378,7 @@ The AWS credentials must have the following permissions:
 
 ```bash
 # Build AWS cloud image
-./earthly.sh -P +aws-cloud-image \
+earthly -P +aws-cloud-image \
   --REGION=us-east-1 \
   --S3_BUCKET=my-canvos-images \
   --S3_KEY=canvos-image.raw \
@@ -393,7 +393,7 @@ cat > .secret <<EOF
 AWS_PROFILE=production
 EOF
 
-./earthly.sh -P +aws-cloud-image \
+earthly -P +aws-cloud-image \
   --REGION=us-east-1 \
   --S3_BUCKET=my-canvos-images \
   --ARCH=amd64
@@ -408,7 +408,7 @@ AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
 AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
 EOF
 
-./earthly.sh -P +aws-cloud-image \
+earthly -P +aws-cloud-image \
   --REGION=us-east-1 \
   --S3_BUCKET=my-canvos-images \
   --ARCH=amd64
@@ -418,13 +418,13 @@ EOF
 
 ```bash
 # Step 1: Build installer image
-./earthly.sh +iso-image --ARCH=amd64
+earthly +iso-image --ARCH=amd64
 
 # Step 2: Build cloud image (creates raw file)
-./earthly.sh +cloud-image --ARCH=amd64
+earthly +cloud-image --ARCH=amd64
 
 # Step 3: Convert to AMI
-./earthly.sh -P +aws-cloud-image \
+earthly -P +aws-cloud-image \
   --REGION=us-east-1 \
   --S3_BUCKET=my-canvos-images \
   --ARCH=amd64
@@ -526,7 +526,7 @@ EOF
 **Cause**: `+cloud-image` target didn't produce a raw file
 **Solution**: 
 - Verify `+cloud-image` target completed successfully
-- Check that `cloud-images/config/user-data.yaml` exists
+- Check that `user-data` exists in the CanvOS root directory
 - Review auroraboot logs in build output
 
 #### Issue: "Missing required configuration variables"
@@ -604,7 +604,7 @@ Enable debug output by checking:
 
 - `Earthfile`: Main build definition
 - `cloud-images/scripts/create-raw-to-ami.sh`: Conversion script
-- `cloud-images/config/user-data.yaml`: Cloud-init configuration
+- `user-data`: Cloud-init configuration (in the CanvOS root directory)
 - `.arg.template`: Argument template file
 - `README.md`: Project documentation