*: add some documentation for each module

Dockerfile: install dependency, openssl-devel

Signed-off-by: Allen Bai <abai@redhat.com>

Dockerfile

@@ -2,7 +2,7 @@ FROM registry.access.redhat.com/ubi8/ubi
 WORKDIR /fedora-coreos-pinger
 
 COPY . .
-RUN yum install -y gcc
+RUN yum install -y gcc openssl-devel
 RUN curl https://sh.rustup.rs -sSf | sh -s -- -y -q
 RUN echo "export PATH=\"$HOME/.cargo/bin:$PATH\"" > ~/.bashrc \
     && source ~/.bashrc \

src/agent/full/hardware/lsblk.rs

@@ -1,4 +1,5 @@
-//! Struct for `lsblk --fs --json`
+//! Module for running `lsblk --fs --json`, and storing the
+//! output in the struct LsblkJSON
 use failure::{bail, format_err, Fallible, ResultExt};
 use serde::{Deserialize, Serialize};
 

src/agent/full/hardware/lscpu.rs

@@ -1,4 +1,5 @@
-//! Struct for `lscpu --json`
+//! Module for running `lscpu --json`, and storing the output
+//! in the struct LscpuJSON
 use failure::{bail, format_err, Fallible, ResultExt};
 use serde::{Deserialize, Serialize};
 

src/agent/full/hardware/lsmem.rs

@@ -1,4 +1,5 @@
-//! Struct for `lsmem --json`
+//! Module for running `lsmem --json`, and storing the output
+//! in the struct LsmemJSON
 use failure::{bail, format_err, Fallible, ResultExt};
 use serde::de::{self, Unexpected};
 use serde::{Deserialize, Deserializer, Serialize};

src/agent/full/mod.rs

@@ -1,4 +1,4 @@
-//! Module to collect data under `Full` level
+//! Module to collect data under `full` level
 
 mod container_runtime;
 mod hardware;

src/agent/full/network.rs

@@ -1,4 +1,5 @@
-//! Module to obtain network information from `nmcli device show`
+//! Module to obtain network information from `nmcli device show`,
+//! parse the output, and store the output in a HashMap
 use failure::{bail, format_err, Fallible, ResultExt};
 use std::collections::HashMap;
 

src/agent/minimal/instance_type.rs

@@ -6,6 +6,7 @@ use std::io::Read;
 use std::{fs, io};
 
 /// Read instance type from cloud metadata file created by Afterburn
+/// reference: https://github.com/coreos/afterburn/pull/278
 pub(crate) fn read_instance_type<T>(cmdline_path: T, platform_id: &str) -> Fallible<String>
 where
     T: AsRef<str>,

src/agent/minimal/mod.rs

@@ -1,3 +1,5 @@
+//! Module to collect data under `minimal` level
+
 mod instance_type;
 #[cfg(test)]
 mod mock_tests;

src/agent/mod.rs

@@ -1,4 +1,5 @@
 //! Agent module for level `minimal` and `full`
+
 pub mod full;
 pub mod minimal;