Nanocl

[](https://github.com/nxthat/nanocl) [](https://github.com/nxthat/nanocl) [](https://discord.gg/WV4Aac8uZg)

[](https://github.com/nxthat/nanocl/actions/workflows/tests.yml) [](https://github.com/nxthat/nanocl/actions/workflows/clippy.yml)

[](https://codecov.io/gh/nxthat/nanocl)

Test, Deploy, Scale, Monitor, Orchestrate

❓ What is Nanocl ?

Nanocl is a distributed system that simplifies the management of containers and virtual machines across multiple hosts also called nodes. With Nanocl, you can efficiently share resources and deploy applications, services, and databases publicly, privately, or under a VPN. Whether you're running a home lab setup or a large enterprise, Nanocl's cutting-edge technology, crafted with precision using Rust, provides unparalleled performance and a small footprint.

📙 Table of Contents

• ❓ What is Nanocl ?
• 📙 Table of Contents
• 🚀 Key Benefits
• 🧿 Architecture
• 📚 Documentation
• 📋 Requirements
• 💾 Installation
• 🔧 Usage
• 👨‍💻 Contributing

🚀 Key Benefits

• Easy deployment and management
• Significantly reduce the delay between writing code and shipping it to production
• Efficiently manage and scale your infrastructure as your needs evolve
• Enhance security by isolating services using namespaces and networks.
• Enjoy peace of mind with automatic backups, zero downtime fail-over, and comprehensive log monitoring
• Enjoy history tracking of your container and virtual machine configuration
• Revert configuration as quickly as pressing a button
• Build an entire CI/CD pipeline, from tests to high-availability production
• Best ideas and practices from the community

🧿 Architecture

Nanocl is designed in a micro services architecture several component are required and they are running as container included the Nanocl Daemon itself. The following components will be installed during nanocl setup and are required to ensure Nanocl functionnality:

• store to save our state
• daemon as REST API to manage everything
• metrics to monitor cpu, memory and network usage
• proxy to redirect traffic to our containers and virtual machines
• ncdproxy to update proxy configuration based on the current state
• dns to manage the dns entries for the containers and virtual machines
• ncddns to update dns entries based on the current state

Simplified version of our architecture for a single node:

📚 Documentation

To learn more about Nanocl, you can take a look at the following resources:

• Overview
• Get Started
• CLI References
• DAEMON References

📋 Requirements

To work properly Nanocl must have theses dependencies installed on the system:

• Docker minimum version 1.41

💾 Installation

To install Nanocl, please refer to our online installation guide.

🔧 Usage

Nanocl is designed to be easy to operate by mostly using state files.
State Files are yaml files that define the state you want.
There is an example used to deploy our documentation:

```yaml ApiVersion: v0.5 Type: Deployment

Namespace: nexthat

See all options:

https://docs.next-hat.com/references/nanocl/cargo

Cargoes: - Name: doc Container: Image: nexthat-doc:0.4.1

See all options:

https://docs.next-hat.com/references/nanocl/resource

Resources: - Name: docs.next-hat.com Kind: ProxyRule Version: v0.1 Config: Watch: - doc.nexthat Rule: Http: Domain: docs.next-hat.com Network: Public Ssl: Certificate: /etc/letsencrypt/live/docs.next-hat.com/fullchain.pem CertificateKey: /etc/letsencrypt/live/docs.next-hat.com/privkey.pem Dhparam: /etc/letsencrypt/ssl-dhparams.pem Includes: - /etc/letsencrypt/options-ssl-nginx.conf Locations: - Path: / Target: Cargo: Key: doc.nexthat Port: 80 ```

To apply a state we can do it easily bu running nanocl state apply -f path|url
We can also revert a state by calling nanocl state revert -f path|url

👨‍💻 Contributing

Every contribution is very welcome.

But to be abble to do so you need a dev environnement right ?
You can learn more about it on the contribution guide.
Also don't hesitate to join the discord if you have any question!