Explanation

These explanatory articles cover the main building blocks of Workshop. To start using Workshop and SDKcraft, it is important to understand how these concepts fit together.

Architecture

Workshop’s architecture combines a set of system components with well-defined runtime behavior to provide container-isolated development environments.

• System components
• Runtime behavior

Workshops and projects

Workshops are development environments, each running in a container, mapping your project to its contained dependencies. In turn, a project is a working directory where multiple workshop definitions can be placed.

• Workshop concepts
• Projects
• Multi-workshop patterns
• Changes, tasks
• workshop (CLI)

SDKs

SDKs are packages of software dependencies that can be installed in workshops to create tailored development environments.

• SDK concepts
• Parts
• Design best practices
• SDKs versus Dockerfiles
• sdk (CLI)
• sdkcraft (CLI)
• workshopctl (CLI)

Interfaces

Interfaces allow communication and resource sharing between a workshop and the host system, as well as between the different SDKs that are part of a workshop.

• Interface concepts
• Camera interface
• Desktop interface
• GPU interface
• Mount interface
• SSH interface
• Tunnel interface

Security considerations

This overview discusses the security aspects of Workshop and SDKcraft, such as isolation, privileges, relevant risks, and interface mechanics. See Security policy.