This repository has been archived by the owner on Feb 20, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Prepare for initial preview release (#15)
- Loading branch information
Showing
3 changed files
with
36 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,24 @@ | ||
# duffle-coat | ||
VS Code extension for generating CNAB self-installers | ||
|
||
A Visual Studio Code extension for generating CNAB self-installers. | ||
|
||
This extension adds a `Generate Self-Installer` command to the following items: | ||
|
||
* `bundle.json` or `bundle.cnab` files | ||
* Bundles in the [Duffle extension's](https://marketplace.visualstudio.com/items?itemName=ms-kubernetes-tools.duffle-vscode) Bundles explorer | ||
|
||
The command generates an Electron application, which you can then run using `npm run dev` or package for distribution using `npm run package`. Your bundle is embedded in the application. If you choose the **Full bundle** option during generation, then all Docker images are also embedded in the application, allowing it to run entirely offline. | ||
|
||
Note that once generated, the Electron app code is entirely decoupled from your source bundle. If you make changes to the bundle, you'll need to regenerate the Electron app (you can choose just to update the bundle rather than overwriting the entire app). | ||
|
||
## Known issues | ||
|
||
The **Full bundle** generation options currently requires you to _push_ all depended-on Docker images to a network repository before running it. (It is not sufficient for them to be present only in the local regsitry.) This is a known issue with the `docker export` command. | ||
|
||
## Unknown issues | ||
|
||
I'm sure there are lots - please [report any you find](https://github.com/deislabs/duffle-coat/issues)! | ||
|
||
## Application template | ||
|
||
The application template lives in the `deislabs/duffle-bag` repo. You are welcome to clone this and use it as the basis for an installer application without using this extension. This extension just aims to make the job easier! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters