README
¶
Incus
Incus is a modern, secure and powerful system container and virtual machine manager.
It provides a unified experience for running and managing full Linux systems inside containers or virtual machines. Incus supports images for a large number of Linux distributions (official Ubuntu images and images provided by the community) and is built around a very powerful, yet pretty simple, REST API. Incus scales from one instance on a single machine to a cluster in a full data center rack, making it suitable for running workloads both for development and in production.
Incus allows you to easily set up a system that feels like a small private cloud. You can run any type of workload in an efficient way while keeping your resources optimized.
You should consider using Incus if you want to containerize different environments or run virtual machines, or in general run and manage your infrastructure in a cost-effective way.
You can try Incus online at: https://linuxcontainers.org/incus/try-it/
Project history
Incus, which is named after the Cumulonimbus incus or anvil cloud started as community fork of Canonical's LXD following Canonical's takeover of the LXD project from the Linux Containers community.
The project was then adopted by the Linux Containers community, taking back the spot left empty by LXD's departure.
Incus is a true open source community project, free of any CLA and remains released under the Apache 2.0 license. It's maintained by the same team of developers that first created LXD.
LXD users wishing to migrate to Incus can easily do so through a migration tool called lxd-to-incus.
Get started
See Getting started in the Incus documentation for installation instructions and first steps.
- Release announcements:
https://discuss.linuxcontainers.org/c/news/ - Release tarballs:
https://github.com/lxc/incus/releases/ - Documentation:
https://linuxcontainers.org/incus/docs/main/
Status
| Type | Service | Status |
|---|---|---|
| Tests | GitHub |  |
| Go documentation | Godoc |  |
| Static analysis | GoReport | |
| Translations | Weblate |  |
Security
Consider the following aspects to ensure that your Incus installation is secure:
- Keep your operating system up-to-date and install all available security patches.
- Use only supported Incus versions.
- Restrict access to the Incus daemon and the remote API.
- Do not use privileged containers unless required. If you use privileged containers, put appropriate security measures in place. See the LXC security page for more information.
- Configure your network interfaces to be secure.
See Security for detailed information.
IMPORTANT:
Local access to Incus through the Unix socket always grants full access to Incus. This includes the ability to attach file system paths or devices to any instance as well as tweak the security features on any instance.
Therefore, you should only give such access to users who you'd trust with root access to your system.
Support and community
The following channels are available for you to interact with the Incus community.
Bug reports
You can file bug reports and feature requests at: https://github.com/lxc/incus/issues/new
Community support
Community support is handling at: https://discuss.linuxcontainers.org
Commercial support
Commercial support is currently available from Zabbly for users of their Debian or Ubuntu packages.
Documentation
The official documentation is available at: https://github.com/lxc/incus/tree/main/doc
Contributing
Fixes and new features are greatly appreciated. Make sure to read our contributing guidelines first!
Directories
¶
| Path | Synopsis |
|---|---|
|
Package incus implements a client for the Incus API
|
Package incus implements a client for the Incus API |
|
cmd
|
|
|
incusd
*
|
* |
|
internal
|
|
|
dnsutil
Package dnsutil copied from coredns project https://github.com/coredns/coredns/blob/master/plugin/pkg/dnsutil/reverse.go
|
Package dnsutil copied from coredns project https://github.com/coredns/coredns/blob/master/plugin/pkg/dnsutil/reverse.go |
|
server/db/generate/file
Package file contains helpers to write auto-generated Go source files.
|
Package file contains helpers to write auto-generated Go source files. |
|
server/db/query
Package query implements helpers around database/sql to execute various kinds of very common SQL queries.
|
Package query implements helpers around database/sql to execute various kinds of very common SQL queries. |
|
server/db/schema
Package schema offers utilities to create and maintain a database schema.
|
Package schema offers utilities to create and maintain a database schema. |
|
server/device/nictype
Package nictype is a small package to allow resolving NIC "network" key to "nictype" key.
|
Package nictype is a small package to allow resolving NIC "network" key to "nictype" key. |
|
server/response
Package response contains helpers for rendering HTTP responses.
|
Package response contains helpers for rendering HTTP responses. |
|
shared
|
|
|
api
Package api contains Go structs for all API objects
|
Package api contains Go structs for all API objects |
|
test
|
|