Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 2.18 KB

README.md

File metadata and controls

66 lines (50 loc) · 2.18 KB
Raw

ForemanPluginCnames

Add support for CNAMEs to NICs.

Installation

See How_to_Install_a_Plugin for how to install Foreman plugins in general. The following should be sufficient.

  1. Ensure Foreman will load the plugin by adding it to its bundler Gems collection 
    echo 'gem "foreman_cnames"' >~foreman/bundler.d/foreman_cnames.rb
chown foreman: ~foreman/bundler.d/foreman_cnames.rb
  2. Produce the plugin Gem from a recent clone of the source Git repository 
    git clone [email protected]:foreman-plugins/foreman_cnames.git
cd foreman_cnames
gem build foreman_cnames.gemspec
  3. Ensure no old versions of the plugin are installed 
    gem uninstall foreman_cnames --version '>= 0'
  4. Install the newly generated Gem without dependencies, in order to not replace any Gems used by Foreman 
    gem install --ignore-dependencies foreman_cnames-*.gem
/bin/rm foreman_cnames-*.gem # Cleanup to avoid future conflicts
  5. If the plugin is installed for the first time,
  6. Foreman needs a restart with every newly installed Gem 
    foreman-maintain service restart

Usage

Once installed, the management form of network interfaces should show an additional field for adding a list of FQDNs, which Foreman will maintain as CNAMEs.

TODO

Quite a lot...

Contributing

Fork and send a Pull Request. Thanks!

Copyright

Based off ForemanPluginTemplate

Copyright (c) 2024 Xavier Mol

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.