next-hat / nanocl Goto Github PK

Develop, Distribute

Docs • Examples • Discord

Test, Deploy, Scale, Monitor, Orchestrate

Nanocl is an open-source distributed system designed to revolutionize developers' workflows.
It aims to provide an easy solution for localhost development, addressing common issues like CORS and cookies when working with complex microservice architectures.
Nanocl also facilitates seamless deployment to production.
By empowering developers and DevOps professionals, Nanocl helps optimize workflows, enhance security, and reduce operational costs.

Join our discord and help us shape the future of infrastructure management.

• [2024/06/11] Man page, Backup, Remove Orphans and more (release)
• [2024/06/01] We are invited to the Merge Berlin 2024 (event)
• [2024/05/07] Context, SubState and more (release)

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

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

• Overview
• Get Started
• CLI References
• DAEMON References

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

ApiVersion: v0.14

# See all options:
# https://docs.next-hat.com/references/nanocl/objects/cargo
Cargoes:
- Name: doc
  Container:
    Image: ghcr.io/next-hat/documentation:0.14.0

# See all options:
# https://docs.next-hat.com/references/nanocl/objects/resource
Resources:
- Name: docs.next-hat.com
  Kind: ncproxy.io/rule
  Data:
    Rules:
    - Domain: docs.next-hat.com
      Network: Public
      Locations:
      - Path: /
        Target:
          Key: doc.global.c
          Port: 80

To apply a state you can do it easily bu running nanocl state apply -s path|url
You can also remove a state by calling nanocl state rm -s path|url

Below are live demos of Nanocl in action:

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 install and are required to ensure Nanocl functionality:

• nstore to save our state
• ndaemon as REST API to manage everything
• nmetrics to monitor cpu, memory and network usage
• nproxy proxy to redirect traffic to our containers and virtual machines (optional)
• ncproxy to update proxy configuration based on the current state (optional)
• ndns to manage the dns entries for the containers and virtual machines (optional)
• ncdns to update dns entries based on the current state (optional)

Simplified version of our architecture for a single node:

Every contribution is very welcome. Bug reports, feature requests, and pull requests are the most common ways to contribute.

You can also help us by improving the documentation.

Learn how to setup a development environment by reading the contribution guide. Also don't hesitate to join the discord if you have any question!

Sponsors are the ones who make this project possible. They help us to keep the project alive and to improve it. If you want to become a sponsor, you can do so by clicking on the sponsor button.

People that sponsor us will have their name or logo displayed here, and will have access to a special role on our discord server.

If you sponsor for more then 40$ you will be rewarded with a VPS server with nanocl pre-installed ready to use for 1 month.

You can also help us by contributing to the project, by reporting bugs, by suggesting new features, or by improving the documentation.

Or just give a star it's free and it helps us a lot! ⭐️

Huge thanks to our sponsors

Mamaicode

xf10w