genesis_bootstrap#
Bootstrap genesis locally
Usage#
Usage: genesis bootstrap [OPTIONS]
Options#
inventory:- Type: text
- Default:
sentinel.unset - Usage:
-i --inventory
Path to the genesis inventory file or directory with inventory.json
profile:- Type: choice
- Default:
small - Usage:
--profile
Profile for the installation.
name:- Type: text
- Default:
genesis-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://repository.genesis-core.tech/ - Usage:
-r --repository
Default element repository
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.
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'. If not set, the first address of the network(--cidr option) will be used.
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
help:- Type: boolean
- Default:
false - Usage:
--help
Show this message and exit.
CLI Help#
Usage: genesis bootstrap [OPTIONS]
Bootstrap genesis locally
╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --inventory -i TEXT Path to the genesis │
│ inventory file or │
│ directory with │
│ inventory.json │
│ --profile [develop|small|medium| Profile for the │
│ large|legacy] installation. [default: │
│ small] │
│ --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 [default: │
│ https://repository.gene │
│ sis-core.tech/] │
│ --admin-password TEXT A password for the │
│ admin user in. If not │
│ provided, the password │
│ will be generated. │
│ --save-admin-password-… TEXT If the option is │
│ specified the admin │
│ password is saved to │
│ the file. Otherwise │
│ it's printed to the │
│ console. │
│ --hyper-connection-uri TEXT Connection URI for the │
│ hypervisor, e.g. │
│ 'qemu+tcp://10.0.0.1/sy │
│ stem' or │
│ 'qemu+ssh://user@10.0.0 │
│ .1/system'. If not set, │
│ the first address of │
│ the network(--cidr │
│ option) will be used. │
│ --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/1af4104 │
│ 1.rom] │
│ --no-start Do not start the stand │
│ after creation │
│ --help Show this message and │
│ exit. │
╰──────────────────────────────────────────────────────────────────────────────╯