Skip to content

Support log streaming on build resource #25902

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sjanamma merged 12 commits into from
Oct 6, 2023
Merged

Support log streaming on build resource #25902

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
b3131fd
updated the build resource to support build upload and log streaming,…
pauld-msft Sep 21, 2023
c02b32a
add x-ms-secret and update buildendpoint -> endpoint
pauld-msft Sep 21, 2023
85d2311
retrieve log stream and upload endpoint tokens through post requests,…
pauld-msft Sep 21, 2023
f3c99f9
remove secret flag from tokenendpoint property, as we expect users to…
pauld-msft Sep 21, 2023
406cc8d
rename file
pauld-msft Sep 21, 2023
78fe5b0
updated format of how build object returns auth token
pauld-msft Sep 25, 2023
635550b
fix example
pauld-msft Sep 25, 2023
a11cf62
added expiration date to token response
pauld-msft Sep 27, 2023
1cdea52
fix auth token to also include build resource information
pauld-msft Sep 27, 2023
a717abb
renamed getAuthToken -> listAuthToken and removed resource informatio…
pauld-msft Sep 28, 2023
64f5034
fix examples
pauld-msft Oct 2, 2023
7785d55
updated samples to be more accurate
pauld-msft Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 73 additions & 0 deletions specification/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/Builds.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,51 @@
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/builders/{builderName}/builds/{buildName}/listAuthToken": {
"post": {
"tags": [
"Builds"
],
"operationId": "Builds_ListAuthToken",
"description": "Gets the token used to connect to the endpoint where source code can be uploaded for a build.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "./Builders.json#/parameters/BuilderNameParameter"
},
{
"$ref": "#/parameters/BuildNameParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/BuildToken"
}
},
"default": {
"description": "Common error response.",
"schema": {
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Build Auth Token": {
"$ref": "./examples/Builds_ListAuthToken.json"
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -311,6 +356,16 @@
"type": "string",
"description": "Endpoint to which the source code should be uploaded.",
"readOnly": true
},
"logStreamEndpoint": {
"type": "string",
"description": "Endpoint from which the build logs can be streamed.",
"readOnly": true
},
"tokenEndpoint": {
"type": "string",
"description": "Endpoint to use to retrieve an authentication token for log streaming and uploading source code.",
"readOnly": true
}
},
"description": "The build properties."
Expand Down Expand Up @@ -388,6 +443,24 @@
"server"
]
},
"BuildToken": {
"description": "Build Auth Token.",
"type": "object",
"properties": {
"token": {
"type": "string",
"x-ms-secret": true,
"description": "Authentication token.",
"readOnly": true
},
"expires": {
"format": "date-time",
"description": "Token expiration date.",
"type": "string",
"readOnly": true
}
}
},
"EnvironmentVariable": {
"type": "object",
"properties": {
Expand Down
8 changes: 6 additions & 2 deletions ...urce-manager/Microsoft.App/preview/2023-08-01-preview/examples/Builds_CreateOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,9 @@
}
]
},
"uploadEndpoint": "foo.azurecontainerapps.dev/upload"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand Down Expand Up @@ -194,7 +196,9 @@
}
]
},
"uploadEndpoint": "foo.azurecontainerapps.dev/upload"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand Down
8 changes: 6 additions & 2 deletions ...ger/Microsoft.App/preview/2023-08-01-preview/examples/Builds_CreateOrUpdate_NoConfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@
"properties": {
"provisioningState": "Succeeded",
"buildStatus": "InProgress",
"uploadEndpoint": "https://testStorage.blob.core.windows.net/buildGUID/blobName"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand All @@ -41,7 +43,9 @@
"properties": {
"provisioningState": "Creating",
"buildStatus": "InProgress",
"uploadEndpoint": "https://testStorage.blob.core.windows.net/buildGUID/blobName"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand Down
4 changes: 3 additions & 1 deletion ...on/app/resource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Builds_Get.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,9 @@
}
]
},
"uploadEndpoint": "foo.azurecontainerapps.dev/upload"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand Down
20 changes: 20 additions & 0 deletions ...ource-manager/Microsoft.App/preview/2023-08-01-preview/examples/Builds_ListAuthToken.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"operationId": "Builds_ListAuthToken",
"title": "Builds_ListAuthToken_0",
"parameters": {
"api-version": "2023-08-01-preview",
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"resourceGroupName": "rg",
"builderName": "testBuilder",
"buildName": "testBuild"
},
"responses": {
"200": {
"headers": {},
"body": {
"token": "foobartoken",
"expires": "2022-07-14T19:22:50.3080223Z"
}
}
}
}
8 changes: 6 additions & 2 deletions ...nager/Microsoft.App/preview/2023-08-01-preview/examples/Builds_ListByBuilderResource.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,9 @@
}
]
},
"uploadEndpoint": "foo.azurecontainerapps.dev/upload"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand Down Expand Up @@ -137,7 +139,9 @@
}
]
},
"uploadEndpoint": "foo.azurecontainerapps.dev/upload"
"uploadEndpoint": "https://foo.azurecontainerapps.dev/upload",
"logStreamEndpoint": "https://foo.azurecontainerapps.dev/logstream",
"tokenEndpoint": "https://management.azure.com/subscriptions/{subscription-id}/resourcegroups/{rg-id}/Microsoft.App/builders/testBuilder/builds/testBuild/listAuthToken"
},
"systemData": {
"createdBy": "sample@microsoft.com",
Expand Down