exordos_bootstrap#
Bootstrap exordos locally
Usage#
Usage: exordos bootstrap [OPTIONS]
Options#
inventory:- Type: text
- Default:
sentinel.unset - Usage:
-i --inventory
Path to the inventory directory containing inventory.json, or an HTTP(S) URL pointing to an Nginx-served directory. When a URL is given, inventory.json and all referenced artefacts are downloaded and cached under ~/.cache/exordos/
profile:- Type: choice
- Default:
small - Usage:
--profile
Profile for the installation.
root_disk_size:- Type: integer
- Default:
10 - Usage:
--root-disk-size
Root disk size in GB
data_disk_size:- Type: integer
- Default:
10 - Usage:
--data-disk-size
Data disk size in GB
name:- Type: text
- Default:
exordos-core - Usage:
--name
Name of the installation
launch_mode:- Type: choice
- Default:
element - Usage:
-m --launch-mode
Launch mode for start element, core or custom configuration
stand_spec:- Type: path
- Default:
none - Usage:
-s --stand-spec
Additional stand specification for core mode.
cidr:- Type: IPv4Network
- Default:
10.20.0.0/22 - Usage:
--cidr
The main network CIDR
core_ip:- Type: IPv4Address
- Default:
none - Usage:
--core-ip
The IP address for the core VM. If None is provided, second IP address from the main network will be used.
bridge:- Type: text
- Default:
none - Usage:
--bridge
Name of the linux bridge for the main network, it will be created if not set.
boot_cidr:- Type: IPv4Network
- Default:
10.30.0.0/24 - Usage:
--boot-cidr
The bootstrap network CIDR
boot_bridge:- Type: text
- Default:
none - Usage:
--boot-bridge
Name of the linux bridge for the bootstrap network, it will be created if not set.
force:- Type: boolean
- Default:
false - Usage:
-f --force
Rebuild if the output already exists
no_wait:- Type: boolean
- Default:
false - Usage:
--no-wait
Cancel waiting for the installation to start
repository:- Type: text
- Default:
('https://repo.exordos.com/exordos-elements/',) - Usage:
-r --repository
Default element repository (can be specified multiple times)
admin_password:- Type: text
- Default:
none - Usage:
--admin-password
A password for the admin user in. If not provided, the password will be generated.
save_admin_password_file:- Type: text
- Default:
none - Usage:
--save-admin-password-file
If the option is specified the admin password is saved to the file. Otherwise it's printed to the console.
pool_agent_placement:- Type: choice
- Default:
core - Usage:
--pool-agent-placement
Where the pool agent that drives the hypervisor's libvirt runs. 'core' runs it inside core's own services, reaching libvirt over the network (see --hyper-connection-uri). 'local' installs a dedicated universal agent on this host that talks to the local libvirt socket directly (matching exordos compute hypervisors init); --hyper-connection-uri is not supported in this mode.
hyper_connection_uri:- Type: text
- Default: ``
- Usage:
--hyper-connection-uri
Connection URI for the hypervisor, e.g. 'qemu+tcp://10.0.0.1/system' or 'qemu+ssh://user@10.0.0.1/system'. Only used with --pool-agent-placement=core; if not set there, the main network's first address is used (qemu+tcp).
hyper_storage_pool:- Type: text
- Default:
default - Usage:
--hyper-storage-pool
Storage pool for the hypervisor.
hyper_machine_prefix:- Type: text
- Default:
vm- - Usage:
--hyper-machine-prefix
A prefix for new VMs.
hyper_iface_rom_file:- Type: text
- Default:
/usr/share/qemu/1af41041.rom - Usage:
--hyper-iface-rom-file
A path to the custom ROM file of a network interface.
no_start:- Type: boolean
- Default:
false - Usage:
--no-start
Do not start the stand after creation
no_registration:- Type: boolean
- Default:
false - Usage:
--no-registration
Don't register in ecosystem.
disable_telemetry:- Type: boolean
- Default:
false - Usage:
--disable-telemetry
Disable telemetry. Anonymized data only is sent by default.
org_token:- Type: text
- Default:
sentinel.unset - Usage:
--org-token
Organization token, used to register stand in ecosystem
ecosystem_endpoint:- Type: text
- Default:
https://console.genesis-core.tech - Usage:
--ecosystem-endpoint
Ecosystem's endpoint to connect to
realm_spec:- Type: path
- Default:
none - Usage:
--realm-spec
Path to a realm spec file (realm_spec.json) delivered by the exordos ecosystem to managed realm nodes. Provides a pre-assigned realm identity (uuid, secret, tokens), the ecosystem endpoint and the admin password; self-registration is skipped.
download_only:- Type: boolean
- Default:
false - Usage:
--download-only
Only resolve and download the element inventories (populating the local cache), then exit without bootstrapping.
settings:- Type: boolean
- Default:
false - Usage:
--settings
Interactively create a exordos settings file
ssh_public_key:- Type: file
- Default:
sentinel.unset - Usage:
--ssh-public-key
Path to a public SSH key file to inject into the VM after bootstrap. Can be specified multiple times. If not provided, a key pair is generated in ~/.ssh/.
elements:- Type: text
- Default:
sentinel.unset - Usage:
--elements
Elements to install. Can be specified multiple times. Example: --elements empty --elements dbaas
no_update_realm:- Type: boolean
- Default:
false - Usage:
--no-update-realm
Do not update the realm configuration in exordosctl.yaml after bootstrap
agent_name:- Type: text
- Default:
universal_agent - Usage:
--pool-agent-name
Name of the universal agent to run LocalPoolAgentDriver under on this host. The default targets the standard agent (merging in if this host is also a registered compute node). Use a different name to run a separate, dedicated agent instead - required if the standard agent here is already configured for a different core.
help:- Type: boolean
- Default:
false - Usage:
--help
Show this message and exit.
CLI Help#
Usage: exordos bootstrap [OPTIONS]
Bootstrap exordos locally
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --inventory -i TEXT Path to the inventory directory containing inventory.json, or an HTTP(S) URL pointing to an Nginx-served directory. When a URL is given, inventory.json and all referenced artefacts are downloaded and cached under │
│ ~/.cache/exordos/<name>/<version>/. Trailing /inventory.json in the URL is accepted and treated identically to the bare directory URL. A bare version string (e.g. '0.0.6') is expanded automatically to │
│ https://repo.exordos.com/exordos-elements/core/<version>/. Examples: 0.0.6 /path/to/core/0.0.6 https://repository.example.com/exordos-elements/core/0.0.6/ │
│ --profile [develop|small|medium|large|legacy] Profile for the installation. [default: small] │
│ --root-disk-size INTEGER Root disk size in GB [default: 10] │
│ --data-disk-size INTEGER Data disk size in GB [default: 10] │
│ --name TEXT Name of the installation │
│ --launch-mode -m [core|element|custom] Launch mode for start element, core or custom configuration [default: element] │
│ --stand-spec -s PATH Additional stand specification for core mode. │
│ --cidr IPV4NETWORK The main network CIDR [default: 10.20.0.0/22] │
│ --core-ip IPV4ADDRESS The IP address for the core VM. If `None` is provided, second IP address from the main network will be used. │
│ --bridge TEXT Name of the linux bridge for the main network, it will be created if not set. │
│ --boot-cidr IPV4NETWORK The bootstrap network CIDR [default: 10.30.0.0/24] │
│ --boot-bridge TEXT Name of the linux bridge for the bootstrap network, it will be created if not set. │
│ --force -f Rebuild if the output already exists │
│ --no-wait Cancel waiting for the installation to start │
│ --repository -r TEXT Default element repository (can be specified multiple times) [default: https://repo.exordos.com/exordos-elements/] │
│ --admin-password TEXT A password for the admin user in. If not provided, the password will be generated. │
│ --save-admin-password-file TEXT If the option is specified the admin password is saved to the file. Otherwise it's printed to the console. │
│ --pool-agent-placement [core|local] Where the pool agent that drives the hypervisor's libvirt runs. 'core' runs it inside core's own services, reaching libvirt over the network (see --hyper-connection-uri). 'local' installs a dedicated universal agent on this │
│ host that talks to the local libvirt socket directly (matching `exordos compute hypervisors init`); --hyper-connection-uri is not supported in this mode. [default: core] │
│ --hyper-connection-uri TEXT Connection URI for the hypervisor, e.g. 'qemu+tcp://10.0.0.1/system' or 'qemu+ssh://user@10.0.0.1/system'. Only used with --pool-agent-placement=core; if not set there, the main network's first address is used (qemu+tcp). │
│ --hyper-storage-pool TEXT Storage pool for the hypervisor. [default: default] │
│ --hyper-machine-prefix TEXT A prefix for new VMs. [default: vm-] │
│ --hyper-iface-rom-file TEXT A path to the custom ROM file of a network interface. [default: /usr/share/qemu/1af41041.rom] │
│ --no-start Do not start the stand after creation │
│ --no-registration Don't register in ecosystem. │
│ --disable-telemetry Disable telemetry. Anonymized data only is sent by default. │
│ --org-token TEXT Organization token, used to register stand in ecosystem │
│ --ecosystem-endpoint TEXT Ecosystem's endpoint to connect to │
│ --realm-spec PATH Path to a realm spec file (realm_spec.json) delivered by the exordos ecosystem to managed realm nodes. Provides a pre-assigned realm identity (uuid, secret, tokens), the ecosystem endpoint and the admin password; │
│ self-registration is skipped. │
│ --download-only Only resolve and download the element inventories (populating the local cache), then exit without bootstrapping. │
│ --settings Interactively create a exordos settings file │
│ --ssh-public-key FILE Path to a public SSH key file to inject into the VM after bootstrap. Can be specified multiple times. If not provided, a key pair is generated in ~/.ssh/. │
│ --elements TEXT Elements to install. Can be specified multiple times. Example: --elements empty --elements dbaas │
│ --no-update-realm Do not update the realm configuration in exordosctl.yaml after bootstrap │
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯