Merge pull request #21 from hopinc/feat/create-deployment-volumes

.changeset/few-toys-kick.md

@@ -0,0 +1,5 @@
+---
+'@onehop/js': patch
+---
+
+Added volume config to creating a deployment

src/rest/types/ignite.ts

@@ -1,4 +1,4 @@
-import {ByteString} from '../../util/index.js';
+import {ByteSizeString} from '../../util/index.js';
 import {Endpoint} from '../endpoints.js';
 import {
 	Empty,
@@ -83,6 +83,28 @@ export enum VgpuType {
 	A400 = 'a400',
 }
 
+export enum VolumeFormat {
+	EXT4 = 'ext4',
+	XFS = 'xfs',
+}
+
+export interface VolumeDefinition {
+	/**
+	 * The format of the volume
+	 */
+	fs: VolumeFormat;
+
+	/**
+	 * The size of the volume in bytes
+	 */
+	size: ByteSizeString;
+
+	/**
+	 * The mount point of the volume
+	 */
+	mount_path: string;
+}
+
 export interface Container {
 	/**
 	 * The ID of the container
@@ -124,6 +146,11 @@ export interface Container {
 	 */
 	type: RuntimeType;
 
+	/**
+	 * The volume definition for this container
+	 */
+	volume: VolumeDefinition | null;
+
 	/**
 	 * The internal IP of the container
 	 */
@@ -164,7 +191,7 @@ export interface Deployment {
 	/**
 	 * The config for this deployment
 	 */
-	config: DeploymentConfig;
+	config: Omit<DeploymentConfig, 'volume' | 'name'>;
 }
 
 // This is a type not an interface so we can make a union
@@ -213,6 +240,13 @@ export type DeploymentConfig = {
 	 * Restart policy for this deployment
 	 */
 	restart_policy: RestartPolicy;
+
+	/**
+	 * The volume definition for this deployment
+	 *
+	 * This can only be used when .type is 'stateful'
+	 */
+	volume?: VolumeDefinition;
 };
 
 /**
@@ -277,7 +311,7 @@ export interface Resources {
 	 * Amount of memory to allocate in a readible format
 	 * You can use the `parseSize` function to convert this to bytes.
 	 */
-	ram: ByteString;
+	ram: ByteSizeString;
 
 	/**
 	 * vGPUs to allocate

src/sdks/ignite.ts

@@ -1,6 +1,11 @@
 import {create, Infer} from '@onehop/json-methods';
 import {API, assertId, Id} from '../rest/index.js';
-import {Deployment, Gateway, GatewayType} from '../rest/types/ignite.js';
+import {
+	Deployment,
+	Gateway,
+	GatewayType,
+	RuntimeType,
+} from '../rest/types/ignite.js';
 import {parseSize, validateId} from '../util/index.js';
 import {sdk} from './create.js';
 
@@ -106,6 +111,12 @@ export const ignite = sdk(client => {
 			);
 		}
 
+		if (config.volume && config.type !== RuntimeType.STATEFUL) {
+			throw new Error(
+				'Cannot create a deployment with a volume that is not stateful.',
+			);
+		}
+
 		const {deployment} = await client.post('/v1/ignite/deployments', config, {
 			project,
 		});

src/util/size.ts

@@ -4,9 +4,12 @@ export type ByteUnit =
 	| typeof byteUnits[number]
 	| Uppercase<typeof byteUnits[number]>;
 
-export type ByteString = `${number}${ByteUnit}`;
+export type ByteSizeString = `${number}${ByteUnit}`;
 
-export function isValidByteString(value: string): value is ByteString {
+/** @deprecated */
+export type ByteString = ByteSizeString;
+
+export function isValidByteString(value: string): value is ByteSizeString {
 	return byteUnits.some(unit => {
 		if (!value.endsWith(unit)) {
 			return false;