VERSION

Author: aethernet

lib/dotetch/index.ts

@@ -4,18 +4,8 @@ import { ExtendedManifests, Image } from './interface-manifest';
 import { computeDockerLayers, streamDockerLayers, Layer } from './layers';
 import { AxiosBasicCredentials } from "axios";
 
-interface ManifestV1 {
-	version: "1.0",
-	baseImage?: {
-		type: "stream";
-		location: string;
-	},
-	inject?: [{
-		type: "stream";
-		location: string;
-		targetPartition: number;
-	}]
-}
+/** dotEtch version, will be sent as the first file on stream */
+const VERSION = '1.0'
 
 /**
  * Main Processing function
@@ -56,20 +46,19 @@ const promisePacker =
  * Prepare Etch Stream
  * Create the stream to be use by all other function
  * @param outputStream Writable output stream (can be a file or http response or ...) 
- * @param manifest A dotEtch manifest
  * @returns tar-stream pack writable stream
  */
-const prepareEtchStream = async (manifest: ManifestV1): Promise<Pack> => {
+const prepareEtchStream = async (): Promise<Pack> => {
 	const packStream = pack();
 
 	// stream manifest
 	const packer = promisePacker(packStream);
 	await packer(
 		{
-			name: `/manifest.json`,
+			name: `/VERSION`,
 			mode: 777,
 		},
-		JSON.stringify(manifest)
+		VERSION
 	);
 
 	console.log("==> dotEtch Stream Ready @prepareEtchStream");

lib/dotetch/readme.md

@@ -6,7 +6,7 @@ Entry is `index.ts`
 
 You're responsible for managing the lifecycle :
 
-1. call `prepareEtchStream` with a manifest, it will return a "PackStream" [which is a `pack` from tar-stream](https://github.com/mafintosh/tar-stream).
+1. call `prepareEtchStream`, it will return a "PackStream" [which is a `pack` from tar-stream](https://github.com/mafintosh/tar-stream).
 2. pipe the stream from 1. to an output `packStream.pipe(outputStream)` (output stream can be a file, a http response, ...)
 3. call `startEtchStream` with those mandatory parameters :
   - `packStream` (from previous step)
@@ -33,40 +33,8 @@ Therefore we have built an on-stream docker pull replacement which can be called
 You first need to get the manifests for all images using `getManifestsForImages`. 
 If your images are not public, you'll need to provide authentication, either a bearer token or a `{username: string, password: string}` basic auth object to retrieve your manifests and images.
 
-## Manifest 
-The dotEtch manifest which describe the stream content.
-
-So far we only have one version which is a json and looks like this: 
-```json
-{
-	"version": "1.0",
-	"baseImage": {
-		"type": "stream",
-		"location": _string_
-	},
-	"inject": [{
-		"type": "stream",
-		"location": _string_,
-    "targetPartition": _number_,
-	}]
-}
-```
-
-Where :
-- `type` currently only support stream (which means the data will be part of the same dotetch stream); next version should support "url" to fetch remote data.
-- `location` is a string that indicate where (relative to the stream) the package is locate. I.E. : 
-- `targetPartition` is the number of the partition the injectable files should go
-
-```
-	"version": "1.0",
-	"baseImage": {
-		"type": "stream",
-		"location": "/balenaos.img"
-	}
-	"inject": [{
-		"type": "stream",
-		"location": "/inject/6",
-    "targetPartition": 6
-	}]
-```
+## VERSION
+First file pushed on the stream is `VERSION`. It contains a single string in the format `major:minor` (i.e. `1.0`).
+It indicate to consumer what feature will be supported.
 
+Minors should be compatible and majors indicates breaking changes.