https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/Recent content in Configuration Management onHugoenMon, 17 Feb 2025 00:00:00 +0000https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/overview/Mon, 17 Feb 2025 00:00:00 +0000https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/overview/<p><a id="cfg-overview"></a></p> <!--# Overview --> <p>OpenNebula has tens of configuration files, where cloud administrators can fine-tune the behavior of their cloud environment. When carrying out an upgrade to a newer minor OpenNebula version (<code>X.Y</code>), unfortunately all custom changes in configuration files must be migrated to new configuration files. OpenNebula includes a dedicated tool (<code>onecfg</code>) which automates and simplifies the upgrade of configuration files.</p> <p>This Chapter describes how to use the configuration management tool to:</p>https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/Mon, 17 Feb 2025 00:00:00 +0000https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/<p><a id="cfg-usage"></a></p> <!--# Basic Usage --> <p>This section covers <code>onecfg</code> tool subcommands:</p> <ul> <li><a href="https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/#cfg-status">status</a> - Version status</li> <li><a href="https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/#cfg-init">init</a> - Initialize version management state</li> <li><a href="https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/#cfg-validate">validate</a> - Validate current configuration files</li> <li><a href="https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/#cfg-diff">diff</a> - Identify changes in configuration files</li> <li><a href="https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/#cfg-patch">patch</a> - Apply ad-hoc changes (from diff) in configuration files</li> <li><a href="https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/usage/#cfg-upgrade">upgrade</a> - Upgrade configuration files to a new version</li> </ul> <div class="alert alert-info" role="alert"> <div class="alert-heading"> <i class="alert-icon fa-sharp fa-solid fa-circle-info"></i> Important </div> <div class="alert-body"> <p>This command must be always run under privileged user <code>root</code> directly or via <code>sudo</code>. For example:</p>https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/diff_formats/Mon, 17 Feb 2025 00:00:00 +0000https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/diff_formats/<p><a id="cfg-diff-formats"></a></p> <!--# Diff Formats --> <p>The configuration management tool <code>onecfg</code> allows us to compare the configuration files to identify user changes against the OpenNebula distributed files. The result of a comparison, the differential output, describes all the individual changes which were made and which can even be applied again later or on a different machine.</p> <p>The following table shows supported formats by each subcommand:</p> <table> <thead> <tr> <th>Format</th> <th>Description</th> <th><code>onecfg diff</code></th> <th><code>onecfg patch</code></th> </tr> </thead> <tbody> <tr> <td><code>text</code></td> <td>Easy human-readable text</td> <td>YES (default)</td> <td>NO</td> </tr> <tr> <td><code>line</code></td> <td>Single line for one change</td> <td>YES</td> <td>YES (default)</td> </tr> <tr> <td><code>yaml</code></td> <td>Complete change structure</td> <td>YES</td> <td>YES</td> </tr> </tbody> </table> <p>Only <code>line</code> format will be described here in detail, as it’s powerful in achieving even complex changes and easy enough to read or write manually.</p>https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/conflicts/Mon, 17 Feb 2025 00:00:00 +0000https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/conflicts/<p><a id="cfg-conflicts"></a></p> <!--# Troubleshooting --> <p>The configuration files upgrade is a complex process during which many problems may arise. The root cause of all problems are users’ customizations made in the configuration files in places that also change in a newer version. Because the upgrade process tries to apply changes from newer versions to existing files, the tool can be confused when it reaches the incompatibly modified part.</p> <p>In case of a problem, the upgrade process terminates and <strong>leaves the state of configuration files unchanged</strong>. There is no automatic mechanism preconfigured, but the user has to instruct the tool on how to resolve the problem. This is done by specifying <strong>patch modes</strong> globally for the whole process, for a particular file, or for a particular file and (intermediate) version the user is upgrading to.</p>https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/appendix/Mon, 17 Feb 2025 00:00:00 +0000https://docs.opennebula.io/7.2/software/upgrade_process/configuration_management_ee/appendix/<p><a id="cfg-files"></a></p> <!--# Appendix - List of Configuration Files --> <p>The following table describes all configuration files and their type from directories</p> <ul> <li><code>/etc/one/</code></li> <li><code>/var/lib/one/remotes/</code></li> </ul> <p>managed by the <code>onecfg</code> tool:</p> <table> <thead> <tr> <th>Name</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td><code>/etc/one/alertmanager/alertmanager.yml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/auth/ldap_auth.conf</code></td> <td>YAML w/ ordered arrays</td> </tr> <tr> <td><code>/etc/one/auth/saml_auth.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/auth/server_x509_auth.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/auth/x509_auth.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/az_driver.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/az_driver.default</code></td> <td>Plain file (or XML)</td> </tr> <tr> <td><code>/etc/one/cli/*.yaml</code></td> <td>YAML w/ ordered arrays</td> </tr> <tr> <td><code>/etc/one/defaultrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/etc/one/ec2_driver.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/ec2_driver.default</code></td> <td>Plain file (or XML)</td> </tr> <tr> <td><code>/etc/one/ec2query_templates/*.erb</code></td> <td>Plain file (or XML)</td> </tr> <tr> <td><code>/etc/one/econe.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/provision/providers.d-extra/*.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/provision/providers.d/*.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/provision/provision-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/sunstone/*.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/sunstone/*/*.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/sunstone/*/*/*.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/sunstone/profiles/base.template</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/fireedge/sunstone/sunstone-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/guacd</code></td> <td>Shell</td> </tr> <tr> <td><code>/etc/one/hm/hmrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/etc/one/monitord.conf</code></td> <td>oned.conf-like</td> </tr> <tr> <td><code>/etc/one/oned.conf</code></td> <td>oned.conf-like</td> </tr> <tr> <td><code>/etc/one/oneflow-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/onegate-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/onehem-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/packet_driver.default</code></td> <td>Plain file (or XML)</td> </tr> <tr> <td><code>/etc/one/prometheus/prometheus.yml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/prometheus/rules.yml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/sched.conf</code></td> <td>oned.conf-like</td> </tr> <tr> <td><code>/etc/one/schedulers/one_drs.conf</code></td> <td>YAML w/ ordered arrays</td> </tr> <tr> <td><code>/etc/one/schedulers/rank.conf</code></td> <td>oned.conf-like</td> </tr> <tr> <td><code>/etc/one/sunstone-logos.yaml</code></td> <td>YAML w/ ordered arrays</td> </tr> <tr> <td><code>/etc/one/sunstone-server.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/sunstone-views.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/sunstone-views/**/*.yaml</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/tmrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/etc/one/vcenter_driver.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/etc/one/vcenter_driver.default</code></td> <td>Plain file (or XML)</td> </tr> <tr> <td><code>/etc/one/vmm_exec/vmm_exec_kvm.conf</code></td> <td>oned.conf-like</td> </tr> <tr> <td><code>/etc/one/vmm_exec/vmm_exec_vcenter.conf</code></td> <td>oned.conf-like</td> </tr> <tr> <td><code>/etc/one/vmm_exec/vmm_execrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/datastore/ceph/ceph.conf</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/datastore/ceph/ceph.conf</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/datastore/datastore.conf</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/datastore/fs/fs.conf</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/firecracker-probes.d/probe_db.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/kvm-probes.d/forecast.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/kvm-probes.d/guestagent.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/kvm-probes.d/pci.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/kvm-probes.d/probe_db.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/lxc-probes.d/forecast.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/lxc-probes.d/probe_db.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/lxd-probes.d/pci.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/lxd-probes.d/probe_db.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/qemu-probes.d/pci.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/im/qemu-probes.d/probe_db.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/market/http/http.conf</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/onegate-proxy.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/tm/fs_lvm/fs_lvm.conf</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/tm/ssh/sshrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vmm/firecracker/firecrackerrc</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vmm/kvm/kvmrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vmm/lxc/lxcrc</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vmm/lxc/profiles/*</code></td> <td>Plain file (or XML)</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vmm/lxd/lxdrc</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vmm/vcenter/vcenterrc</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/etc/vnm/OpenNebulaNetwork.conf</code></td> <td>YAML</td> </tr> <tr> <td><code>/var/lib/one/remotes/vmm/kvm/kvmrc</code></td> <td>Shell</td> </tr> <tr> <td><code>/var/lib/one/remotes/vnm/OpenNebulaNetwork.conf</code></td> <td>YAML</td> </tr> </tbody> </table>