kayobe/doc/source/administration/seed.rst

Seed Administration

Deprovisioning The Seed VM

Note

This step will destroy the seed VM and its data volumes.

To deprovision the seed VM:

(kayobe) $ kayobe seed vm deprovision

Updating Packages

It is possible to update packages on the seed host. To update one or more packages:

(kayobe) $ kayobe seed host package update --packages <package1>,<package2>

To update all eligible packages, use *, escaping if necessary:

(kayobe) $ kayobe seed host package update --packages *

To only install updates that have been marked security related:

(kayobe) $ kayobe seed host package update --packages <packages> --security

Note that these commands do not affect packages installed in containers, only those installed on the host.

Examining the Bifrost Container

The seed host runs various services required for a standalone Ironic deployment. These all run in a single bifrost_deploy container.

It can often be helpful to execute a shell in the bifrost container for diagnosing operational issues:

$ docker exec -it bifrost_deploy bash

Services are run via Systemd:

(bifrost_deploy) systemctl

Logs are stored in /var/log/kolla/, which is mounted to the kolla_logs Docker volume.

Accessing the Seed Services

The Ironic API can be accessed via the openstack command line interface:

(bifrost_deploy) $ source env-vars
(bifrost_deploy) $ openstack baremetal node list

Ironic inspector API requires some environment variables to be set:

(bifrost_deploy) $ unset OS_CLOUD
(bifrost_deploy) $ export OS_URL=http://localhost:5050
(bifrost_deploy) $ export OS_TOKEN=fake-token
(bifrost_deploy) $ openstack baremetal introspection list

Backup & Restore

There are two main approaches to backing up and restoring data on the seed. A backup may be taken of the Ironic databases. Alternatively, a Virtual Machine backup may be used if running the seed services in a VM. The former will consume less storage. Virtual Machine backups are not yet covered here, neither is scheduling of backups. Any backup and restore procedure should be tested in advance.

Database Backup & Restore

A backup may be taken of the database, using one of the many tools that exist for backing up MariaDB databases.

A simple approach that should work for the typically modestly sized seed database is mysqldump. The following commands should all be executed on the seed.

Backup

It should be safe to keep services running during the backup, but for maximum safety they may optionally be stopped:

docker exec -it bifrost_deploy \
systemctl stop ironic-api ironic-conductor ironic-inspector

Then, to perform the backup:

docker exec -it bifrost_deploy \
mysqldump --all-databases --single-transaction --routines --triggers > seed-backup.sql

If the services were stopped prior to the backup, start them again:

docker exec -it bifrost_deploy \
systemctl start ironic-api ironic-conductor ironic-inspector

Restore

Prior to restoring the database, the Ironic and Ironic Inspector services should be stopped:

docker exec -it bifrost_deploy \
systemctl stop ironic-api ironic-conductor ironic-inspector

The database may then safely be restored:

docker exec -i bifrost_deploy \
mysql < seed-backup.sql

Finally, start the Ironic and Ironic Inspector services again:

docker exec -it bifrost_deploy \
systemctl start ironic-api ironic-conductor ironic-inspector

Running Commands

It is possible to run a command on the seed host:

(kayobe) $ kayobe seed host command run --command "<command>"

For example:

(kayobe) $ kayobe seed host command run --command "service docker restart"

Commands can also be run on the seed hypervisor host, if one is in use:

(kayobe) $ kayobe seed hypervisor host command run --command "<command>"

To execute the command with root privileges, add the --become argument. Adding the --verbose argument allows the output of the command to be seen.