Skip to content

User guide: document URL overrides in IrSO 0.11 #727

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
metal3-io-bot merged 1 commit into from
Aug 30, 2026
Merged

User guide: document URL overrides in IrSO 0.11 #727

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
66 changes: 64 additions & 2 deletions docs/user-guide/src/irso/external-access.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,33 @@ metadata:
spec:
networking:
externalIP: 192.0.2.42
version: "37.0"
version: "38.0"
```

**WARNING:** the IP address must be accessible from one of the host's NIC as
well as from the BMC. This is because the provisioning ISO is downloaded by the
BMC itself.

Starting with version 0.11, you can also provide separate URL overrides for
Ironic API and its image server:

```yaml
apiVersion: ironic.metal3.io/v1alpha1
kind: Ironic
metadata:
name: ironic
namespace: test-ironic
spec:
networking:
externalCallbackURL: https://proxy.example.com/ironic/api
imageServerExternalURL: https://proxy.example.com/ironic/images
version: "38.0"
```

**NOTE:** this image server is the internal server from which Ironic serves
images to the BMC and to the agent on the machine. It's **not** the server that
hosts user's images.

## Ingress

Starting with version 0.10, IrSO can manage an Ingress route automatically:
Expand All @@ -47,8 +67,50 @@ metadata:
spec:
ingress:
host: myironic.example.com
version: "37.0"
version: "38.0"
```

**WARNING:** the ingress host must be accessible from one of the host's NIC as
well as from the BMC.

Starting with version 0.11, you can also override API URL or image server URL
separately as shown in the previous section.

## Disabling host network

By default, the Ironic pod runs with host networking to ensure that bare-metal
machines can reach its API and its DHCP server. Starting with IrSO 0.11, you
can disable host networking, provided that only virtual media is used. This
feature must be combined with [external IP](#external-ip) or
[ingress](#ingress) to make sure that Ironic API is still accessible by BMCs
and the machines themselves:

```yaml
apiVersion: ironic.metal3.io/v1alpha1
kind: Ironic
metadata:
name: ironic
namespace: test-ironic
spec:
ingress:
host: myironic.example.com
networking:
disableHostNetworking: true
version: "38.0"
```

```yaml
apiVersion: ironic.metal3.io/v1alpha1
kind: Ironic
metadata:
name: ironic
namespace: test-ironic
spec:
networking:
disableHostNetworking: true
externalIP: 192.0.2.42
version: "38.0"
```

**WARNING:** most `networking` fields cannot be set together with
`disableHostNetworking`.
Loading