schemas

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 19, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

README

deck JSON Schemas

This directory contains the raw JSON Schema files shipped with deck.

Files

  • deck-workflow.schema.json: top-level workflow schema
  • deck-tooldefinition.schema.json: tool definition manifest schema
  • tools/*.schema.json: typed step schemas

Validation model

  1. Validate the workflow file structure.
  2. Validate each step against the schema for its kind.

For the human-facing reference, read ../docs/step-kinds.md, ../docs/workflow-model.md, and ../docs/workspace-layout.md. Contributor-facing tool-definition details live in ../docs/contributing/tool-definition-schema.md.

Current tool schemas

  • tools/host-check.schema.json: CheckHost (public)
  • tools/cluster-check.schema.json: CheckKubernetesCluster (public)
  • tools/command.schema.json: Command (public)
  • tools/repository.configure.schema.json: ConfigureRepository (public)
  • tools/confirm.schema.json: Confirm (public)
  • tools/file.copy.schema.json: CopyFile (public)
  • tools/symlink.schema.json: CreateSymlink (public)
  • tools/file.download.schema.json: DownloadFile (public)
  • tools/image.download.schema.json: DownloadImage (public)
  • tools/package.download.schema.json: DownloadPackage (public)
  • tools/file.edit.schema.json: EditFile (public)
  • tools/file.edit-json.schema.json: EditJSON (public)
  • tools/file.edit-toml.schema.json: EditTOML (public)
  • tools/file.edit-yaml.schema.json: EditYAML (public)
  • tools/directory.schema.json: EnsureDirectory (public)
  • tools/file.extract-archive.schema.json: ExtractArchive (public)
  • tools/kubeadm.init.schema.json: InitKubeadm (public)
  • tools/input.schema.json: Input (public)
  • tools/package.install-apt.schema.json: InstallAptPackage (public)
  • tools/package.install-dnf.schema.json: InstallDnfPackage (public)
  • tools/package.install.schema.json: InstallPackage (public)
  • tools/kubeadm.join.schema.json: JoinKubeadm (public)
  • tools/kernel-module.schema.json: KernelModule (public)
  • tools/image.load.schema.json: LoadImage (public)
  • tools/service.schema.json: ManageService (public)
  • tools/message.schema.json: Message (public)
  • tools/repository.refresh.schema.json: RefreshRepository (public)
  • tools/kubeadm.reset.schema.json: ResetKubeadm (public)
  • tools/swap.schema.json: Swap (public)
  • tools/sysctl.schema.json: Sysctl (public)
  • tools/kubeadm.upgrade.schema.json: UpgradeKubeadm (public)
  • tools/image.verify.schema.json: VerifyImage (public)
  • tools/wait.command.schema.json: WaitForCommand (public)
  • tools/wait.file-exists.schema.json: WaitForFile (public)
  • tools/wait.file-absent.schema.json: WaitForMissingFile (public)
  • tools/wait.tcp-port-closed.schema.json: WaitForMissingTCPPort (public)
  • tools/wait.service-active.schema.json: WaitForService (public)
  • tools/wait.tcp-port-open.schema.json: WaitForTCPPort (public)
  • tools/containerd.config.schema.json: WriteContainerdConfig (public)
  • tools/containerd.registry-hosts.schema.json: WriteContainerdRegistryHosts (public)
  • tools/file.write.schema.json: WriteFile (public)
  • tools/systemd-unit.schema.json: WriteSystemdUnit (public)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ComponentFragmentSchema

func ComponentFragmentSchema() ([]byte, error)

func ToolDefinitionSchema

func ToolDefinitionSchema() ([]byte, error)

func ToolSchema

func ToolSchema(name string) ([]byte, error)

func ToolSchemaNames

func ToolSchemaNames() ([]string, error)

func WorkflowSchema

func WorkflowSchema() ([]byte, error)

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL