SDK marrying config to an os download

jordan-lumley · October 31, 2022, 3:00pm

Not necessarily ‘expected’ behavior but within the CLI, you can use the ‘os config generate’ command to set some initial settings then in the ‘os configure’ command you marry that config.json with the actual ‘.img’ file. Can’t seem to do this in an automated fashion aside from running a node js exec shell to use the host system CLI which just feels dirty.

When running the sdk os.getConfig this returns the config and the os.download returns an .img file but there’s not a way to my knowledge to join the two without using the CLI thus making an automated step to prepare and generate a new device addition in a programmatic fashion a little tough.

Maybe I am missing something but this is more-so a sanity check to make sure I am not missing anything.

zoobot · October 31, 2022, 8:56pm

Hi, Looks like your fastest way is probably to use exec as the cli configure is doing quite a bit of work. The configure method does not specifically exist in sdk that I can see. It is open source so you are always welcome to add it to the sdk!! I see you added an issue to request it, hopefully one of the sdk devs will pick it up soon. #1262

github.com

balena-io/balena-cli/blob/master/lib/commands/os/configure.ts

/**
 * @license
 * Copyright 2019 Balena Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { flags } from '@oclif/command';
import type * as BalenaSdk from 'balena-sdk';
import { promisify } from 'util';

This file has been truncated. show original

github.com

balena-io/balena-sdk/blob/bffa4afcb652fe7ed634fd4983fc848c1c4f8a5c/lib/models/os.ts#L806


      
          	 *
          	 * balena.models.os.getConfig(123, { version: '2.12.7+rev1.prod' }).then(function(config) {
          	 * 	fs.writeFile('foo/bar/config.json', JSON.stringify(config));
          	 * });
          	 *
          	 * balena.models.os.getConfig('myorganization/myapp', { version: '2.12.7+rev1.prod' }, function(error, config) {
          	 * 	if (error) throw error;
          	 * 	fs.writeFile('foo/bar/config.json', JSON.stringify(config));
          	 * });
          	 */
          	const getConfig = async function (
          		slugOrUuidOrId: string | number,
          		options: ImgConfigOptions,
          	): Promise<object> {
          		if (!options?.version) {
          			throw new Error('An OS version is required when calling os.getConfig');
          		}
          
          
		options.network = options.network ?? 'ethernet';
          
          
		try {

github.com

balena-io/balena-sdk/blob/bffa4afcb652fe7ed634fd4983fc848c1c4f8a5c/lib/models/os.ts#L960


      
          		applicationArchitecture: string,
          	): boolean => {
          		const compatibleArches = archCompatibilityMap[osArchitecture];
          		return (
          			osArchitecture === applicationArchitecture ||
          			(Array.isArray(compatibleArches) &&
          				compatibleArches.includes(applicationArchitecture))
          		);
          	};
          
          
	return {
          		// Cast the exported types for internal methods so `@types/memoizee` can be a dev depenency.
          		_getNormalizedDeviceTypeSlug: _getNormalizedDeviceTypeSlug as (
          			deviceTypeSlug: string,
          		) => Promise<string>,
          		_getDownloadSize: _getDownloadSize as (
          			deviceType: string,
          			version: string,
          		) => Promise<number>,
          		_clearDeviceTypesAndOsVersionCaches,
          		_getMaxSatisfyingVersion,

Topic		Replies	Views
Configure OS without CLI Product support balena-cli	1	359	February 2, 2021
balena-cli image build process from scratch Product support balena-cli	2	913	November 30, 2020
Bootstrap app from common device image Product support	0	528	February 9, 2019
Preparing os image 'offline' (`balena os configure ...`) Product support balena-cli	3	321	May 11, 2023
Alternative ways of connecting devices to openBalena openBalena	14	786	November 5, 2020

SDK marrying config to an os download

Related topics