diff --git a/doc/supported-platforms.md b/doc/supported-platforms.md index 2d705f2f71..eef4eda6db 100644 --- a/doc/supported-platforms.md +++ b/doc/supported-platforms.md @@ -10,6 +10,7 @@ Ignition is currently only supported for the following platforms: * [Packet] - Ignition will read its configuration from the instance userdata. SSH keys are handled by coreos-metadata. * [QEMU] - Ignition will read its configuration from the 'opt/com.coreos/config' key on the QEMU Firmware Configuration Device (available in QEMU 2.4.0 and higher). * [DigitalOcean] - Ignition will read its configuration from the droplet userdata. SSH keys and network configuration are handled by coreos-metadata. +* [zVM] - Ignition will read its configuration from the reader device directly.The vmur program is necessary,which requires the vmcp and vmur kernel module as prerequisite, and the corresponding z/VM virtual unit record devices (in most cases 000c as reader, 000d as punch) must be set online. Ignition is under active development so expect this list to expand in the coming months. diff --git a/internal/distro/distro.go b/internal/distro/distro.go index c839634de0..c9e82abc6b 100644 --- a/internal/distro/distro.go +++ b/internal/distro/distro.go @@ -39,6 +39,8 @@ var ( mdadmCmd = "mdadm" mountCmd = "mount" sgdiskCmd = "sgdisk" + modprobeCmd = "modprobe" + tarCmd = "tar" udevadmCmd = "udevadm" usermodCmd = "usermod" useraddCmd = "useradd" @@ -54,6 +56,11 @@ var ( vfatMkfsCmd = "mkfs.vfat" xfsMkfsCmd = "mkfs.xfs" + //zVM programs + vmurCmd = "vmur" + chccwdevCmd = "chccwdev" + cioIgnoreCmd = "cio_ignore" + // Flags selinuxRelabel = "false" blackboxTesting = "false" @@ -77,6 +84,8 @@ func IdCmd() string { return idCmd } func MdadmCmd() string { return mdadmCmd } func MountCmd() string { return mountCmd } func SgdiskCmd() string { return sgdiskCmd } +func ModprobeCmd() string { return modprobeCmd } +func TarCmd() string { return tarCmd } func UdevadmCmd() string { return udevadmCmd } func UsermodCmd() string { return usermodCmd } func UseraddCmd() string { return useraddCmd } @@ -88,6 +97,10 @@ func SwapMkfsCmd() string { return swapMkfsCmd } func VfatMkfsCmd() string { return vfatMkfsCmd } func XfsMkfsCmd() string { return xfsMkfsCmd } +func VmurCmd() string { return vmurCmd } +func ChccwdevCmd() string { return chccwdevCmd } +func CioIgnoreCmd() string { return cioIgnoreCmd } + func SelinuxRelabel() bool { return bakedStringToBool(selinuxRelabel) } func BlackboxTesting() bool { return bakedStringToBool(blackboxTesting) } func WriteAuthorizedKeysFragment() bool { diff --git a/internal/platform/platform.go b/internal/platform/platform.go index 23a4b86eb1..d8c832efe3 100644 --- a/internal/platform/platform.go +++ b/internal/platform/platform.go @@ -31,6 +31,7 @@ import ( "github.com/coreos/ignition/v2/internal/providers/qemu" "github.com/coreos/ignition/v2/internal/providers/virtualbox" "github.com/coreos/ignition/v2/internal/providers/vmware" + "github.com/coreos/ignition/v2/internal/providers/zvm" "github.com/coreos/ignition/v2/internal/registry" "github.com/coreos/ignition/v2/internal/resource" ) @@ -127,6 +128,10 @@ func init() { name: "metal", fetch: noop.FetchConfig, }) + configs.Register(Config{ + name: "zvm", + fetch: zvm.FetchConfig, + }) } func Get(name string) (config Config, ok bool) { diff --git a/internal/providers/zvm/zvm.go b/internal/providers/zvm/zvm.go new file mode 100644 index 0000000000..ea5763e79a --- /dev/null +++ b/internal/providers/zvm/zvm.go @@ -0,0 +1,105 @@ +// Copyright 2019 Red Hat, Inc. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// The zVM provider fetches a local configuration from the virtual unit +// record devices. + +package zvm + +import ( + "io/ioutil" + "os/exec" + "strings" + + "github.com/coreos/ignition/v2/config/shared/errors" + "github.com/coreos/ignition/v2/config/v3_1_experimental/types" + "github.com/coreos/ignition/v2/internal/distro" + "github.com/coreos/ignition/v2/internal/log" + "github.com/coreos/ignition/v2/internal/providers/util" + "github.com/coreos/ignition/v2/internal/resource" + "github.com/coreos/vcontext/report" +) + +const readerDevice string = "000c" +const configFile string = "config.ign" + +func FetchConfig(f *resource.Fetcher) (types.Config, report.Report, error) { + // Fetch config files directly from reader device. + _, err := f.Logger.LogCmd(exec.Command(distro.ModprobeCmd(), "vmur"), "Loading zVM control program module") + if err != nil { + f.Logger.Err("Couldn't install vmur module: %v", err) + return types.Config{}, report.Report{}, err + } + // Online the reader device. + logger := f.Logger + err = onlineDevice(logger) + if err != nil { + return types.Config{}, report.Report{}, err + } + // Read files from the z/VM reader queue. + readerInfo, err := exec.Command(distro.VmurCmd(), "li").CombinedOutput() + if err != nil { + f.Logger.Err("Can not get reader device: %v", err) + return types.Config{}, report.Report{}, err + } + items := strings.Split(string(readerInfo), "\n") + for _, records := range items { + record := strings.Fields(records) + if len(record) <= 1 || len(record) < 10 { + break + } + spoolid := record[1] + file := record[9] + ftype := record[10] + // Receive the spool file. + if file == "ignition" { + if ftype != "" { + file = record[9] + "." + ftype + } + _, err := f.Logger.LogCmd(exec.Command(distro.VmurCmd(), "re", "-f", spoolid, file), "Receive the spool file") + if err == nil { + f.Logger.Info("using config file at %q", file) + _, err := f.Logger.LogCmd(exec.Command(distro.TarCmd(), "-xzvf", file), "Extract the spool file") + rawConfig, err := ioutil.ReadFile(configFile) + if err != nil { + f.Logger.Err("Couldn't read config %q: %v", file, err) + break + } + return util.ParseConfig(f.Logger, rawConfig) + } else { + return types.Config{}, report.Report{}, err + } + } + } + return types.Config{}, report.Report{}, errors.ErrEmpty +} + +func onlineDevice(logger *log.Logger) error { + _, err := logger.LogCmd(exec.Command(distro.ChccwdevCmd(), "-e", readerDevice), "Brings a Linux device online") + if err != nil { + // If online failed, expose the device firstly. + _, err = logger.LogCmd(exec.Command(distro.CioIgnoreCmd(), "-r", readerDevice), "Expose reader device") + if err != nil { + logger.Err("Couldn't expose reader device %q: %v", readerDevice, err) + return err + } + _, err = logger.LogCmd(exec.Command(distro.ChccwdevCmd(), "-e", readerDevice), "Brings a Linux device online") + if err != nil { + logger.Err("Couldn't online reader device") + return err + } + } + _, err = logger.LogCmd(exec.Command(distro.udevadmCmd(), "settle"), "Settle udev device") + return err +}