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

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

Author: scaleway-bot

scaleway-async/scaleway_async/applesilicon/v1alpha1/__init__.py

@@ -5,15 +5,18 @@
 from .types import ConnectivityDiagnosticDiagnosticStatus
 from .types import ListServerPrivateNetworksRequestOrderBy
 from .types import ListServersRequestOrderBy
+from .types import RunnerConfigurationProvider
 from .types import ServerPrivateNetworkServerStatus
 from .content import SERVER_PRIVATE_NETWORK_SERVER_TRANSIENT_STATUSES
 from .types import ServerPrivateNetworkStatus
 from .content import SERVER_PRIVATE_NETWORK_TRANSIENT_STATUSES
 from .types import ServerStatus
 from .content import SERVER_TRANSIENT_STATUSES
 from .types import ServerTypeStock
+from .types import OSSupportedServerType
 from .types import Commitment
 from .types import OS
+from .types import RunnerConfiguration
 from .types import ServerTypeCPU
 from .types import ServerTypeDisk
 from .types import ServerTypeGPU
@@ -62,15 +65,18 @@
     "ConnectivityDiagnosticDiagnosticStatus",
     "ListServerPrivateNetworksRequestOrderBy",
     "ListServersRequestOrderBy",
+    "RunnerConfigurationProvider",
     "ServerPrivateNetworkServerStatus",
     "SERVER_PRIVATE_NETWORK_SERVER_TRANSIENT_STATUSES",
     "ServerPrivateNetworkStatus",
     "SERVER_PRIVATE_NETWORK_TRANSIENT_STATUSES",
     "ServerStatus",
     "SERVER_TRANSIENT_STATUSES",
     "ServerTypeStock",
+    "OSSupportedServerType",
     "Commitment",
     "OS",
+    "RunnerConfiguration",
     "ServerTypeCPU",
     "ServerTypeDisk",
     "ServerTypeGPU",

scaleway-async/scaleway_async/applesilicon/v1alpha1/api.py

@@ -32,6 +32,7 @@
     PrivateNetworkApiAddServerPrivateNetworkRequest,
     PrivateNetworkApiSetServerPrivateNetworksRequest,
     ReinstallServerRequest,
+    RunnerConfiguration,
     Server,
     ServerPrivateNetwork,
     ServerType,
@@ -142,6 +143,7 @@ async def create_server(
         project_id: Optional[str] = None,
         os_id: Optional[str] = None,
         commitment_type: Optional[CommitmentType] = None,
+        runner_configuration: Optional[RunnerConfiguration] = None,
     ) -> Server:
         """
         Create a server.
@@ -154,6 +156,7 @@ async def create_server(
         :param project_id: Create a server in the given project ID.
         :param os_id: Create a server & install the given os_id, when no os_id provided the default OS for this server type is chosen. Requesting a non-default OS will induce an extended delivery time.
         :param commitment_type: Activate commitment for this server. If not specified, there is a 24h commitment due to Apple licensing (commitment_type `duration_24h`). It can be updated with the Update Server request. Available commitment depends on server type.
+        :param runner_configuration: Specify the configuration to install an optional CICD runner on the server during installation.
         :return: :class:`Server <Server>`
 
         Usage:
@@ -181,6 +184,7 @@ async def create_server(
                     project_id=project_id,
                     os_id=os_id,
                     commitment_type=commitment_type,
+                    runner_configuration=runner_configuration,
                 ),
                 self.client,
             ),
@@ -638,13 +642,15 @@ async def reinstall_server(
         server_id: str,
         zone: Optional[ScwZone] = None,
         os_id: Optional[str] = None,
+        runner_configuration: Optional[RunnerConfiguration] = None,
     ) -> Server:
         """
         Reinstall a server.
         Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
         :param server_id: UUID of the server you want to reinstall.
         :param zone: Zone to target. If none is passed will use default zone from the config.
         :param os_id: Reinstall the server with the target OS, when no os_id provided the default OS for the server type is used.
+        :param runner_configuration: Specify the configuration to install an optional CICD runner on the server during installation.
         :return: :class:`Server <Server>`
 
         Usage:
@@ -666,6 +672,7 @@ async def reinstall_server(
                     server_id=server_id,
                     zone=zone,
                     os_id=os_id,
+                    runner_configuration=runner_configuration,
                 ),
                 self.client,
             ),

scaleway-async/scaleway_async/applesilicon/v1alpha1/marshalling.py

@@ -11,8 +11,10 @@
     ServerPrivateNetworkStatus,
     ServerStatus,
     ServerTypeStock,
+    OSSupportedServerType,
     OS,
     Commitment,
+    RunnerConfiguration,
     Server,
     ServerPrivateNetwork,
     ServerTypeCPU,
@@ -43,6 +45,29 @@
 )
 
 
+def unmarshal_OSSupportedServerType(data: Any) -> OSSupportedServerType:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'OSSupportedServerType' failed as data isn't a dictionary."
+        )
+
+    args: dict[str, Any] = {}
+
+    field = data.get("server_type", None)
+    if field is not None:
+        args["server_type"] = field
+    else:
+        args["server_type"] = None
+
+    field = data.get("fast_delivery_available", None)
+    if field is not None:
+        args["fast_delivery_available"] = field
+    else:
+        args["fast_delivery_available"] = None
+
+    return OSSupportedServerType(**args)
+
+
 def unmarshal_OS(data: Any) -> OS:
     if not isinstance(data, dict):
         raise TypeError(
@@ -99,6 +124,34 @@ def unmarshal_OS(data: Any) -> OS:
     else:
         args["xcode_version"] = None
 
+    field = data.get("release_notes_url", None)
+    if field is not None:
+        args["release_notes_url"] = field
+    else:
+        args["release_notes_url"] = None
+
+    field = data.get("description", None)
+    if field is not None:
+        args["description"] = field
+    else:
+        args["description"] = None
+
+    field = data.get("tags", None)
+    if field is not None:
+        args["tags"] = field
+    else:
+        args["tags"] = []
+
+    field = data.get("supported_server_types", None)
+    if field is not None:
+        args["supported_server_types"] = (
+            [unmarshal_OSSupportedServerType(v) for v in field]
+            if field is not None
+            else None
+        )
+    else:
+        args["supported_server_types"] = []
+
     field = data.get("compatible_server_types", None)
     if field is not None:
         args["compatible_server_types"] = field
@@ -131,6 +184,41 @@ def unmarshal_Commitment(data: Any) -> Commitment:
     return Commitment(**args)
 
 
+def unmarshal_RunnerConfiguration(data: Any) -> RunnerConfiguration:
+    if not isinstance(data, dict):
+        raise TypeError(
+            "Unmarshalling the type 'RunnerConfiguration' failed as data isn't a dictionary."
+        )
+
+    args: dict[str, Any] = {}
+
+    field = data.get("name", None)
+    if field is not None:
+        args["name"] = field
+    else:
+        args["name"] = None
+
+    field = data.get("url", None)
+    if field is not None:
+        args["url"] = field
+    else:
+        args["url"] = None
+
+    field = data.get("token", None)
+    if field is not None:
+        args["token"] = field
+    else:
+        args["token"] = None
+
+    field = data.get("provider", None)
+    if field is not None:
+        args["provider"] = field
+    else:
+        args["provider"] = None
+
+    return RunnerConfiguration(**args)
+
+
 def unmarshal_Server(data: Any) -> Server:
     if not isinstance(data, dict):
         raise TypeError(
@@ -261,12 +349,24 @@ def unmarshal_Server(data: Any) -> Server:
     else:
         args["public_bandwidth_bps"] = 0
 
+    field = data.get("tags", None)
+    if field is not None:
+        args["tags"] = field
+    else:
+        args["tags"] = []
+
     field = data.get("commitment", None)
     if field is not None:
         args["commitment"] = unmarshal_Commitment(field)
     else:
         args["commitment"] = None
 
+    field = data.get("runner_configuration", None)
+    if field is not None:
+        args["runner_configuration"] = unmarshal_RunnerConfiguration(field)
+    else:
+        args["runner_configuration"] = None
+
     return Server(**args)
 
 
@@ -864,6 +964,27 @@ def marshal_BatchCreateServersRequest(
     return output
 
 
+def marshal_RunnerConfiguration(
+    request: RunnerConfiguration,
+    defaults: ProfileDefaults,
+) -> dict[str, Any]:
+    output: dict[str, Any] = {}
+
+    if request.name is not None:
+        output["name"] = request.name
+
+    if request.url is not None:
+        output["url"] = request.url
+
+    if request.token is not None:
+        output["token"] = request.token
+
+    if request.provider is not None:
+        output["provider"] = request.provider
+
+    return output
+
+
 def marshal_CreateServerRequest(
     request: CreateServerRequest,
     defaults: ProfileDefaults,
@@ -893,6 +1014,11 @@ def marshal_CreateServerRequest(
     if request.commitment_type is not None:
         output["commitment_type"] = request.commitment_type
 
+    if request.runner_configuration is not None:
+        output["runner_configuration"] = marshal_RunnerConfiguration(
+            request.runner_configuration, defaults
+        )
+
     return output
 
 
@@ -934,6 +1060,11 @@ def marshal_ReinstallServerRequest(
     if request.os_id is not None:
         output["os_id"] = request.os_id
 
+    if request.runner_configuration is not None:
+        output["runner_configuration"] = marshal_RunnerConfiguration(
+            request.runner_configuration, defaults
+        )
+
     return output