Skip to content

Add BMC feature to foreman-proxy #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evgeni merged 12 commits into from
May 15, 2026
Merged

Add BMC feature to foreman-proxy #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1263c65
Add BMC feature to foreman-proxy
May 4, 2026
2c9f0b6
Add Redfish configurations
May 4, 2026
a331e56
tests
May 5, 2026
9d1c33f
update parameters doc
May 6, 2026
59042b5
refactor tests
May 6, 2026
babe207
don't apply config for only default provider
May 8, 2026
690f9d7
fix tests and enable bmc in CI
May 8, 2026
7e6c784
don't mention ssh
May 11, 2026
cf2c560
Limit default provider to only ipmi implementation
May 12, 2026
97dce2e
rename test
May 12, 2026
34cd628
ruff fixes
May 13, 2026
b9bb58b
test bmc capabilites
May 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,7 @@ jobs:
--add-feature azure-rm \
--add-feature google \
--add-feature remote-execution \
--add-feature bmc \
${{ matrix.iop == 'enabled' && '--add-feature iop' || '' }}
- name: Run tests
run: |
Expand Down
9 changes: 7 additions & 2 deletions docs/user/parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,13 @@ There are multiple use cases from the users perspective that dictate what parame

## Smart Proxy

### Mapped

| Parameter | Description | foreman-installer Parameters |
| --------- | ----------- | ---------------------------- |
| `--bmc-ipmi-implementation` | IPMI implementation to use for BMC | `--foreman-proxy-bmc-default-provider` |
| `--bmc-redfish-verify-ssl` | Verify SSL certificates for Redfish BMC connections | `--foreman-proxy-bmc-redfish-verify-ssl` |

### Undetermined

| Installer Parameter | Description | Module | Puppet Parameter |
Expand Down Expand Up @@ -152,8 +159,6 @@ There are multiple use cases from the users perspective that dictate what parame
| `--foreman-proxy-plugin-remote-execution-script-mode` | | foreman_proxy::plugin::remote_execution_script | mode |
| `--foreman-proxy-plugin-openscap-ansible-module` | | foreman_proxy::plugin::openscap | ansible_module |
| `--foreman-proxy-plugin-openscap-puppet-module` | | foreman_proxy::plugin::openscap | puppet_module |
| `--foreman-proxy-bmc` | | | |
| `--foreman-proxy-bmc-default-provider` | | | |
| `--foreman-proxy-content-enable-ostree` | | | |
| `--foreman-proxy-content-pulpcore-additional-import-paths` | | | |
| `--foreman-proxy-http` | | | |
Expand Down
4 changes: 4 additions & 0 deletions src/features.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,7 @@ iop:
description: iop services
dependencies:
- rh-cloud
bmc:
description: Power management for bare metal hosts (IPMI, Redfish)
foreman_proxy:
plugin_name: bmc
10 changes: 10 additions & 0 deletions src/playbooks/deploy/metadata.obsah.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,16 @@ variables:
type: AbsolutePath
parameter: --certificate-server-ca-certificate
persist: false
foreman_proxy_bmc_ipmi_implementation:
parameter: --bmc-ipmi-implementation
help: IPMI implementation to use for BMC.
choices:
Comment thread
ekohl marked this conversation as resolved.
- freeipmi
Comment thread
evgeni marked this conversation as resolved.
- ipmitool
foreman_proxy_bmc_redfish_verify_ssl:
Comment thread
evgeni marked this conversation as resolved.
parameter: --bmc-redfish-verify-ssl
help: Verify SSL certificates for Redfish BMC connections.
type: Boolean

constraints:
required_together:
Expand Down
4 changes: 4 additions & 0 deletions src/roles/foreman_proxy/defaults/main.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ foreman_proxy_available_features: "{{ [] | available_foreman_proxy_plugins }}"
foreman_proxy_disabled_features: "{{ foreman_proxy_available_features | difference(foreman_proxy_features) }}"

foreman_proxy_foreman_server_url: "https://{{ ansible_facts['fqdn'] }}"

# BMC settings
foreman_proxy_bmc_ipmi_implementation: ipmitool
foreman_proxy_bmc_redfish_verify_ssl: true
4 changes: 4 additions & 0 deletions src/roles/foreman_proxy/templates/settings.d/bmc.yml.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
:enabled: {{ feature_enabled }}
:bmc_default_provider: {{ foreman_proxy_bmc_ipmi_implementation }}
:redfish_verify_ssl: {{ foreman_proxy_bmc_redfish_verify_ssl }}
15 changes: 8 additions & 7 deletions tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
from jinja2 import select_autoescape
from requests.adapters import HTTPAdapter

SSH_CONFIG='./.tmp/ssh-config'
SSH_CONFIG = './.tmp/ssh-config'


def pytest_addoption(parser):
Expand Down Expand Up @@ -206,20 +206,21 @@ def wait_for_metadata_generate(foremanapi):
wait_for_tasks(foremanapi, 'label = Actions::Katello::Repository::MetadataGenerate')


def is_iop_enabled():
def enabled_features():
test_dir = os.path.dirname(os.path.abspath(__file__))
foremanctl_dir = os.path.dirname(test_dir)
params_file = os.path.join(foremanctl_dir, '.var', 'lib', 'foremanctl', 'parameters.yaml')

if os.path.exists(params_file):
with open(params_file, 'r') as f:
params = yaml.safe_load(f)
features = params.get('features', [])
features = yaml.safe_load(f).get('features', [])
if isinstance(features, str):
features = features.split()
return 'iop' in features
return features
return []

return False

def is_iop_enabled():
return 'iop' in enabled_features()
Comment thread
ekohl marked this conversation as resolved.


def pytest_configure(config):
Expand Down
30 changes: 30 additions & 0 deletions tests/foreman_proxy_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,37 @@
import json

import pytest
from conftest import enabled_features

FOREMAN_PROXY_PORT = 8443


def is_bmc_enabled():
return 'bmc' in enabled_features()


def get_proxy_v2_features(server, certificates, server_fqdn):
cmd = server.run(
f"curl --cacert {certificates['server_ca_certificate']} "
f"--cert {certificates['client_certificate']} "
f"--key {certificates['client_key']} "
f"--silent https://{server_fqdn}:{FOREMAN_PROXY_PORT}/v2/features"
)
assert cmd.succeeded, f"Failed to query /v2/features: {cmd.stderr}"
return json.loads(cmd.stdout)


def test_foreman_proxy_features(server, certificates, server_fqdn):
cmd = server.run(f"curl --cacert {certificates['server_ca_certificate']} --silent https://{server_fqdn}:{FOREMAN_PROXY_PORT}/features")
Comment thread
ekohl marked this conversation as resolved.
assert cmd.succeeded
features = json.loads(cmd.stdout)
assert "logs" in features
assert "script" in features
assert "dynflow" in features
if is_bmc_enabled():
assert "bmc" in features
Comment thread
ekohl marked this conversation as resolved.
else:
assert "bmc" not in features


def test_foreman_proxy_service(server):
Expand All @@ -38,3 +58,13 @@ def test_foreman_proxy_client_auth_to_foreman(server, certificates, server_fqdn)
)
assert cmd.succeeded
assert cmd.stdout == '201'


@pytest.mark.skipif("not is_bmc_enabled()")
Comment thread
evgeni marked this conversation as resolved.
Copy link
Copy Markdown
Member

@ekohl ekohl May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theforeman/smoker@1f7fd3a I implemented a mechanism in smoker to dynamically read the plugins. Perhaps for a follow up to implement this for enabled features so you can use:

Suggested change
@pytest.mark.skipif("not is_bmc_enabled()")
@pytest.mark.feature("bmc")

That would provide a much more generic basis for testing features.

Copy link
Copy Markdown
Member

@ekohl ekohl May 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't help myself: #508.

def test_bmc_capabilities(server, certificates, server_fqdn):
features = get_proxy_v2_features(server, certificates, server_fqdn)
assert 'bmc' in features
capabilities = features['bmc'].get('capabilities', [])
assert 'ipmitool' in capabilities
assert 'freeipmi' in capabilities
assert 'redfish' in capabilities