Supported Import and Export Formats

Every file format Kanvas accepts on import and produces on export, with detection rules, limits, and what each format keeps.

This page lists exactly what Kanvas accepts and produces. For the steps, see Import and Merge Designs and Export Designs.

Kanvas accepts the extensions .yml, .yaml, .json, .tar, .tar.gz, .tgz, .gz, and .zip. Detection is by content and takes the first match in the order below.

OrderFormatExtensionsDetected whenNotes
1Meshery design.yml .yaml .jsonThe schema version is a supported design versionLossless round trip of a design file export
1Meshery design as OCI image.tar .tgz .tar.gz .zipThe archive’s layers contain a design fileOnly the first design is taken. Other layer files are ignored. No design file means failure.
2Kubernetes manifest.yml .yamlOne or more valid Kubernetes documentsMulti-document files work. Unknown kinds are kept as generic objects.
3Helm chart.tgz .tar.gz .gz .tar .zipA valid packaged chartAn uncompressed .tar is reported as needing gzip. No values overrides.
4Docker Compose.yml .yamlConverts as a Compose fileThe result is Kubernetes components.
5Kustomize.yml .yaml (kustomization), or an archive containing kustomization.yamlThe project buildsArchive must contain every referenced file.

If nothing matches, the import fails and lists why each format was rejected. The interface shows only the generic failure message.

SourceSupportedLimits
Local file in the import dialogYesOne file at a time. No size limit in the client.
Single-file http or https URL in the import dialogYes16 MiB body, 5 redirects, 10 second connect, 30 second request. Internal addresses are refused.
Drag or paste on the canvasYesOne design per file. Images and .txt files become canvas objects, limited to 500 KB on every plan.
Catalog clone or openYesPublic or published designs only.
Files and folders in a repository connected through the GitHub integrationYesOne private design per valid file.
Git clone URL, Helm repository URL, oci:// reference, directory, or pasted textNo
RAR and 7Z archivesNoThe drop check lets them through and the import fails.
OutputKeeps layout, annotations, metadataRe-importableNotes
Design file (YAML)YesYes, losslessDownloads as <design name>.yml.
Design (OCI image)YesYesArchive of an OCI image. Push it with a registry tool.
Kubernetes manifestNoResources onlyPlain Kubernetes YAML.
Helm chartNoResources only.tar.gz chart archive.
Embeddable JavaScript moduleCanvas snapshotNoStatic snapshot for web pages. See Embed Designs.
View as JSONNot applicableNoOperator mode only. Downloads as <view name>.json.

The canvas screenshot (a PNG picture, not a design file) is a separate action. See Canvas Actions. Not available: Docker Compose export, SVG image export, export of an earlier version, and per-format export options. The catalog’s light and dark snapshot images are produced by an automated workflow after publishing and are not user exports.

FormatImportExport
Meshery design (YAML or JSON)YesYes (YAML)
Meshery design (OCI image)YesYes
Kubernetes manifestYesYes
Helm chartYesYes
Docker ComposeYesNo
KustomizeYesNo
JavaScript embedNoYes

Related Reading