Lewati ke konten
AggregaAggrega
Pilih Bahasa: Bahasa Indonesia
Halaman ini diterjemahkan oleh mesin. Baca versi asli dalam bahasa Inggris.

Skema Aggrega Wasm Importer Socket

Referensi yang dihasilkan. Jangan diedit secara manual — hasilkan ulang dari JSON Schema yang dipublikasikan.

Id skema: https://aggrega.ai/schemas/wasm-import-v1beta1.schema.json

Bentuk wire yang dikonsumsi (ImportInput) dan dikeluarkan (ImportOutput) oleh socket plugin importer. Importer mengubah deskripsi infrastruktur asing menjadi entitas Aggrega: importer membaca byte sumber untuk format yang disebutkan, memetakan setiap node sumber ke entitas katalog, lalu mengembalikan entitas yang dikeluarkannya, keputusan pemetaan yang dibuatnya, diagnostik apa pun yang dimunculkannya, dan file scaffold apa pun yang dihasilkannya. Importer mendeklarasikan format yang ditanganinya sebagai kapabilitas import: dalam deskriptornya. Importer memetakan makna dari sumber ke entitas; compiler meneruskan entitas yang dikeluarkan secara opak.

Salah satu dari bentuk berikut

  • ImportInput
  • ImportOutput

Definisi

ImportInput

Payload yang diterima guest importer: format sumber yang menentukan cara membaca byte, byte sumber utama beserta nama file tempat byte itu dibaca, sumber bernama apa pun untuk impor multi-file, dokumen opsi opak opsional yang diberikan konsumen untuk perilaku khusus importer, tampilan Components yang dimuat katalog workspace, dan target yang menjadi sasaran draf impor.

PropertiJenisWajibDeskripsi
formatstringyaNama format sumber yang akan diimpor, yang cocok dengan salah satu kapabilitas import: yang diumumkan importer. Importer membaca sumber sebagai format ini.
bytesstringyaByte sumber utama yang akan diimpor, yang dibaca importer sebagai format yang disebutkan: seluruh file jika sumber impor berupa satu file, dan kosong jika berupa direktori, yang file-filenya datang sebagai sumber bernama. Setiap kit membawanya dalam jenis field-nya sendiri — mentah jika jenis tersebut adalah jenis byte, dienkode base64 jika berupa string yang didekode importer untuk memulihkannya — dan encoder yang dihasilkan mengonversi antara field tersebut dan bentuk yang digunakan wire untuk membawa byte.
namestringtidakNama sumber impor, tanpa direktori di depannya, sehingga importer dapat menyebut sumber tersebut dalam apa yang dilaporkannya dan dalam apa yang didrafkannya. Jika sumbernya satu file, nilainya adalah nama dasar file tersebut: byte utama tidak tiba sebagai sumber bernama, sehingga inilah satu-satunya nama yang dibawanya. Jika sumbernya direktori, nilainya adalah nama dasar direktori, dan file-file direktori tetap tiba sebagai sumber bernama, masing-masing dengan namanya sendiri, dengan byte utama kosong. Tidak ada jika sumber tidak memiliki nama untuk diberikan.
sourcesImportSource[]tidakSumber bernama, masing-masing membawa byte-nya sendiri, dalam satu daftar yang diurutkan berdasarkan nama. Jika sumber impor berupa direktori, terdapat satu sumber untuk setiap file di dalamnya yang dipilih oleh pola file yang dideklarasikan importer, dinamai dengan path-nya yang dipisahkan garis miring di dalam direktori. File yang dideklarasikan oleh lampiran yang mengonfigurasi importer di bawah with.sources juga dibawa di sini, masing-masing dengan nama dasarnya, dan host menolak impor yang di dalamnya sebuah file yang dibaca dari direktori dan salah satu file ini memiliki nama yang sama. Tidak ada jika keduanya tidak menyediakan apa pun.
settingsanytidakDokumen opsi impor opak yang diberikan konsumen untuk perilaku khusus importer. Host meneruskannya tanpa menafsirkannya; importer membaca bentuk apa pun yang didokumentasikannya. Tidak ada jika konsumen tidak memberikan opsi.
catalogCatalogProjectiontidakTampilan Components yang dimuat katalog milik workspace sendiri — katalog tempat importer itu sendiri dipilih — sehingga importer dapat menimbangnya sebagai kandidat saat memetakan node sumber ke entitas katalog. Host membangunnya hanya dari katalog lokal tersebut, dan tampilan ini hanya membawa nama, versi, label, dan struktur yang dideklarasikan: tidak pernah nilai, default, atau secret. Urutannya tetap, sehingga satu katalog menghasilkan satu urutan byte. Tidak ada jika katalog tidak memuat Component.
targetstringtidakKapabilitas penyedia yang menjadi sasaran draf impor, seperti compose atau helm: target yang diberikan kepada impor, atau, untuk impor yang memperbarui impor sebelumnya dan tidak menyebutkan target apa pun, target yang dicatat oleh impor sebelumnya itu. Importer menuliskan apa yang hanya dibutuhkan target itu ke dalam draf sebagai deklarasi, dan menghilangkan apa yang hanya dibutuhkan target lain. Host meneruskannya apa adanya, setelah memeriksa bahwa sebuah Recipe dari katalog workspace terikat padanya. Tidak ada jika impor tidak menyebutkan target.

Properti tambahan tidak diizinkan.

CatalogProjection

Katalog workspace sebagaimana dilihat importer: satu entri untuk setiap Component yang dimuat katalog, masing-masing membawa metadata yang ditimbang importer saat memberi skor pada kandidat.

PropertiJenisWajibDeskripsi
componentsCatalogComponent[]yaSatu entri untuk setiap nama Component yang dimuat katalog, diurutkan berdasarkan nama. Jika katalog memuat beberapa versi dari satu Component, entrinya menjelaskan versi yang dituju oleh referensi yang menyebut Component tanpa versi.

Properti tambahan tidak diizinkan.

CatalogComponent

Satu Component dari katalog workspace: nama dan versinya, labelnya, nama kunci yang dideklarasikan values dan provides-nya, serta socket yang dideklarasikannya untuk dependensinya. Component yang memperluas Component lain membawa apa yang diwarisinya serta apa yang dideklarasikannya sendiri.

PropertiJenisWajibDeskripsi
namestringyaNama Component, sebagaimana dideklarasikan metadata.name-nya — nama yang digunakan Aggregate untuk mereferensikannya.
versionstringyaVersi Component, sebagaimana dideklarasikan metadata.version-nya.
labelsmap of stringtidakLabel Component, sebagai map string-ke-string. Tidak ada jika Component tidak membawa label.
valuesstring[]tidakNama kunci tingkat atas yang dideklarasikan values milik Component, diurutkan. Hanya daftar nama: tidak pernah membawa nilai atau default. Tidak ada jika values-nya tidak mendeklarasikan kunci.
providesstring[]tidakNama kunci tingkat atas yang dideklarasikan provides milik Component, diurutkan. Hanya daftar nama: tidak pernah membawa nilai. Tidak ada jika provides-nya tidak mendeklarasikan kunci.
socketsCatalogSocket[]tidakSocket yang dideklarasikan Component untuk dependensinya, dalam urutan deklarasi: untuk Component yang memperluas Component lain, socket yang diwarisinya muncul lebih dahulu, dalam urutan yang dideklarasikan Component yang diperluas, diikuti socket yang ditambahkannya. Tidak ada jika Component tidak mendeklarasikan socket.

Properti tambahan tidak diizinkan.

CatalogSocket

Satu socket yang dideklarasikan Component katalog untuk dependensinya: nama socket dan pemilih label yang harus dipenuhi dependensi yang dihubungkan melaluinya.

PropertiJenisWajibDeskripsi
namestringyaNama socket, sebagaimana dideklarasikan usesSchema milik Component.
selectorstringyaPemilih label socket, apa adanya, dalam tata bahasa bergaya Kubernetes yang digunakan Component untuk menuliskannya: label yang harus dibawa dependensi yang dihubungkan melalui socket ini.

Properti tambahan tidak diizinkan.

ImportSource

Satu sumber bernama dalam impor multi-file atau direktori: nama yang menunjukkan lokasi sumber dan byte-nya sendiri.

PropertiJenisWajibDeskripsi
namestringyaNama sumber ini dalam impor, seperti path file relatif.
bytesstringyaByte sumber ini. Setiap kit membawanya dalam jenis field-nya sendiri — mentah jika jenis tersebut adalah jenis byte, dienkode base64 jika berupa string yang didekode importer untuk memulihkannya — dan encoder yang dihasilkan mengonversi antara field tersebut dan bentuk yang digunakan wire untuk membawa byte.

Properti tambahan tidak diizinkan.

ImportOutput

Payload yang dikembalikan guest importer: entitas yang dihasilkan impor, keputusan pemetaan di baliknya, diagnostik apa pun yang dimunculkan impor, dan file scaffold apa pun yang dihasilkannya. Setiap field bersifat opsional, sehingga impor yang tidak menyelesaikan apa pun dapat hanya mengembalikan diagnostik.

PropertiJenisWajibDeskripsi
entitiesEmittedEntity[]tidakEntitas yang dihasilkan impor, masing-masing berupa referensi ke entitas katalog yang sudah ada atau badan entitas rancangan. Tidak ada jika impor tidak menghasilkan entitas.
decisionsImportDecision[]tidakKeputusan pemetaan yang dibuat impor, satu untuk setiap node sumber yang diselesaikannya, yang mencatat kandidat yang ditimbangnya dan pilihan yang dibuatnya. Tidak ada jika impor tidak mencatat keputusan.
diagnosticsDiagnostic[]tidakDiagnostik yang dimunculkan impor — misalnya node sumber yang tidak terselesaikan atau pemetaan yang ambigu. Tidak ada jika impor tidak menghasilkan diagnostik.
filesScaffoldFile[]tidakFile scaffold yang dihasilkan impor bersama entitas, seperti aggregate awal atau readme. Tidak ada jika impor tidak menghasilkan file.
errorstringtidakPesan kegagalan yang diisi ketika guest berjalan tetapi tidak dapat menyelesaikan operasi; tidak ada jika berhasil. Ini berbeda dari diagnostik apa pun yang dibawa output: diagnostik melaporkan masalah yang ditemukan selama run yang tetap menghasilkan hasil, sedangkan error melaporkan bahwa operasi itu sendiri tidak selesai. Host menampilkan error yang ada sebagai pemanggilan plugin yang gagal.

Properti tambahan tidak diizinkan.

EmittedEntity

Satu entitas yang dihasilkan impor: jenisnya, namanya, dan cara entitas tersebut dihasilkan — referensi ke entitas katalog yang sudah ada atau badan entitas yang baru dirancang.

PropertiJenisWajibDeskripsi
kindstringyaJenis entitas yang dihasilkan. Importer inti menghasilkan Component, Aggregate, dan Release; pembaca menoleransi jenis lain apa pun.
namestringyaNama entitas yang dihasilkan.
modestring (enum)yaCara entitas dihasilkan: reference menunjuk ke entitas katalog yang sudah ada berdasarkan nama, dan draft membawa badan entitas yang baru dirancang. Nilai yang diizinkan: "reference", "draft"
bodystringtidakBadan YAML mentah dari entitas rancangan. Kosong untuk referensi murni, yang menyebut entitas yang sudah ada alih-alih merancang entitas baru.
labelsmap of stringtidakLabel yang dilampirkan ke entitas yang dihasilkan, sebagai map string-ke-string. Importer inti membiarkannya kosong.
annotationsmap of stringtidakAnotasi yang dilampirkan ke entitas yang dihasilkan, sebagai map string-ke-string. Importer inti membiarkannya kosong.
sourceRefstringtidakReferensi ke node sumber tempat entitas ini dihasilkan, sehingga pembaca dapat menelusuri entitas kembali ke asalnya dalam sumber yang diimpor.
decisionRefstringtidakReferensi ke keputusan pemetaan yang menghasilkan entitas ini, yang menautkannya ke kandidat yang ditimbang dan pilihan yang dibuat.

Properti tambahan tidak diizinkan.

ImportDecision

Satu keputusan pemetaan: node sumber yang diselesaikan importer, entitas katalog kandidat yang dipertimbangkannya, kandidat yang dipilihnya, dan alasan di balik pilihan tersebut.

PropertiJenisWajibDeskripsi
sourceNodeDecisionSourceNodeyaNode sumber yang diselesaikan oleh keputusan ini: node yang dibaca importer dari sumber dan dipetakan ke entitas katalog.
candidatesImportCandidate[]tidakEntitas katalog kandidat yang dipertimbangkan importer untuk node sumber ini, masing-masing dengan skornya dan rincian per sinyal di balik skor tersebut. Tidak ada jika importer tidak mempertimbangkan kandidat apa pun.
chosenDecisionChoicetidakKandidat yang dipilih importer untuk node sumber ini, dan cara importer mengeluarkannya. Tidak ada jika importer tidak membuat pilihan.
rationalestringtidakPenjelasan yang dapat dibaca manusia tentang alasan importer membuat pilihan ini.
swapHintstringtidakPetunjuk yang menjelaskan cara menukar pemetaan yang dipilih dengan alternatif, sehingga pembaca dapat merevisi keputusan tersebut.

Properti tambahan tidak diizinkan.

DecisionSourceNode

Node sumber yang diselesaikan oleh suatu keputusan pemetaan: sebuah pengenal, jenis yang diberikan sumber kepadanya, dan ringkasan parameternya yang dapat dibaca manusia.

PropertiJenisWajibDeskripsi
idstringyaPengenal node sumber di dalam sumber yang diimpor.
typestringyaJenis node sumber sebagaimana sumber menamainya.
paramsSummarystringyaRingkasan parameter node sumber yang dapat dibaca manusia, untuk ditampilkan bersama keputusan.

Properti tambahan tidak diizinkan.

ImportCandidate

Satu entitas katalog kandidat yang dipertimbangkan importer untuk sebuah node sumber: komponen kandidat, skor keseluruhannya, tingkat kecocokan tempat skor itu berada, dan rincian per sinyal di balik skor tersebut.

PropertiJenisWajibDeskripsi
componentNamestringyaNama komponen katalog kandidat.
scorenumberyaSkor kecocokan keseluruhan kandidat, yang diagregasi dari rincian per sinyal.
tierstringyaTingkat kecocokan tempat kandidat berada, yaitu pita kasar atas skor.
signalsCandidateSignalsyaRincian per sinyal di balik skor kandidat.

Properti tambahan tidak diizinkan.

CandidateSignals

Rincian per sinyal di balik skor kandidat: satu kontribusi per sinyal pencocokan. Sebuah objek dengan bidang tetap, sehingga himpunan sinyalnya stabil dan wire-nya deterministik.

PropertiJenisWajibDeskripsi
tablenumberyaKontribusi skor dari sinyal tabel pemetaan.
categorynumberyaKontribusi skor dari sinyal kategori.
domainLabelsnumberyaKontribusi skor dari sinyal label domain.
shapenumberyaKontribusi skor dari sinyal bentuk.
namenumberyaKontribusi skor dari sinyal nama.

Properti tambahan tidak diizinkan.

DecisionChoice

Kandidat yang dipilih oleh suatu keputusan pemetaan: entitas katalog target, cara entitas itu dikeluarkan, dan tingkat kecocokan pilihan tersebut.

PropertiJenisWajibDeskripsi
targetstringyaNama entitas katalog target yang dipilih.
modestringyaCara target yang dipilih dikeluarkan, mencerminkan mode entitas yang dikeluarkan: referensi ke entitas yang sudah ada atau body yang baru dirancang.
tierstringyaTingkat kecocokan target yang dipilih.

Properti tambahan tidak diizinkan.

ScaffoldFile

Satu file scaffold yang dihasilkan impor: path relatif terhadap root output impor dan konten file tersebut.

PropertiJenisWajibDeskripsi
pathstringyaPath file scaffold, relatif terhadap root output impor.
contentstringyaKonten file scaffold.

Properti tambahan tidak diizinkan.