Pushing new features in stable swagger (#23071)

* Pushing new features in stable swagger * Added example file * Triggering retest * Fixed version issue * Triggering retest * Removing OS Patching * Changes as per feedback, and add os patching back * Fix formatting * Removed Custom Service Update API * Fixed Example Files * Added as per review comments * Added as per review comments * Retrigger test --------- Co-authored-by: Srivatsa Sinha <[email protected]>
Azure · Mar 30, 2023 · ea7763c · ea7763c
1 parent e033ca0
commit ea7763c
Show file tree

Hide file tree

Showing 3 changed files with 351 additions and 0 deletions.
diff --git a/...neLearningServices/stable/2023-04-01/examples/Compute/createOrUpdate/ComputeInstance.json b/...neLearningServices/stable/2023-04-01/examples/Compute/createOrUpdate/ComputeInstance.json
@@ -15,6 +15,40 @@
             "id": "test-subnet-resource-id"
           },
           "applicationSharingPolicy": "Personal",
+          "customServices": [
+            {
+              "docker": {
+                "privileged": true
+              },
+              "environmentVariables": {
+                "test_variable": {
+                  "type": "local",
+                  "value": "test_value"
+                }
+              },
+              "volumes": [
+                {
+                  "type": "bind",
+                  "read_only": false,
+                  "source": "/home/azureuser/cloudfiles",
+                  "target": "/home/azureuser/cloudfiles"
+                }
+              ],
+              "endpoints": [
+                {
+                  "name": "connect",
+                  "target": 8787,
+                  "published": 8787,
+                  "protocol": "http"
+                }
+              ],
+              "image": {
+                "type": "docker",
+                "reference": "ghcr.io/azure/rocker-rstudio-ml-verse:latest"
+              },
+              "name": "rstudio"
+            }
+          ],
           "sshSettings": {
             "sshPublicAccess": "Disabled"
           },

diff --git a/...osoft.MachineLearningServices/stable/2023-04-01/examples/Compute/get/ComputeInstance.json b/...osoft.MachineLearningServices/stable/2023-04-01/examples/Compute/get/ComputeInstance.json
@@ -30,6 +30,45 @@
               "adminUserName": "azureuser",
               "sshPort": 22
             },
+            "osImageMetadata": {
+              "currentImageVersion": "22.06.14",
+              "latestImageVersion": "22.07.22",
+              "isLatestOsImageVersion": false
+            },
+            "customServices": [
+              {
+                "docker": {
+                  "privileged": true
+                },
+                "environmentVariables": {
+                  "test_var": {
+                    "type": "local",
+                    "value": "test_val"
+                  }
+                },
+                "volumes": [
+                  {
+                    "type": "bind",
+                    "read_only": false,
+                    "source": "/home/azureuser/cloudfiles",
+                    "target": "/home/azureuser/cloudfiles"
+                  }
+                ],
+                "endpoints": [
+                  {
+                    "name": "connect",
+                    "target": 8787,
+                    "published": 8787,
+                    "protocol": "http"
+                  }
+                ],
+                "image": {
+                  "type": "docker",
+                  "reference": "ghcr.io/azure/rocker-rstudio-ml-verse:latest"
+                },
+                "name": "rstudio"
+              }
+            ],
             "computeInstanceAuthorizationType": "personal",
             "personalComputeInstanceSettings": {
               "assignedUser": {

diff --git a/...-manager/Microsoft.MachineLearningServices/stable/2023-04-01/machineLearningServices.json b/...-manager/Microsoft.MachineLearningServices/stable/2023-04-01/machineLearningServices.json
@@ -3597,6 +3597,22 @@
           "$ref": "#/definitions/ComputeInstanceSshSettings",
           "x-nullable": true
         },
+        "customServices": {
+          "type": "array",
+          "description": "List of Custom Services added to the compute.",
+          "x-nullable": true,
+          "items": {
+            "$ref": "#/definitions/CustomService"
+          },
+          "x-ms-identifiers": [
+            "name"
+          ]
+        },
+        "osImageMetadata": {
+          "readOnly": true,
+          "description": "Returns metadata about the operating system image for this compute instance.",
+          "$ref": "#/definitions/ImageMetadata"
+        },
         "connectivityEndpoints": {
           "readOnly": true,
           "description": "Describes all connectivity endpoints available for this ComputeInstance.",
@@ -4700,6 +4716,268 @@
         }
       }
     },
+    "ImageMetadata": {
+      "type": "object",
+      "description": "Returns metadata about the operating system image for this compute instance.",
+      "properties": {
+        "currentImageVersion": {
+          "type": "string",
+          "description": "Specifies the current operating system image version this compute instance is running on."
+        },
+        "latestImageVersion": {
+          "type": "string",
+          "description": "Specifies the latest available operating system image version."
+        },
+        "isLatestOsImageVersion": {
+          "type": "boolean",
+          "description": "Specifies whether this compute instance is running on the latest operating system image."
+        }
+      }
+    },
+    "CustomService": {
+      "type": "object",
+      "description": "Specifies the custom service configuration",
+      "properties": {
+        "name": {
+          "type": "string",
+          "description": "Name of the Custom Service"
+        },
+        "image": {
+          "$ref": "#/definitions/Image",
+          "description": "Describes the Image Specifications"
+        },
+        "environmentVariables": {
+          "type": "object",
+          "description": "Environment Variable for the container",
+          "additionalProperties": {
+            "$ref": "#/definitions/EnvironmentVariable"
+          }
+        },
+        "docker": {
+          "description": "Describes the docker settings for the image",
+          "$ref": "#/definitions/Docker",
+          "x-nullable": true
+        },
+        "endpoints": {
+          "type": "array",
+          "description": "Configuring the endpoints for the container",
+          "items": {
+            "$ref": "#/definitions/Endpoint"
+          },
+          "x-ms-identifiers": [
+            "name"
+          ]
+        },
+        "volumes": {
+          "type": "array",
+          "description": "Configuring the volumes for the container",
+          "items": {
+            "$ref": "#/definitions/VolumeDefinition"
+          },
+          "x-ms-identifiers": [
+            "source",
+            "target"
+          ]
+        }
+      },
+      "additionalProperties": true
+    },
+    "Image": {
+      "type": "object",
+      "description": "Describes the Image Specifications",
+      "properties": {
+        "type": {
+          "default": "docker",
+          "enum": [
+            "docker",
+            "azureml"
+          ],
+          "type": "string",
+          "title": "Type of the image",
+          "description": "Type of the image. Possible values are: docker - For docker images. azureml - For AzureML images",
+          "x-ms-enum": {
+            "name": "ImageType",
+            "modelAsString": true
+          }
+        },
+        "reference": {
+          "type": "string",
+          "description": "Image reference"
+        }
+      },
+      "additionalProperties": true
+    },
+    "EnvironmentVariable": {
+      "type": "object",
+      "description": "Environment Variables for the container",
+      "properties": {
+        "type": {
+          "enum": [
+            "local"
+          ],
+          "default": "local",
+          "title": "Type of Environment Variable",
+          "description": "Type of the Environment Variable. Possible values are: local - For local variable",
+          "type": "string",
+          "x-ms-enum": {
+            "name": "EnvironmentVariableType",
+            "modelAsString": true
+          }
+        },
+        "value": {
+          "type": "string",
+          "description": "Value of the Environment variable"
+        }
+      },
+      "additionalProperties": true
+    },
+    "Docker": {
+      "type": "object",
+      "description": "Docker container configuration",
+      "properties": {
+        "privileged": {
+          "type": "boolean",
+          "description": "Indicate whether container shall run in privileged or non-privileged mode.",
+          "x-nullable": true
+        }
+      },
+      "additionalProperties": true
+    },
+    "Endpoint": {
+      "type": "object",
+      "description": "Describes the endpoint configuration for the container",
+      "properties": {
+        "protocol": {
+          "enum": [
+            "tcp",
+            "udp",
+            "http"
+          ],
+          "default": "tcp",
+          "title": "Endpoint Communication Protocol",
+          "description": "Protocol over which communication will happen over this endpoint",
+          "x-ms-enum": {
+            "name": "protocol",
+            "modelAsString": true
+          },
+          "type": "string"
+        },
+        "name": {
+          "type": "string",
+          "description": "Name of the Endpoint"
+        },
+        "target": {
+          "format": "int32",
+          "type": "integer",
+          "description": "Application port inside the container."
+        },
+        "published": {
+          "format": "int32",
+          "type": "integer",
+          "description": "Port over which the application is exposed from container.",
+          "x-nullable": true
+        },
+        "hostIp": {
+          "description": "Host IP over which the application is exposed from the container",
+          "type": "string",
+          "x-nullable": true
+        }
+      }
+    },
+    "VolumeDefinition": {
+      "type": "object",
+      "description": "Describes the volume configuration for the container",
+      "properties": {
+        "type": {
+          "enum": [
+            "bind",
+            "volume",
+            "tmpfs",
+            "npipe"
+          ],
+          "default": "bind",
+          "title": "Type of Volume Definition",
+          "description": "Type of Volume Definition. Possible Values: bind,volume,tmpfs,npipe",
+          "x-ms-enum": {
+            "name": "VolumeDefinitionType",
+            "modelAsString": true
+          },
+          "type": "string"
+        },
+        "readOnly": {
+          "type": "boolean",
+          "description": "Indicate whether to mount volume as readOnly. Default value for this is false.",
+          "x-nullable": true
+        },
+        "source": {
+          "type": "string",
+          "description": "Source of the mount. For bind mounts this is the host path."
+        },
+        "target": {
+          "type": "string",
+          "description": "Target of the mount. For bind mounts this is the path in the container."
+        },
+        "consistency": {
+          "type": "string",
+          "description": "Consistency of the volume"
+        },
+        "bind": {
+          "$ref": "#/definitions/BindOptions",
+          "description": "Bind Options of the mount"
+        },
+        "volume": {
+          "$ref": "#/definitions/VolumeOptions",
+          "description": "Volume Options of the mount"
+        },
+        "tmpfs": {
+          "$ref": "#/definitions/TmpfsOptions",
+          "description": "tmpfs option of the mount"
+        }
+      }
+    },
+    "VolumeOptions": {
+      "type": "object",
+      "description": "Describes the volume options for the container",
+      "properties": {
+        "nocopy": {
+          "type": "boolean",
+          "description": "Indicate whether volume is nocopy",
+          "x-nullable": true
+        }
+      }
+    },
+    "BindOptions": {
+      "type": "object",
+      "description": "Describes the bind options for the container",
+      "properties": {
+        "propagation": {
+          "type": "string",
+          "description": "Type of Bind Option",
+          "x-nullable": true
+        },
+        "createHostPath": {
+          "type": "boolean",
+          "description": "Indicate whether to create host path.",
+          "x-nullable": true
+        },
+        "selinux": {
+          "type": "string",
+          "description": "Mention the selinux options.",
+          "x-nullable": true
+        }
+      }
+    },
+    "TmpfsOptions": {
+      "description": "Describes the tmpfs options for the container",
+      "type": "object",
+      "properties": {
+        "size": {
+          "format": "int32",
+          "type": "integer",
+          "description": "Mention the Tmpfs size"
+        }
+      }
+    },
     "ComputeInstanceSshSettings": {
       "type": "object",
       "description": "Specifies policy and settings for SSH access.",