feat(apple_silicon): add CI-CD runner installation APIs (#2440)

Co-authored-by: Jonathan Remy <[email protected]>
Co-authored-by: Yacine Fodil <[email protected]>

Author: 3 people

packages_generated/applesilicon/src/v1alpha1/index.gen.ts

@@ -33,13 +33,16 @@ export type {
   ListServerTypesRequest,
   ListServerTypesResponse,
   OS,
+  OSSupportedServerType,
   PrivateNetworkApiAddServerPrivateNetworkRequest,
   PrivateNetworkApiDeleteServerPrivateNetworkRequest,
   PrivateNetworkApiGetServerPrivateNetworkRequest,
   PrivateNetworkApiListServerPrivateNetworksRequest,
   PrivateNetworkApiSetServerPrivateNetworksRequest,
   RebootServerRequest,
   ReinstallServerRequest,
+  RunnerConfiguration,
+  RunnerConfigurationProvider,
   Server,
   ServerPrivateNetwork,
   ServerPrivateNetworkServerStatus,

packages_generated/applesilicon/src/v1alpha1/marshalling.gen.ts

@@ -21,9 +21,11 @@ import type {
   ListServersResponse,
   ListServerTypesResponse,
   OS,
+  OSSupportedServerType,
   PrivateNetworkApiAddServerPrivateNetworkRequest,
   PrivateNetworkApiSetServerPrivateNetworksRequest,
   ReinstallServerRequest,
+  RunnerConfiguration,
   Server,
   ServerPrivateNetwork,
   ServerType,
@@ -39,6 +41,21 @@ import type {
   UpdateServerRequest,
 } from './types.gen'
 
+const unmarshalOSSupportedServerType = (
+  data: unknown,
+): OSSupportedServerType => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'OSSupportedServerType' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    fastDeliveryAvailable: data.fast_delivery_available,
+    serverType: data.server_type,
+  } as OSSupportedServerType
+}
+
 export const unmarshalOS = (data: unknown): OS => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -47,13 +64,22 @@ export const unmarshalOS = (data: unknown): OS => {
   }
 
   return {
-    compatibleServerTypes: data.compatible_server_types,
+    compatibleServerTypes: data.compatible_server_types
+      ? data.compatible_server_types
+      : undefined,
+    description: data.description,
     family: data.family,
     id: data.id,
     imageUrl: data.image_url,
     isBeta: data.is_beta,
     label: data.label,
     name: data.name,
+    releaseNotesUrl: data.release_notes_url,
+    supportedServerTypes: unmarshalArrayOfObject(
+      data.supported_server_types,
+      unmarshalOSSupportedServerType,
+    ),
+    tags: data.tags,
     version: data.version,
     xcodeVersion: data.xcode_version,
   } as OS
@@ -72,6 +98,21 @@ const unmarshalCommitment = (data: unknown): Commitment => {
   } as Commitment
 }
 
+const unmarshalRunnerConfiguration = (data: unknown): RunnerConfiguration => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'RunnerConfiguration' failed as data isn't a dictionary.`,
+    )
+  }
+
+  return {
+    name: data.name,
+    provider: data.provider,
+    token: data.token,
+    url: data.url,
+  } as RunnerConfiguration
+}
+
 export const unmarshalServer = (data: unknown): Server => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -94,9 +135,13 @@ export const unmarshalServer = (data: unknown): Server => {
     os: data.os ? unmarshalOS(data.os) : undefined,
     projectId: data.project_id,
     publicBandwidthBps: data.public_bandwidth_bps,
+    runnerConfiguration: data.runner_configuration
+      ? unmarshalRunnerConfiguration(data.runner_configuration)
+      : undefined,
     sshUsername: data.ssh_username,
     status: data.status,
     sudoPassword: data.sudo_password,
+    tags: data.tags,
     type: data.type,
     updatedAt: unmarshalDate(data.updated_at),
     vncPort: data.vnc_port,
@@ -404,6 +449,16 @@ export const marshalBatchCreateServersRequest = (
   type: request.type,
 })
 
+const marshalRunnerConfiguration = (
+  request: RunnerConfiguration,
+  defaults: DefaultValues,
+): Record<string, unknown> => ({
+  name: request.name,
+  provider: request.provider,
+  token: request.token,
+  url: request.url,
+})
+
 export const marshalCreateServerRequest = (
   request: CreateServerRequest,
   defaults: DefaultValues,
@@ -414,6 +469,10 @@ export const marshalCreateServerRequest = (
   os_id: request.osId,
   project_id: request.projectId ?? defaults.defaultProjectId,
   public_bandwidth_bps: request.publicBandwidthBps,
+  runner_configuration:
+    request.runnerConfiguration !== undefined
+      ? marshalRunnerConfiguration(request.runnerConfiguration, defaults)
+      : undefined,
   type: request.type,
 })
 
@@ -437,6 +496,10 @@ export const marshalReinstallServerRequest = (
   defaults: DefaultValues,
 ): Record<string, unknown> => ({
   os_id: request.osId,
+  runner_configuration:
+    request.runnerConfiguration !== undefined
+      ? marshalRunnerConfiguration(request.runnerConfiguration, defaults)
+      : undefined,
 })
 
 export const marshalStartConnectivityDiagnosticRequest = (

packages_generated/applesilicon/src/v1alpha1/types.gen.ts

@@ -22,6 +22,11 @@ export type ListServerPrivateNetworksRequestOrderBy =
 
 export type ListServersRequestOrderBy = 'created_at_asc' | 'created_at_desc'
 
+export type RunnerConfigurationProvider =
+  | 'unknown_provider'
+  | 'github'
+  | 'gitlab'
+
 export type ServerPrivateNetworkServerStatus =
   | 'unknown_status'
   | 'attaching'
@@ -55,6 +60,11 @@ export type ServerTypeStock =
   | 'low_stock'
   | 'high_stock'
 
+export interface OSSupportedServerType {
+  serverType: string
+  fastDeliveryAvailable: boolean
+}
+
 export interface Commitment {
   type: CommitmentType
   cancelled: boolean
@@ -94,9 +104,32 @@ export interface OS {
    */
   xcodeVersion: string
   /**
-   * List of compatible server types.
+   * @deprecated List of compatible server types. Deprecated.
+   */
+  compatibleServerTypes?: string[]
+  /**
+   * Url of the release notes for the OS image or softwares pre-installed.
+   */
+  releaseNotesUrl: string
+  /**
+   * A summary of the OS image content and configuration.
+   */
+  description: string
+  /**
+   * List of tags for the OS configuration.
+   */
+  tags: string[]
+  /**
+   * List of server types which supports the OS configuration. Also gives information about immediate stock availability.
    */
-  compatibleServerTypes: string[]
+  supportedServerTypes: OSSupportedServerType[]
+}
+
+export interface RunnerConfiguration {
+  name: string
+  url: string
+  token: string
+  provider: RunnerConfigurationProvider
 }
 
 export interface ServerTypeCPU {
@@ -220,6 +253,14 @@ export interface Server {
    * Public bandwidth configured for this server. Expressed in bits per second.
    */
   publicBandwidthBps: number
+  /**
+   * Current runner configuration, empty if none is installed.
+   */
+  runnerConfiguration?: RunnerConfiguration
+  /**
+   * A list of tags attached to the server.
+   */
+  tags: string[]
 }
 
 export interface ConnectivityDiagnosticServerHealth {
@@ -401,6 +442,10 @@ export type CreateServerRequest = {
    * Public bandwidth to configure for this server. This defaults to the minimum bandwidth for this server type. For compatible server types, the bandwidth can be increased which incurs additional costs.
    */
   publicBandwidthBps: number
+  /**
+   * Specify the configuration to install an optional CICD runner on the server during installation.
+   */
+  runnerConfiguration?: RunnerConfiguration
 }
 
 export type DeleteServerRequest = {
@@ -667,6 +712,10 @@ export type ReinstallServerRequest = {
    * Reinstall the server with the target OS, when no os_id provided the default OS for the server type is used.
    */
   osId?: string
+  /**
+   * Specify the configuration to install an optional CICD runner on the server during installation.
+   */
+  runnerConfiguration?: RunnerConfiguration
 }
 
 export interface SetServerPrivateNetworksResponse {