Updates for release (#3)

Author: 3pings

Dockerfile

@@ -0,0 +1,16 @@
+ARG BASE
+FROM $BASE
+
+###########################Add any other image customizations here #######################
+
+####  Examples  ####
+
+### To install the nginx package for Ubuntu  ###
+
+#RUN apt-get update && apt-get install nginx
+
+### or
+
+### To install the nginx package for opensuse ###
+
+#RUN zypper refresh && zypper install nginx

Earthfile

@@ -4,7 +4,8 @@ FROM alpine
 # Variables used in the builds.  Update for ADVANCED use cases only
 ARG OS_DISTRIBUTION
 ARG OS_VERSION
-ARG IMAGE_REPOSITORY
+ARG IMAGE_REGISTRY
+ARG IMAGE_REPOSITORY=$OS_DISTRIBUTION
 ARG K8S_DISTRIBUTION
 ARG MY_ENVIRONMENT
 ARG STYLUS_VERSION=v3.3.3
@@ -28,7 +29,7 @@ build-all-images:
     BUILD +build-iso
 
 build-provider-images:
-    BUILD +provider-image --K8S_VERSION=1.24.7
+    BUILD +provider-image --K8S_VERSION=1.24.6
     BUILD +provider-image --K8S_VERSION=1.25.2
 
 build-iso:
@@ -55,7 +56,10 @@ build-iso:
 provider-image:
     # added PROVIDER_K8S_VERSION to fix missing image in ghcr.io/kairos-io/provider-*
     ARG PROVIDER_K8S_VERSION=1.25.2
+    ARG IMAGE_REPOSITORY
     ARG K8S_VERSION
+    ARG IMAGE_TAG=$K8S_DISTRIBUTION-$K8S_VERSION-$STYLUS_VERSION
+    ARG IMAGE_PATH=$IMAGE_REGISTRY/$IMAGE_REPOSITORY-$MY_ENVIRONMENT:$IMAGE_TAG
     FROM +base-image
 
     IF [ "$K8S_DISTRIBUTION" = "kubeadm" ]
@@ -75,7 +79,8 @@ provider-image:
     RUN touch /etc/machine-id \
         && chmod 444 /etc/machine-id
 
-    SAVE IMAGE --push $IMAGE_REPOSITORY/$OS_DISTRIBUTION-$MY_ENVIRONMENT:$K8S_DISTRIBUTION-v$K8S_VERSION-$STYLUS_VERSION
+    
+    SAVE IMAGE --push $IMAGE_PATH
 
 elemental:
     FROM $OSBUILDER_IMAGE
@@ -126,7 +131,7 @@ base-image:
         ENV OS_ID=$OS_DISTRIBUTION
         ENV OS_VERSION=$OS_VERSION.04
         ENV OS_NAME=core-$OS_DISTRIBUTION-$OS_VERSION-lts-$K8S_DISTRIBUTION_TAG:$STYLUS_VERSION
-        ENV OS_REPO=$IMAGE_REPOSITORY
+        ENV OS_REPO=$IMAGE_REGISTRY
         ENV OS_LABEL=$KAIROS_VERSION_$K8S_VERSION_$SPECTRO_VERSION
         RUN envsubst >/etc/os-release </usr/lib/os-release.tmpl
         RUN apt update \
@@ -151,7 +156,7 @@ base-image:
         ENV OS_ID=$OS_DISTRIBUTION
         ENV OS_VERSION=15.4
         ENV OS_NAME=core-$OS_DISTRIBUTION-$K8S_DISTRIBUTION_TAG:$STYLUS_VERSION
-        ENV OS_REPO=$IMAGE_REPOSITORY
+        ENV OS_REPO=$IMAGE_REGISTRY
         ENV OS_LABEL=$KAIROS_VERSION_$K8S_VERSION_$SPECTRO_VERSION
         RUN envsubst >/etc/os-release </usr/lib/os-release.tmpl
         RUN zypper refresh \

README.md

@@ -12,11 +12,51 @@ The base image definitions reside in the Earthfile located in this repo.  This d
     <br>
 <br>
 
-## Knowledgebase
+## Image Build Architecture
+
+### Base Image
+
+From the Kairos project, this is derived from the operating system distribution chosen (currently Ubuntu and OpenSuse-Leap supported).  It is pulled down as the base image and some adjustments are made to better support Palette.  Those adjustments are used to clean and update the image as well as install some required packages.
+
+### Provider Image
+
+From the Base Image, the provider image is used to package in the Kubernetes distribution and version(s) that are part of the build.  This layer is required to initialize the system and prepare it for configuration to build the Kubernetes cluster.
+
+### Installer Image
+
+From the base image, this image is used to provide the initial flashing of a device (bare-metal or virtual machine).  This image contains the user-data configuration that has been provided in `user-data`.  It will also contain the contents of any content bundle for pre-staged builds.  Pre-staged builds can be used to embed all of the artifacts that are required to build a cluster.  These artifacts include Helm charts, manifests, and container images.  These images are loaded into containerd when the cluster is initialized elminating the need for the initial download.  For more information on how to build pre-loaded content checkout the Palette Docs at [Build your Own Content](https://docs.spectrocloud.com/clusters/edge/edgeforge-workflow/build-content-bundle).  
+
+### Custom Configuration
+
+For advanced use cases, there may be a need to add additional packages not included in the [Base Images](https://github.com/kairos-io/kairos/tree/master/images).  If those packages or configuration elements need to be added, they can be included in the empty `Dockerfile` located in this repo and they will be included in the build process and output artifacts.
+
+### Basic Usage
+
+1. Clone this repo
+```shell
+[email protected]:spectrocloud/CanvOS.git
+```
+
+2. Checkout the version you want.
+```shell
+git checkout <tag>
+```
+
+3. Modify the `.arg` file as needed
+
+4. Build the images
+```shell
+./earthly.sh +build-all-images
+```
+
+5. Rename images if needed and push to your registry
+
+6. Flash VM or Baremetal device with the generated ISO.
+
+7. Build clusters in [Palette](https://console.spectrocloud.com)
 
 ### How-Tos
 
 * [Building Edge Native Artifacts](https://docs.spectrocloud.com/knowledgebase/how-to/edge-native/edgeforge)
 
 ### Tutorials
-

user-data.template

@@ -8,8 +8,8 @@ stylus:
     edgeHostToken: aUAxxxxxxxxx0ChYCrO
 
     # projectUid <Optional :need to provide if token is not generated using project id>
-    projectUid: 12345677788
-    # tags which will be assigned to devices as labels
+    projectName: stores
+    # tags which will be assigned to devices as labels.  These are examples
     tags:
       key1: value1
       key2: value2