Collect logs from agent ramdisk¶
This spec adds support for retrieving the deployment system logs from agent ramdisk.
Currently we do not have any documented mechanism to automatically retrieve the system logs from Bootstrap. Having access to agent ramdisk logs may be highly required especially after deployment failure. Collecting logs on remote server is common deployment thing. There are a lot of proprietary, opensource, standardized technologies that solve this task. Lets walk through linux natively supported:
Syslog: is the standardized protocol for message logging, described in RFC. All distros supports syslog in different implementations
Systemd journal-remote: systemd tool to send/receive journal messages over the network.
The proposed implementations is about adding documentation that helps Operators to build agent ramdisk with collecting logs feature. On top of syslog and systemd journal-remote technologies.
Changes in IPA¶
A new kernel parameter is added
use_syslog(Boolean): Whether IPA should send the logs to syslog or not. Defaults to “False”.
Changes in Ironic¶
New pxe_append parameters are added
use_syslogboolean): Whether IPA should send the logs to syslog or not. Defaults to “False”.
syslog_server(string): IP address or DNS name of syslog server to send system logs to. Defaults to “IP address of ironic-conductor node.” The variable may be used to configure
syslogor any other syslog server implementation.
Changes in agent ramdisk¶
Bootstrap should support remote logging via syslog/systemd. All agent ramdisk
changes are related to logging tool configuration (rsyslogd, syslogd,
journal-remote). The logging service should be started right after
networking service to make sure that we send all logs from OpenStack services.
Collector side (ironic-conductor) we receive messages from
Originator (agent ramdisk) and place the according to local rules.
It may be directory on the
Implement logs collecting mechanism in Ironic and IPA as it described in https://review.opendev.org/323511
Data model impact¶
State Machine Impact¶
REST API impact¶
Client (CLI) impact¶
RPC API impact¶
Driver API impact¶
Nova driver impact¶
Support will be added to ramdisk build tools, such as
and image building scripts under IPA repository to build ramdisks with remote
Other end user impact¶
Other deployer impact¶
Deployer chooses which mechanism for collecting logs should be used. General changes to agent ramdisk described at Changes in agent ramdisk
- Primary assignee:
lucasagomes <firstname.lastname@example.org> vsaienko <email@example.com>
Add documentation that describes how to configure
Collectoron ironic-conductor, and
Originatorin ironic agent ramdisk on top of rsyslogd or syslogd or journal-remote.
Add an examples of building most popular images (coreos, tinyipa) with syslog support. New
dibelement will be added as well.
Collectoron devstack host.
Collecting logs from agent ramdisk will be configured on gate jobs. The directory with logs from agent ramdisk will be archived and available in the jobs artefacts.
Upgrades and Backwards Compatibility¶
Documentation will be provided about how to configure syslog
to receive and store logs from