Welcome to Zun’s documentation!

What is Zun?

Zun is an OpenStack Container service. It aims to provide an API service for running application containers without the need to manage servers or clusters.

It requires the following additional OpenStack services for basic function:

• Keystone

• Neutron

• Kuryr-libnetwork

It can also integrate with other services to include:

• Cinder

• Heat

• Glance

For End Users

As an end user of Zun, you’ll use Zun to create and manage containerized workload with either tools or the API directly. All end user (and some administrative) features of Zun are exposed via a REST API, which can be consumed directly. The following resources will help you get started with consuming the API directly.

• API Reference

Alternatively, end users can consume the REST API via various tools or SDKs. These tools are collected below.

• Horizon: The official web UI for the OpenStack Project.

• OpenStack Client: The official CLI for OpenStack Projects.

• Zun Client: The Python client for consuming the Zun’s API.

For Operators

Installation

The detailed install guide for Zun. A functioning Zun will also require having installed Keystone, Neutron, and Kuryr-libnetwork. Please ensure that you follow their install guides first.

• Zun Installation Guide
  • Overview
  • Container service overview
  • Install and configure controller node
  • Install and configure a compute node
  • Verify operation
  • Launch a container
  • Next steps

For Contributors

If you are new to Zun, this should help you quickly setup the development environment and get started.

• Developer Quick-Start
  • Exercising the Services Using Devstack
  • Using the service

There are also a number of technical references on various topics. These are collected below.

• Contributor’s Guide
  • HowTos and Tutorials
  • Documentation Contribution
  • Other Resources

Reference Material

• Zun Command Line Guide
  • zun-status
• Administrator’s Guide
  • Installation & Operations
• Sample Configuration File
  • Zun Configuration Options
  • Policy configuration
• Filter Scheduler
  • Filtering
  • Configuring Filters
  • Writing Your Own Filter
• REST API Version History
  • 1.1
  • 1.2
  • 1.3
  • 1.4
  • 1.5
  • 1.6
  • 1.7
  • 1.8
  • 1.9
  • 1.10
  • 1.11
  • 1.12
  • 1.13
  • 1.14
  • 1.15
  • 1.16
  • 1.17
  • 1.18
  • 1.19
  • 1.20
  • 1.21
  • 1.22
  • 1.23
  • 1.24
  • 1.25
  • 1.26
  • 1.27
  • 1.28
  • 1.29
  • 1.30
  • 1.31
  • 1.32
  • 1.33
  • 1.34
  • 1.35
  • 1.36
  • 1.37

Search

• Zun document search: Search the contents of this document.

• OpenStack wide search: Search the wider set of OpenStack documentation, including forums.