Skip to content

Commit 8dd1817

Browse files
Update thundermgmt.md
1 parent 70f5e28 commit 8dd1817

File tree

1 file changed

+50
-11
lines changed

1 file changed

+50
-11
lines changed

docsource/thundermgmt.md

Lines changed: 50 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -90,21 +90,60 @@ It may be possible to use the A10 device itself as the SCP target location if it
9090

9191
---
9292

93+
#### ThunderMgmt Aliases
94+
95+
In the ThunderMgmt store type, the **alias** determines the filename for certificates stored on the SCP server:
96+
97+
- **Certificate File**: `{alias}.crt` on the SCP server
98+
- **Private Key File**: `{alias}.key` on the SCP server
99+
- **A10 API Reference**: The A10 management interface loads certificates using SCP URLs pointing to these files
100+
101+
##### Example ThunderMgmt Usage
102+
```
103+
Alias: "mgmt-interface-cert"
104+
→ SCP Server Files:
105+
- /home/scpuser/mgmt-interface-cert.crt
106+
- /home/scpuser/mgmt-interface-cert.key
107+
→ A10 API Call:
108+
- Certificate URL: scp://scpuser:[email protected]:/home/scpuser/mgmt-interface-cert.crt
109+
- Key URL: scp://scpuser:[email protected]:/home/scpuser/mgmt-interface-cert.key
110+
```
111+
##### For Alias Names
112+
- Use names that clearly identify the management purpose: `mgmt-interface-2025`
113+
- Ensure filenames are valid for both SCP server filesystem and A10 API calls
114+
- Consider including renewal dates: `mgmt-cert-jan2025`
115+
116+
##### ThunderMgmt File Management
117+
118+
The orchestrator handles file operations as follows:
119+
120+
1. **Add Operation**:
121+
- Uploads `{alias}.crt` and `{alias}.key` to SCP server
122+
- Calls A10 API to load certificate from SCP URLs
123+
- A10 device pulls files directly from SCP server
124+
125+
2. **Remove Operation**:
126+
- Deletes `{alias}.crt` and `{alias}.key` from SCP server
127+
- Does not modify A10 management interface configuration
128+
129+
3. **Replace Operation** (with Overwrite=true):
130+
- Overwrites existing `{alias}.crt` and `{alias}.key` files
131+
- Calls A10 API to reload certificate from same SCP URLs
132+
133+
##### Character Limitations
134+
- **Maximum Length**: 240 characters (enforced by orchestrator)
135+
- **Recommended Characters**: Letters, numbers, hyphens, underscores
136+
- **Avoid**: Special characters that might cause issues in API calls or file operations
137+
138+
##### ThunderMgmt Common Issues
139+
- **File Path Issues**: Ensure SCP user has access to the target directory
140+
- **Invalid Filenames**: Some characters may not be valid for filesystem operations
141+
- **URL Encoding**: Special characters in aliases may require URL encoding in SCP URLs
142+
93143
#### ✅ Summary
94144

95145
This extension coordinates certificate and private key delivery by using SCP as a bridge between orchestrator logic and A10's strict API requirements. It ensures secure and automated deployment for the management interface certificates with minimal manual intervention.
96146

97147

98-
## Certificate Store Configuration
99-
100-
### ⚙️ Configuration Fields
101148

102-
| Name | Display Name | Description | Type | Required |
103-
|-------------------|-------------------------------|--------------------------------------------------------------|--------|----------|
104-
| OrchToScpServerIp | Orch To Scp Server IP | IP from the orchestrator to the SCP Linux server | String ||
105-
| ScpPort | Port Used For SCP | Port used to connect to the SCP server | String ||
106-
| ScpUserName | Username Used For SCP | Username for SCP access on the Linux server | Secret ||
107-
| ScpPassword | Password Used For SCP | Password for SCP access on the Linux server | Secret ||
108-
| A10ToScpServerIp | A10 Device To SCP Server IP | IP used by the A10 device to reach the SCP server (can be private) | String ||
109-
| allowInvalidCert | Allow Invalid Cert on A10 API | If true, allows self-signed/untrusted certs for A10 API access | Bool | ✅ (default: true) |
110149

0 commit comments

Comments
 (0)