|
1 | 1 |  |
2 | 2 |  |
| 3 | + |
3 | 4 |
|
4 | 5 | <p align="center"> |
5 | | -<img height="256" src="logo.svg" alt="exordos core svg logo"> |
| 6 | + <picture> |
| 7 | + <source media="(prefers-color-scheme: dark)" srcset="logo_black.svg"> |
| 8 | + <source media="(prefers-color-scheme: light)" srcset="logo_white.svg"> |
| 9 | + <img height="256" src="logo_white.svg" alt="exordos core svg logo"> |
| 10 | + </picture> |
6 | 11 | </p> |
7 | 12 |
|
8 | | -Welcome to Exordos Core! |
| 13 | +# Exordos Core |
9 | 14 |
|
10 | | -The Exordos Core is an open source software that offers a one turnkey solution to deal with infrastructure at all levels - from bare metal and virtual machines to applications and services. |
| 15 | +**π Documentation:** [exordos.github.io/exordos_core](https://exordos.github.io/exordos_core/) |
11 | 16 |
|
12 | | -Refer to the [wiki](https://github.com/infraguys/exordos_core/wiki) for more detailed information. |
| 17 | +Exordos Core is an open-source NoOps platform for managing corporate infrastructure and software ecosystems. It provides a unified platform layer β from bare metal and virtual machines all the way to applications and services β designed to be operated by both humans and AI agents. |
13 | 18 |
|
14 | | -# π¦ Installation |
| 19 | +## What Exordos Core does |
15 | 20 |
|
16 | | -There are several ways to install Exordos Core and depend on your purpose you can choose one of them. |
| 21 | +Exordos Core is the next step beyond classic DevOps. Instead of a collection of disconnected tools requiring constant manual coordination, it gives your organization a single declarative platform layer where infrastructure, policies, and service lifecycle are managed as one coherent system. |
17 | 22 |
|
18 | | -## Try it out |
| 23 | +Key capabilities: |
19 | 24 |
|
20 | | -If you want to try Exordos Core in a few minutes, download the `all-in-one` [stand](https://github.com/infraguys/gci_dev_all_in_one). It's a ready-to-go virtual machine image with preinstalled Exordos Core and ability to get full functionality such as creating inner(nested) virtual machines, installation elements and many others. |
21 | | -This stand may be used for development purposes as well if you are focusing on a new element development. |
| 25 | +- **Declarative management** β describe the desired state; the platform reconciles reality to match it automatically (self-healing). No more configuration drift or manual correction after every change. |
| 26 | +- **Image-based provisioning** β fast, repeatable, and predictable delivery of environments and services. Rollouts and recovery become straightforward operations, not fire-fighting exercises. |
| 27 | +- **AI-ready architecture** β the platform is designed from the ground up to be controlled by an AI agent, reducing manual toil and letting teams operate at the level of intent rather than low-level steps. |
| 28 | +- **Unified lifecycle management** β infrastructure, internal services, and application lifecycle all managed through a single control plane. One system instead of a zoo of tools. |
| 29 | +- **Sovereign deployment** β run entirely within your own on-prem or private cloud perimeter with no dependency on external services. Full control over data, access, and the operational boundary. |
| 30 | +- **Element ecosystem** β install and manage ready-to-use software elements (databases, messengers, internal services, and more) directly from the platform marketplace, just like an app store for enterprise software. |
22 | 31 |
|
23 | | -## Basic usage |
| 32 | +> **For a full overview of architecture, configuration, and advanced usage, visit the [documentation](https://exordos.github.io/exordos_core/).** |
24 | 33 |
|
25 | | -In a case you would like to run Exordos Core on your own infrastructure, you can use the [basic guide](https://github.com/infraguys/exordos_core/wiki/BasicUsage) for more details. |
| 34 | +# π To start using Exordos |
26 | 35 |
|
27 | | -# π Development |
28 | | - |
29 | | -**Ubuntu:** |
30 | | - |
31 | | -```bash |
32 | | -sudo apt-get install build-essential python3.12-dev python3.12-venv \ |
33 | | - libev-dev libvirt-dev curl |
34 | | -curl -LsSf https://astral.sh/uv/install.sh | sh |
35 | | -source "$HOME"/.local/bin/env |
36 | | -uv tool install tox --with tox-uv |
37 | | -``` |
38 | | - |
39 | | -**Fedora:** |
40 | | - |
41 | | -```bash |
42 | | -sudo dnf install gcc libev-devel libvirt-devel curl |
43 | | -curl -LsSf https://astral.sh/uv/install.sh | sh |
44 | | -source "$HOME"/.local/bin/env |
45 | | -uv tool install tox --with tox-uv |
46 | | -``` |
47 | | - |
48 | | -Initialize virtual environment: |
49 | | - |
50 | | -```bash |
51 | | -tox -e develop |
52 | | -source .tox/develop/bin/activate |
53 | | -``` |
54 | | - |
55 | | -Follow the development guide [here](https://github.com/infraguys/exordos_core/wiki/DevelopmentGuide) for more details. |
56 | | - |
57 | | -# βοΈ Tests |
58 | | - |
59 | | -**NOTE:** Python version 3.12 is supposed to be used, but you can use other versions |
| 36 | +Install the CLI tools with a single command: |
60 | 37 |
|
61 | 38 | ```bash |
62 | | -# Unit tests |
63 | | -tox -e py312 |
64 | | - |
65 | | -# Functional tests |
66 | | -tox -e py312-functional |
| 39 | +curl -fsSL https://repository.genesis-core.tech/install.sh | sudo sh |
67 | 40 | ``` |
68 | 41 |
|
69 | | -## Functional tests environment |
70 | | - |
71 | | -To run functional tests, export the following environment variables: |
72 | | - |
73 | | -```bash |
74 | | -export DATABASE_URI="postgresql://exordos_core:exordos_core@127.0.0.1:5432/exordos_core" |
75 | | -export ADMIN_PASSWORD="admin" |
76 | | -export DEFAULT_CLIENT_SECRET="GenesisCoreSecret" |
77 | | -export GLOBAL_SALT="FOy/2kwwdn0ig1QOq7cestqe" |
78 | | -export HS256_KEY="secret" |
79 | | -``` |
80 | | - |
81 | | -# π Related projects |
82 | | - |
83 | | -- Exordos SDK is a set of tools for developing Exordos elements. You can find it [here](https://github.com/infraguys/gcl_sdk). |
84 | | -- Exordos DevTools it's a set oftools to manager life cycle of genesis projects. You can find it [here](https://github.com/infraguys/genesis_devtools). |
| 42 | +Then follow the instructions in the terminal, or refer to the [documentation](https://exordos.github.io/exordos_core/) for a full setup guide. |
85 | 43 |
|
86 | 44 | # π‘ Contributing |
87 | 45 |
|
|
0 commit comments