Add contract partial based instruction generation #1101
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
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 |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| import { Contract } from '../types/contract'; | ||
|
|
||
| // Hardcoded host OS contract, this should be moved to the Yocto build process with meta-balena. | ||
| // Here for initial implementatin and testing purposes | ||
| const BalenaOS: Contract = { | ||
| name: 'balenaOS', | ||
| slug: 'balenaos', | ||
| type: 'sw.os', | ||
| description: 'Balena OS', | ||
| partials: { | ||
| image: [`{{#each deviceType.partials.instructions}}{{{this}}} {{/each}}`], | ||
| internalFlash: [ | ||
| `{{#each deviceType.partials.connectDevice}}{{{this}}} {{/each}}`, | ||
| `Write the {{name}} file you downloaded to the {{deviceType.name}}. We recommend using <a href="http://www.etcher.io/">Etcher</a>.`, | ||
| `Wait for writing of {{name}} to complete.`, | ||
| `{{#each deviceType.partials.disconnectDevice}}{{{this}}} {{/each}}`, | ||
| `{{{deviceType.partials.bootDevice}}} to boot the device.`, | ||
| ], | ||
| externalFlash: [ | ||
| `Insert the {{deviceType.data.media.altBoot.[0]}} to the host machine.`, | ||
| `Write the {{name}} file you downloaded to the {{deviceType.data.media.altBoot.[0]}}. We recommend using <a href="http://www.etcher.io/">Etcher</a>.`, | ||
| `Wait for writing of {{name}} to complete.`, | ||
| `Remove the {{deviceType.data.media.altBoot.[0]}} from the host machine.`, | ||
| `Insert the freshly flashed {{deviceType.data.media.altBoot.[0]}} into the {{deviceType.name}}.`, | ||
| `<strong role="alert">Warning!</strong> This will also completely erase internal storage medium, so please make a backup first.`, | ||
| `{{#each deviceType.partials.bootDeviceExternal}}{{{this}}} {{/each}}`, | ||
| `Wait for the {{deviceType.name}} to finish flashing and shutdown. {{#if deviceType.partials.flashIndicator}}Please wait until {{deviceType.partials.flashIndicator}}.{{/if}}`, | ||
| `Remove the {{deviceType.data.media.altBoot.[0]}} from the {{deviceType.name}}.`, | ||
| `{{#each deviceType.partials.bootDeviceInternal}}{{{this}}} {{/each}}`, | ||
| `{{{deviceType.partials.bootDevice}}} to boot the device.`, | ||
| ], | ||
| externalBoot: [ | ||
| `Insert the {{deviceType.data.media.defaultBoot}} to the host machine.`, | ||
| `Write the {{name}} file you downloaded to the {{deviceType.data.media.defaultBoot}}. We recommend using <a href="http://www.etcher.io/">Etcher</a>.`, | ||
| `Wait for writing of {{name}} to complete.`, | ||
| `Remove the {{deviceType.data.media.defaultBoot}} from the host machine.`, | ||
| `Insert the freshly flashed {{deviceType.data.media.defaultBoot}} into the {{deviceType.name}}.`, | ||
| `{{{deviceType.partials.bootDevice}}} to boot the device.`, | ||
| ], | ||
| jetsonFlash: [ | ||
| `Put the device in recovery mode and connect to the host computer via USB`, | ||
| `{{#if deviceType.partials.jetsonNotes}}{{#each deviceType.partials.jetsonNotes}}{{{this}}} {{/each}}{{/if}}`, | ||
| `Unzip the {{name}} image and use the Jetson Flash tool to flash the {{deviceType.name}} found at <a href="https://github.com/balena-os/jetson-flash">https://github.com/balena-os/jetson-flash</a>.`, | ||
| `Wait for writing of {{name}} to complete.`, | ||
| `{{{deviceType.partials.bootDevice}}} to boot the device.`, | ||
| ], | ||
| edisonFlash: { | ||
| Linux: [ | ||
| `{{#each deviceType.partials.Linux.flashDependencies}}{{{this}}} {{/each}}`, | ||
| `Unplug the {{deviceType.name}} from your system`, | ||
| `Unzip the downloaded {{name}} file`, | ||
| `{{#each deviceType.partials.Linux.flashInstructions}}{{{this}}} {{/each}}`, | ||
| `Plug the {{deviceType.name}} as per the instructions on your terminal.`, | ||
| `You can check the progress of the provisioning on your terminal.`, | ||
| ], | ||
| MacOS: [ | ||
| `{{#each deviceType.partials.MacOS.flashDependencies}}{{{this}}} {{/each}}`, | ||
| `Unplug the {{deviceType.name}} from your system`, | ||
| `Unzip the downloaded {{name}} file`, | ||
| `{{#each deviceType.partials.MacOS.flashInstructions}}{{{this}}} {{/each}}`, | ||
| `Plug the {{deviceType.name}} as per the instructions on your terminal.`, | ||
| `You can check the progress of the provisioning on your terminal.`, | ||
| ], | ||
| Windows: [ | ||
| `{{#each deviceType.partials.Windows.flashDependencies}}{{{this}}} {{/each}}`, | ||
| `Unplug the {{deviceType.name}} from your system`, | ||
| `Unzip the downloaded {{name}} file`, | ||
| `{{#each deviceType.partials.Windows.flashInstructions}}{{{this}}} {{/each}}`, | ||
| `Plug the {{deviceType.name}} as per the instructions on your terminal.`, | ||
| `You can check the progress of the provisioning on your terminal.`, | ||
| ], | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
|
There was a problem hiding this comment. Both There was a problem hiding this comment. Hm, each of these partials are supported installation methods of the operating system and are not necessarily device specific. Any device that supports using the jetson flash tool should be allowed to get these instructions. These are just Balena OS's way of saying, "I support being installed with the jetson flash tool, and this is how. It doesn't provide any information that is specific to a device type. If that makes sense. Basically it's the BalenaOS's part in the flash process of telling the user "how to handle the file that I am giving you. There was a problem hiding this comment. Jetson is a device family, no other vendor will use Jetson tools. And the same goes for edison. Why would a contract for the RaspberryPi need to mention other vendors like Jetson or edison? In my view this corresponds to a |
||
| export { BalenaOS }; | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mehalter the partials above should go into the existing balenaOS contract in https://github.com/balena-io/contracts/blob/master/contracts/sw.os/balenaos/contract.json.
This is already used by the OS build scripts so when added the contract will be deployed with the OS release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome, I'll get this moved over. Is this accessible through the API as well?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@mehalter it's deployed with the OS release. For example if you do:
You will get something like:
As you see at the moment the contract is very basic, but once you add the instructions they will appear there.