Skip to content
Merged
Changes from all commits
Commits
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
68 changes: 68 additions & 0 deletions docs/sec-conductor-onboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ To provide a secure and mutually authenticated onboarding mechanism, the followi

The public certificate and CA certificate are configured on the conductor at the Authority level.

Secure Conductor Onboarding requires the use of an IP SAN (subject alternative name) for routers to securely identify the conductor's identity. This requires that the certificate issued by the CA includes the IP SAN for the conductor, allowing the router to validate the connection to the conductor and securely onboard.

The IP SAN should be incuded under the `authority -> conductor-address` list, which specifies addresses routers should use to reach the conductor.

For an HA conductor, each node must have an separate IP SAN entry.

For additional information about certificates, see [Certificate Requirements and Validation](cert_validation_requirements.md). For details on the IP SAN naming and configuration, see [Issue a `certificate-signing-request`](config_custom_certs.md#issue-a-certificate-signing-request).

## Basic Configuration

The following information are the steps to configure and use Secure Conductor Onboarding. For details about any of the commands and steps, see [How It Works](#how-it-works)
Expand Down Expand Up @@ -103,6 +111,66 @@ Once the Secure Conductor Onboarding workflow is initiated, the router performs

Once the secure SSH tunnels are established, the SCO workflow concludes. All future communication between the router and conductor will occur over port 930.

### Re-Onboarding Workflow

Secure Cloud Onboarding (SCO) re-onboarding may be necessary when a router is factory reset and fails to re-onboard because the conductor identifies it as **already onboarded**. This may also occur in scenarios involving transitions from non-SCO to SCO environments.

1. Rename the asset ID.

`config authority router <router> node <node> asset-id <asset-id>-temp`

The conductor processes the removal of the original asset ID and cleans up the associated content. The asset is then removed from the `show assets` list.

2. Check the show assets command ouptut to verify the original ID is no longer present.

```
admin@node0.Conductor# show assets Spoke1Node0
Mon 2026-08-10 18:29:01 UTC
✔ Retrieving assets...
====================================================
Spoke1Node0
====================================================
Router: Spoke1
Node: node0
Current Version: 7.1.6-7.sts.el9
Platform: OpenStack Nova
Install Type: Image
Status: Synchronized
Conductor Connectivity: Connected
Peer Conductor Connectivity: Connected
Service Status: Running
First Connection Date: 2026-08-03 19:03:19
Time in Status: 2h 34m 41s
Completed in 0.14 seconds
admin@node0.Conductor# show assets Spoke1Node0
Mon 2026-08-10 18:29:06 UTC
✖ Retrieving assets...
% Error: Failed to retrieve assets: Asset id 'Spoke1Node0' does not exist

```

3. Restore the original asset ID.

`config authority router <router> node <node> asset-id <asset-id>`

The conductor is ready for the device to re-onboard. Verify this using `show secure-conductor-onboarding <asset-id>`

```
admin@node0.Conductor# show secure-conductor-onboarding <asset-id>
Mon 2026-08-10 18:43:30 UTC
✔ Retrieving Secure Conductor Onboarding state...
======================================
Secure Conductor Onboarding Detail
======================================
Asset Id: <asset-id>
Auth State: waiting
Last Problem:
Last Attempt Time: —
Number of Attempts: 0
Mode: weak/strong
Completed in 0.01 seconds
```

### Verifying Onboarding Status In The Conductor UI

After SCO is enabled, the conductor GUI **Routers** page displays a **Secure Conductor Onboarding** panel for each node, replacing the legacy asset-id onboarding view. Use this panel to monitor the SCO handshake as it progresses.
Expand Down