You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Rename CLI commands from 'genesis' to 'exo'
- Update configuration files from 'genesis.yaml' to 'exordos.yaml'
- Change repository URLs from 'repository.genesis-core.tech' to 'repository.exordos.com'
- Update element paths from 'genesis-elements' to 'exordos-elements'
- Rename client credentials from 'GenesisCore' to 'ExordosCore'
- Update build profiles from 'genesis_base' to 'exordos_base'
- Change systemd service prefix from 'exo_srv' to 'ec'
- Update domain references from 'genesis-core.tech' to 'exordos.com'
- Rename GitHub repository references from 'genesis_basic' to 'exordos_basic'
- Update devtools reference from 'genesis_devtools' to 'exordos_devtools'
Updated 24 documentation files across docs/ directory.
Copy file name to clipboardExpand all lines: docs/app-developer-guide/build.md
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,32 +1,32 @@
1
1
---
2
-
title: genesis build
2
+
title: exo build
3
3
---
4
4
5
5
## Overview
6
6
7
-
`genesis build`**compiles and packages** your Exordos element into distributable artifacts — images, manifests, and any other resources required for deployment.
7
+
`exo build`**compiles and packages** your Exordos element into distributable artifacts — images, manifests, and any other resources required for deployment.
8
8
9
-
The command reads the **`genesis/genesis.yaml`** file — the main configuration file that transforms your application into a platform element. This file contains the `build` section describing:
9
+
The command reads the **`exordos/exordos.yaml`** file — the main configuration file that transforms your application into a platform element. This file contains the `build` section describing:
10
10
11
11
-**Dependencies** — files, directories or external binary artifacts required for the build
12
12
-**Elements** — a single project can produce multiple elements on output (e.g., separate API and worker services)
13
13
-**Artifacts** — images, binaries, or other build outputs
14
14
15
15
Running the command performs the following steps:
16
16
17
-
1.**Resolve dependencies** — fetches dependencies specified in `genesis.yaml`.
17
+
1.**Resolve dependencies** — fetches dependencies specified in `exordos.yaml`.
18
18
2.**Process manifests** — renders manifest files (supporting raw YAML or Jinja2 templates with built-in variables).
19
-
3.**Build artifacts** — creates images and other build outputs based on the `build` section in `genesis.yaml`.
19
+
3.**Build artifacts** — creates images and other build outputs based on the `build` section in `exordos.yaml`.
20
20
21
21
```bash
22
-
genesis build [OPTIONS] PROJECT_DIR
22
+
exo build [OPTIONS] PROJECT_DIR
23
23
```
24
24
25
25
Key options:
26
26
27
27
| Option | Description |
28
28
|---|---|
29
-
|`-c, --genesis-cfg-file TEXT`| Name of the project configuration file (default: `genesis.yaml`) |
29
+
|`-c, --exordos-cfg-file TEXT`| Name of the project configuration file (default: `exordos.yaml`) |
30
30
|`--build-dir TEXT`| Directory for temporary build artifacts |
31
31
|`--output-dir TEXT`| Directory where final artifacts are stored |
32
32
|`--deps-dir TEXT`| Directory where dependencies are fetched |
@@ -69,48 +69,48 @@ You may need to relogin to apply the changes. Now you are ready to build your el
69
69
From your project directory:
70
70
71
71
```bash
72
-
genesis build .
72
+
exo build .
73
73
```
74
74
75
75
### Rebuild with Force
76
76
77
77
If you need to rebuild even when artifacts already exist:
For advanced deployments, build using the inventory format:
94
94
95
95
```bash
96
-
genesis build --inventory .
96
+
exo build --inventory .
97
97
```
98
98
99
99
---
100
100
101
101
## Build Process
102
102
103
-
The build process creates **VM disk images** that run on the Exordos Core platform. Packer starts a virtual machine from a base OS image, copies all resolved dependencies into it, and executes the provisioning script specified in `genesis.yaml`. This script is typically a Bash script that installs packages, configures services, and prepares the image. Once provisioning completes, the VM shuts down and the resulting disk image is packaged for deployment. This process is configured through the `elements` section in `genesis.yaml` where you define the base profile, provisioning script, output format, and any build overrides.
103
+
The build process creates **VM disk images** that run on the Exordos Core platform. Packer starts a virtual machine from a base OS image, copies all resolved dependencies into it, and executes the provisioning script specified in `exordos.yaml`. This script is typically a Bash script that installs packages, configures services, and prepares the image. Once provisioning completes, the VM shuts down and the resulting disk image is packaged for deployment. This process is configured through the `elements` section in `exordos.yaml` where you define the base profile, provisioning script, output format, and any build overrides.
104
104
105
105
---
106
106
107
107
### Dependencies Resolution
108
108
109
-
Before building, `genesis build` resolves all dependencies declared in the `build.deps` section of `genesis.yaml`. Each dependency specifies a destination path (`dst`) and a source. Dependencies can be local directories, remote artifacts, or optional development resources.
109
+
Before building, `exo build` resolves all dependencies declared in the `build.deps` section of `exordos.yaml`. Each dependency specifies a destination path (`dst`) and a source. Dependencies can be local directories, remote artifacts, or optional development resources.
110
110
111
111
#### Local Project Directory
112
112
113
-
Include another local project or directory into your build. The source path is relative to the `genesis.yaml` file location.
113
+
Include another local project or directory into your build. The source path is relative to the `exordos.yaml` file location.
114
114
115
115
```yaml
116
116
deps:
@@ -134,7 +134,7 @@ Fetch remote resources via HTTP/HTTPS. This is useful for kernel images, boot lo
The `vmlinuz` kernel image is downloaded and placed at the specified destination path before the build continues.
@@ -157,28 +157,28 @@ Here, the SDK is only included if the `LOCAL_GENESIS_SDK_PATH` environment varia
157
157
158
158
### VM Image Build Configuration
159
159
160
-
Each element in the `elements` list of `genesis.yaml` defines how its VM images are built. An element can produce multiple images (for example, different formats or variants). The following parameters control the image creation process:
160
+
Each element in the `elements` list of `exordos.yaml` defines how its VM images are built. An element can produce multiple images (for example, different formats or variants). The following parameters control the image creation process:
161
161
162
162
| Parameter | Description |
163
163
|---|---|
164
164
| `name` | The name of the output image. Used to identify the image in the build output and registry. |
165
165
| `format` | Disk image format. Supported formats: `raw`, `qcow2`, `gz`. The `gz` format is a compressed `raw` image. Can also reference an environment variable like `GEN_IMG_FORMAT_CORE=qcow2`. |
166
-
| `profile` | Base OS image profile to use as the starting point (e.g., `genesis_base`). This determines the initial operating system and pre-installed packages. |
166
+
| `profile` | Base OS image profile to use as the starting point (e.g., `exordos_base`). This determines the initial operating system and pre-installed packages. |
167
167
| `script` | Path to the provisioning script executed inside the VM. This script performs all application-specific setup: installing dependencies, copying files, configuring services. |
168
-
| `override` | Build-time parameter overrides passed to the underlying tool (e.g., Packer). Common uses include increasing `disk_size`, `cpus`, or `memory` for the build VM. When using the `genesis_custom` profile, specify `base_image_url` and `base_image_checksum` here to use any custom image as the base. |
168
+
| `override` | Build-time parameter overrides passed to the underlying tool (e.g., Packer). Common uses include increasing `disk_size`, `cpus`, or `memory` for the build VM. When using the `exordos_custom` profile, specify `base_image_url` and `base_image_checksum` here to use any custom image as the base. |
169
169
| `envs` | List of environment variables to pass into the build process. These become available to the provisioning script and build tools. |
170
170
171
171
#### Using Environment Variables
172
172
173
-
Define variables in `genesis.yaml`:
173
+
Define variables in `exordos.yaml`:
174
174
175
175
```yaml
176
176
elements:
177
177
- manifest: manifests/core.yaml.j2
178
178
images:
179
179
- name: my-app
180
180
format: qcow2
181
-
profile: genesis_base
181
+
profile: exordos_base
182
182
script: install.sh
183
183
envs:
184
184
- APP_PORT=8080
@@ -220,7 +220,7 @@ For Jinja2 templates, the following variables are available by default:
220
220
Additional variables can be passed using `--manifest-var key=value`:
0 commit comments