Skip to content

Core:Kraken: Allow installing extensions directly from .tar image file #3646

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
patrickelectric merged 3 commits into from
Dec 19, 2025
Merged

Core:Kraken: Allow installing extensions directly from .tar image file #3646

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
11bd67f
core:services:kraken: Add load/inpect/install from tar
joaomariolago Nov 6, 2025
f00e7dc
core:services:kraken: Add API for tar loading
joaomariolago Nov 6, 2025
00d462c
core:frontend: Add Load/Install ext frontend
joaomariolago Nov 6, 2025
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 core/frontend/src/components/kraken/KrakenManager.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import {
ExtensionData,
ExtensionUploadResponse,
InstalledExtensionData,
Manifest,
ManifestSource,
RunningContainer,
UploadProgressEvent,
} from '@/types/kraken'
import back_axios from '@/utils/api'

Expand Down Expand Up @@ -335,6 +337,74 @@ export async function getContainerLogs(
})
}

/**
* Upload a tar file containing a Docker image and extract metadata
* @param {File} file The tar file to upload
* @returns {Promise<{temp_tag: string, metadata: any, image_name: string}>}
*/
export async function uploadExtensionTarFile(
file: File,
progressHandler?: (event: UploadProgressEvent) => void,
): Promise<ExtensionUploadResponse> {
const formData = new FormData()
formData.append('file', file)

const response = await back_axios({
method: 'POST',
url: `${KRAKEN_API_V2_URL}/extension/upload`,
data: formData,
headers: {
'Content-Type': 'multipart/form-data',
},
timeout: 120000,
onUploadProgress: progressHandler,
})

return response.data
}

/**
* Keep a temporary uploaded extension alive while the user configures metadata.
* @param {string} tempTag The temporary tag returned by the upload endpoint
* @returns {Promise<void>}
*/
export async function keepTemporaryExtensionAlive(tempTag: string): Promise<void> {
await back_axios({
method: 'POST',
url: `${KRAKEN_API_V2_URL}/extension/upload/keep-alive?temp_tag=${tempTag}`,
timeout: 10000,
})
}

/**
* Finalize a temporary extension by assigning a valid identifier and installing it
* @param {InstalledExtensionData} extension The extension data to finalize
* @param {string} tempTag The temporary tag from upload response
* @param {function} progressHandler The progress handler for the download
* @returns {Promise<void>}
*/
export async function finalizeExtension(
extension: InstalledExtensionData,
tempTag: string,
progressHandler: (event: any) => void,
): Promise<void> {
await back_axios({
method: 'POST',
url: `${KRAKEN_API_V2_URL}/extension/upload/finalize?temp_tag=${tempTag}`,
data: {
identifier: extension.identifier,
name: extension.name,
docker: extension.docker,
tag: extension.tag,
enabled: true,
permissions: extension?.permissions ?? '',
user_permissions: extension?.user_permissions ?? '',
},
timeout: 120000,
onDownloadProgress: progressHandler,
})
}

export default {
fetchManifestSources,
fetchManifestSource,
Expand All @@ -357,4 +427,7 @@ export default {
listContainers,
getContainersStats,
getContainerLogs,
uploadExtensionTarFile,
keepTemporaryExtensionAlive,
finalizeExtension,
}
11 changes: 9 additions & 2 deletions core/frontend/src/components/kraken/modals/ExtensionCreationModal.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
>
<v-card>
<v-card-title class="d-flex align-center justify-space-between">
<span>{{ is_editing ? 'Edit' : 'Create' }} Extension</span>
<span>{{ is_editing ? 'Edit' : (is_from_upload ? 'Configure Uploaded' : 'Create') }} Extension</span>
<v-btn
icon
x-small
Expand Down Expand Up @@ -89,7 +89,7 @@
:disabled="!valid_permissions"
@click="saveExtension"
>
{{ is_editing ? 'Save' : 'Create' }}
{{ is_editing ? 'Save' : (is_from_upload ? 'Install' : 'Create') }}
</v-btn>
</v-card-actions>
</v-card>
Expand Down Expand Up @@ -118,6 +118,10 @@ export default Vue.extend({
type: Object as PropType<InstalledExtensionData & { editing: boolean } | null>,
default: null,
},
tempTag: {
type: String,
default: null,
},
},

data() {
Expand All @@ -141,6 +145,9 @@ export default Vue.extend({
is_editing() {
return this.extension?.editing ?? false
},
is_from_upload() {
return Boolean(this.tempTag)
},
is_reset_editing_permissions_visible() {
return this.new_permissions !== this.extension?.permissions
},
Expand Down
23 changes: 21 additions & 2 deletions core/frontend/src/types/kraken.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,27 @@ export interface Manifest extends ManifestSource {
data?: [ExtensionData]
}

export interface ProgressEvent {
export interface StreamProgressEvent {
currentTarget: {
response: string
}
}
}

export interface UploadProgressEvent {
loaded: number
total?: number
}

export interface ExtensionUploadMetadata {
identifier?: string
name?: string
docker?: string
tag?: string
permissions?: JSONValue
}

export interface ExtensionUploadResponse {
temp_tag: string
metadata: ExtensionUploadMetadata
image_name: string
}
Loading