Skip to content

Commit ccb7ba2

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 961d7a6 commit ccb7ba2

File tree

2 files changed

+44
-38
lines changed

2 files changed

+44
-38
lines changed

‎README.md‎

Lines changed: 28 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131

3232
## Overview
3333

34-
The Kemp Load Balancer Universal Orchestrator extension enables remote management of cryptographic certificates on Kemp Load Balancers. Kemp Load Balancers use certificates to secure HTTP and HTTPS traffic efficiently, ensuring that sensitive data is encrypted during transit. This extension integrates with Keyfactor Command to automate the process of inventorying, adding, and removing certificates within Kemp Load Balancer environments. By leveraging this orchestrator, administrators can easily manage SSL/TLS certificates, ensuring the security and reliability of their load balancing infrastructure.
34+
TODO Overview is a required section
3535

3636

3737

@@ -49,23 +49,17 @@ The Kemp Load Balancer Universal Orchestrator extension is supported by Keyfacto
4949
Before installing the Kemp Load Balancer Universal Orchestrator extension, we recommend that you install [kfutil](https://github.com/Keyfactor/kfutil). Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
5050

5151

52+
TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
53+
5254

5355
## Kemp Certificate Store Type
5456

5557
To use the Kemp Load Balancer Universal Orchestrator extension, you **must** create the Kemp Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
5658

5759

5860

59-
TODO Overview is a required section
60-
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
61-
62-
63-
64-
65-
66-
#### Kemp Requirements
61+
The Kemp Load Balancer Universal Orchestrator extension enables remote management of cryptographic certificates on Kemp Load Balancers. Kemp Load Balancers use certificates to secure HTTP and HTTPS traffic efficiently, ensuring that sensitive data is encrypted during transit. This extension integrates with Keyfactor Command to automate the process of inventorying, adding, and removing certificates within Kemp Load Balancer environments. By leveraging this orchestrator, administrators can easily manage SSL/TLS certificates, ensuring the security and reliability of their load balancing infrastructure.
6762

68-
TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
6963

7064

7165

@@ -204,13 +198,13 @@ the Keyfactor Command Portal
204198
> The above installation steps can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
205199
206200

201+
## Post Installation
207202

208-
## Defining Certificate Stores
203+
TODO Post Installation is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
209204

210205

211-
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
206+
## Defining Certificate Stores
212207

213-
TODO Certificate Store Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
214208

215209

216210
### Store Creation
@@ -294,19 +288,9 @@ Please refer to the **Universal Orchestrator (remote)** usage section ([PAM prov
294288
> The content in this section can be supplemented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
295289

296290

297-
## Discovering Certificate Stores with the Discovery Job
298-
299-
### Kemp Discovery Job
300-
TODO Global Store Type Section is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
301-
302-
303-
TODO Discovery Job Configuration is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
304-
305-
291+
### 🧩 Step-by-Step: Enabling API Access for a User
306292

307-
## 🧩 Step-by-Step: Enabling API Access for a User
308-
309-
### 1. Log in to the Kemp Web UI
293+
#### 1. Log in to the Kemp Web UI
310294
- In your browser, go to:
311295
```
312296
https://<loadmaster-hostname-or-ip>:8443
@@ -315,7 +299,7 @@ TODO Discovery Job Configuration is an optional section. If this section doesn't
315299

316300
---
317301

318-
### 2. Edit the User Permissions
302+
#### 2. Edit the User Permissions
319303
1. In the left-hand menu, navigate to:
320304
```
321305
System Configuration → System Administration → User Management
@@ -331,30 +315,30 @@ These permissions allow the orchestrator to create and manage intermediate and s
331315

332316
---
333317

334-
### 3. Generate and Record the API Key
318+
#### 3. Generate and Record the API Key
335319
1. Scroll down to the **API Keys** section.
336320
2. Click **Generate New APIKey** to create a new key for API authentication.
337321
3. Copy and securely store this key — it will be used in your Keyfactor orchestrator configuration as the **ServerPassword** or **API Key**.
338322
4. You can later use **Delete** to revoke it if needed.
339323

340324
---
341325

342-
### 4. Verify API Access
326+
#### 4. Verify API Access
343327
Use a command line or PowerShell session to verify connectivity:
344328

345-
#### Using curl:
329+
##### Using curl:
346330
```bash
347331
curl -k -H "Authorization: <API_KEY>" https://<loadmaster-ip>:8443/access/list
348332
```
349333

350-
#### Using PowerShell:
334+
##### Using PowerShell:
351335
```powershell
352336
Invoke-RestMethod -Uri "https://<loadmaster-ip>:8443/access/list" -Headers @{ Authorization = "<API_KEY>" } -SkipCertificateCheck
353337
```
354338

355339
If you receive a JSON response, API access is successfully configured.
356340

357-
### ✅ Summary of Required Settings
341+
#### ✅ Summary of Required Settings
358342

359343
| Setting | Location | Value |
360344
|----------|-----------|--------|
@@ -368,14 +352,14 @@ If you receive a JSON response, API access is successfully configured.
368352

369353
---
370354

371-
## Kemp LoadMaster Orchestrator – Behavior Summary
355+
### Kemp LoadMaster Orchestrator – Behavior Summary
372356

373357
This document summarizes the observed behaviors of the **Kemp LoadMaster Orchestrator** integration during SSL and Intermediate Certificate management operations.
374358
It details how the orchestrator interacts with the LoadMaster API, handles overwrite logic, manages bindings, and synchronizes data with Keyfactor Command.
375359

376360
---
377361

378-
### 🧩 Overall Integration Behavior
362+
#### 🧩 Overall Integration Behavior
379363

380364
- The orchestrator communicates with the **Kemp LoadMaster REST API** using the configured **ServerUsername**, **API Key**, and **SSL (HTTPS)** over port 8443.
381365
- Operations are driven by the **Overwrite flag** and **Alias Name** supplied in the job parameters.
@@ -386,7 +370,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw
386370

387371
---
388372

389-
### 🧪 Test Case Behavior Summary
373+
#### 🧪 Test Case Behavior Summary
390374

391375
| # | Case Name | Behavior Summary | Outcome |
392376
|---|------------|------------------|----------|
@@ -404,7 +388,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw
404388

405389
---
406390

407-
### ⚙️ Functional Insights
391+
#### ⚙️ Functional Insights
408392

409393
- **Overwrite Logic:** SSL certificates respect the `Overwrite` flag. Intermediate certificates cannot be overwritten.
410394
- **Binding Awareness:** The orchestrator checks for bound services before delete or replace operations.
@@ -414,7 +398,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw
414398

415399
---
416400

417-
### ✅ Operation Coverage Summary
401+
#### ✅ Operation Coverage Summary
418402

419403
| Operation | Certificate Type | Supported | Notes |
420404
|------------|------------------|------------|--------|
@@ -428,7 +412,7 @@ It details how the orchestrator interacts with the LoadMaster API, handles overw
428412

429413
---
430414

431-
## TEST CASES
415+
### TEST CASES
432416
Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Results|Passed|Screenshots
433417
------------|---------|----------------|--------------|----------|----------------|--------------|------------
434418
1|New Add New Alias SSL Certificates|Will Create a new SSL Certificate|False|TC1|New SSL Certificate with Alias TC1 Created On Kemp LoadMaster|True|![](images/TC1Results.gif)
@@ -441,7 +425,13 @@ Case Number|Case Name|Case Description|Overwrite Flag|Alias Name|Expected Result
441425
8|Replace Alias Intermediate Certificates|You cannot replace intermediate certificates|True|TC8b|Command Failed: Filename already exists|True|![](images/TC8Results.gif)
442426
9|Remove Intermediate Certificates|Intermediate Certificate Will Be Removed|N/A|TC8b|Intermediate Certificate Is Removed From Keyfactor and the LoadMaster|True|![](images/TC9Results.gif)
443427
10|Inventory Intermediate Certificates|Intermediate Certificate Will Be Inventoried|N/A|N/A|Intermediate Certificate Is Inventoried to Keyfactor|True|![](images/TC10Results.gif)
444-
11|Inventory SSL Certificates|SS: Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif)
428+
11|Inventory SSL Certificates|SSL Certificate Will Be Inventoried|N/A|N/A|SSL Certificate Is Inventoried to Keyfactor|True|![](images/TC11Results.gif)
429+
430+
## Discovering Certificate Stores with the Discovery Job
431+
TODO Discovery is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
432+
433+
434+
445435
446436
447437
## License

‎docsource/content.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Overview
2+
3+
TODO Overview is a required section
4+
5+
## Requirements
6+
7+
TODO Requirements is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
8+
9+
## Post Installation
10+
11+
TODO Post Installation is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
12+
13+
## Discovery
14+
15+
TODO Discovery is an optional section. If this section doesn't seem necessary on initial glance, please delete it. Refer to the docs on [Confluence](https://keyfactor.atlassian.net/wiki/x/SAAyHg) for more info
16+

0 commit comments

Comments
 (0)