v3.1.2 (#50)

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

* v3.1.2

Author: brod-intel

.gitignore

@@ -34,6 +34,7 @@ data/usr/share/nginx/html/kickstart/default/dyn-ks.yml_*
 
 # Template staging files
 template/dnsmasq/dnsmasq.conf.modified*
+template/logging-server/fluent-bit.conf.modified*
 
 # Auto-generated UOS files & directories
 dockerfiles/uos/prep/

CHANGELOG.md

@@ -233,6 +233,20 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Known Problem
 - Missing instructions of how to build the boot.wim, boot.sdi and BCD from Microsoft ADK
 
+## [3.1.2] - 2023-08-21
+### Added
+- Added progress logging from ESP uOS to ESP Services
+- Added support for airgapped environments
+- Updated Ubuntu Profiles to 22.04
+- Published containers to Docker Hub and now support single step quick deployment method
+
+### Changed
+- Fixed ESP uOS Wifi detectability
+- Fixed Miscellaneous bugs
+
+### Known Problem
+- Missing instructions of how to build the boot.wim, boot.sdi and BCD from Microsoft ADK
+
 
 [1.5.1]: https://github.com/intel/Edge-Software-Provisioner/compare/v1.5...v1.5.1
 [1.6.0]: https://github.com/intel/Edge-Software-Provisioner/compare/v1.5.1...v1.6
@@ -252,3 +266,4 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 [3.0.1]: https://github.com/intel/Edge-Software-Provisioner/compare/v3.0...v3.0.1
 [3.0.2]: https://github.com/intel/Edge-Software-Provisioner/compare/v3.0.1...v3.0.2
 [3.0.5]: https://github.com/intel/Edge-Software-Provisioner/compare/v3.0.2...v3.0.5
+[3.1.2]: https://github.com/intel/Edge-Software-Provisioner/compare/v3.0.5...v3.1.2

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# How to contribute
+
+## Branching strategy
+The common approach for this repo is, that the main developent branch is *main*. This branch should always be in a good state and the code from this branch should
+always be in a state so that it could be released any time.
+Releases will be done based on tags, only when needed we will create a separate branch for the release.
+
+## Tagging
+Each tag should have the format *vMAJOR.MINOR.PATCH*, e.g. v2.5.0  
+If we create a release branch, then the branch name must not be equal to the tag name. Instead, we call the branch *vMAJOR.MINOR*, e.g. v2.5
+On a release branch we will only do urgent bug fixes. These fixes must then be ported back to main development branch.
+
+## Development branches
+Each developer should create a separate development branch (based on latest main) and give it a meaningful name like feature/FEATURE_NAME, e.g feature/add_network
+Development branches should be deleted after they are merged to the main branch.
+
+## Merging to main
+For merging the development branches to main we use pull requests.
+The development branches might need a rebase on the main branch, this is highlighted on the pull request overview.

README.md

@@ -2,7 +2,7 @@
 
 ## Quick Start Guide
 
-To quickly get started follow the [Quick Installation Guide](#quick-installation-guide)
+To quickly get started follow the [Quick Deployment Guide](#quick-deployment-guide)
 
 ## Table of Contents
 
@@ -18,9 +18,11 @@ To quickly get started follow the [Quick Installation Guide](#quick-installation
 
 1. [Setting up your Network](#network-setup)
 
+1. [Quick Deployment Guide](#quick-deployment-guide)
+
 1. [Quick Installation Guide](#quick-installation-guide)
 
-1. [Installing the Edge Software Provisioner (ESP)](#installing-esp)
+1. [Configuring the Edge Software Provisioner (ESP)](#installing-esp)
 
 1. [Upgrading the Edge Software Provisioner (ESP)](#upgrading-esp)
 
@@ -68,7 +70,9 @@ The main executable to setup a device as a Edge Software Provisioner is `build.s
 
   - **Gitea** - optional, used for mirroring git repositories
 
-[Clear Linux](https://github.com/intel/rni-profile-base-clearlinux), [Ubuntu](https://github.com/intel/rni-profile-base-ubuntu) and [RancherOS](https://github.com/intel/rni-profile-base-rancheros) are provided as example profiles.
+  - **Fluent Bit** - optional, used for logging profile progress
+
+[Clear Linux](https://github.com/intel/esp-profile-clearlinux) and [Ubuntu](https://github.com/intel/esp-profile-ubuntu) are provided as example profiles.
 
 ## Prerequisites
 
@@ -87,7 +91,7 @@ The following is required:
 
 The Edge Software Provisioner (ESP) must be in an isolated network and there must only be one ESP in the network.  ESP will detect if there is an existing DHCP or DNS and will configure itself accordingly.  It will also detect if the host has a static or dynamic IP IPv4 address.  If the host is a dynamic IP address and if the IP address changes you must run `./build.sh -S -P && ./run.sh --restart` to update ESP configuration with the new IP address.
 
-WARNING: DO NOT RUN ESP ON YOUR CORPORATE NETWORK. *It must be on an isoloated network.*
+WARNING: DO NOT RUN ESP ON YOUR CORPORATE NETWORK. *It must be on an isolated network.*
 
 NOTE: If using Ubuntu, do not use Snapd Docker, install Docker using aptitude.  Dnsmasq must not been running on the system from some other service.  Please confirm with `ps -auxww | grep dnsmasq`.
 
@@ -101,6 +105,15 @@ Because ESP is OS-agnostic and Docker-based, the configuration of your system's
 
 Target Devices will be connected on the same LAN as the Edge Software Provisioner. On target devices, enable PXE Boot in the BIOS if it is not enabled. Most BIOS's have a boot menu option (F12) at POST time. Typically you can press (F12) to alter the boot sequence.
 
+## Quick Deployment Guide
+
+  NOTE: Please read [Network Setup](#network-setup) above before proceeding.  If using Ubuntu, do not use Snapd Docker, install Docker using aptitude.  Dnsmasq must not been running on the system from some other service.  Please confirm with `ps -auxww | grep dnsmasq`.
+
+  1. Copy the following line to deploy Intel Edge Software Provisioner
+  ```bash
+  export ESP_VERSION=master && wget --no-check-certificate -O- https://raw.githubusercontent.com/intel/Edge-Software-Provisioner/${ESP_VERSION}/deploy.sh | bash -s -
+  ```
+
 ## Quick Installation Guide
 
   NOTE: Please read [Network Setup](#network-setup) above before proceeding.  If using Ubuntu, do not use Snapd Docker, install Docker using aptitude.  Dnsmasq must not been running on the system from some other service.  Please confirm with `ps -auxww | grep dnsmasq`.
@@ -143,7 +156,7 @@ Target Devices will be connected on the same LAN as the Edge Software Provisione
 
   **Stop rebuilding ESP for each installation! To improve installation efficiency for the next time continue on**
 
-  8. Let's re-tag docker images with your prefix to upload to your Docker Hub account.  The following example will re-tag images to look like `myDockerUser/builder-core:latest`.
+  8. Let's re-tag docker images with your prefix to upload to your Docker Hub account.  The following example will re-tag images to look like `myDockerUser/esp-core:latest`.
   ```bash
   ./build.sh --tag myDockerHubUser
   ```
@@ -165,7 +178,7 @@ Target Devices will be connected on the same LAN as the Edge Software Provisione
 
   **See [Adding and Removing Profiles](#adding-removing-profiles) to update the profile list**
 
-## Installing ESP
+## Configuring ESP
 
 Once the prerequisites and network setup have been taken care of, the steps to deployment are as follows.