Ab#72824 #64

leefine02 · 2025-06-30T13:44:50Z

No description provided.

* ab#71127 * Update generated docs --------- Co-authored-by: Lee Fine <lfine@keyfactor.com> Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io>

…strator into ab#72700

* Update generated docs * Ab#71127 (#59) * ab#71127 * Update generated docs --------- Co-authored-by: Lee Fine <lfine@keyfactor.com> Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io> * Update generated docs * ab#72700 * ab#72700 * Update generated docs --------- Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io> Co-authored-by: Lee Fine <lfine@keyfactor.com>

…strator into ab#72824

Ab#72700

Release 1.8.1

# Conflicts: # CHANGELOG.md # README.md # docsource/f5-sl-rest.md

Copilot

Pull Request Overview

This PR introduces a new read-only SSLProfiles entry parameter for F5 SSL certificate stores, updates related documentation, and refactors inventory logic to associate certificates with SSL profiles.

Add the SSLProfiles entry parameter to integration-manifest.json.
Update documentation (*.md) to describe the new parameter, correct store path instructions, and note HA limitations.
Refactor inventory code: introduce F5SSLCertificate models, replace GetSSLProfiles call in Inventory.cs, and enhance F5Client to fetch and attach profile associations.

Reviewed Changes

Copilot reviewed 11 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
integration-manifest.json	Added `SSLProfiles` entry parameter under F5-SL-REST
docsource/f5-ws-rest.md	Added overview paragraph for WS store
docsource/f5-sl-rest.md	Added overview paragraph for SSL Profiles store
docsource/f5-ca-rest.md	Added overview paragraph for CA Bundles store
docsource/content.md	Replaced legacy bullet list with unified overview
README.md	Synced README with new docs and parameter tables
SSLProfile/Inventory.cs	Switched from `GetSSLProfiles(20)` to `GetCertificateEntries(50)`
F5DataModels.cs	Added `F5SSLCertificate` and updated `F5SSLProfile`
F5Client.cs	Implemented certificate pagination and profile mapping
.github/workflows/keyfactor-starter-workflow.yml	Updated workflow version and added Doctool secrets

Comments suppressed due to low confidence (6)

docsource/f5-ws-rest.md:3

[nitpick] Rephrase to avoid double-negative: e.g., "adding a new certificate when none exists is not supported due to F5 limitations."

The F5-WS-REST certificate store type manages the TLS certificate bound to the F5 administration website.  While replacing the existing website certificate is supported, adding a new certificate if one is not already present is not due to F5 limitations.

docsource/f5-sl-rest.md:3

Correct subject–verb agreement: change "Renewals ... is supported" to "Renewals ... are supported".

The F5-SL-REST certificate store type manages F5 Big IP TLS certificates.  Renewals of bound certificates is supported, but adding new bindings for new or replacement certificates is not. This store type **does** track the SSL Profiles a certificate is bound to by way of the SSL Profiles entry parameter.  Inventory jobs will return a comma delimited list of SSL Profile names that each certificate is bound to and return this in the SSLProfiles entry parameter.

docsource/content.md:3

Remove duplicated word: change "orchestrator orchestrator" to just "orchestrator extension".

The f5-rest-orchestrator orchestrator extension manages various types of certificates on a F5 Big IP device (version 15 or later).  TLS certificates, CA bundles, and the TLS certificate bound to the administrative website can all be managed with this integration within the scope described in the sections below.  One important note, this integration DOES NOT manage high availability (HA) failover between primary and secondary nodes.  If syncing between primary and secondary nodes is desired, this must either be handled within your F5 Big IP instance itself, or you can set up a Keyfactor Command certificate store for each node (primary and secondary) and manage each separately.

README.md:91

Fix verb form: change "created" to "create".

`kfutil` is a custom CLI for the Keyfactor Command API and can be used to create certificate store types.

F5Client.cs:96

Logging full Base64 certificate can expose sensitive data; remove or sanitize this trace log.

            LogHandlerCommon.Trace(logger, CertificateStore, $"*** CERT CONTENTS: *** {b64Certificate}");

.github/workflows/keyfactor-starter-workflow.yml:14

Pin the action to a specific version tag or commit SHA instead of the generic screenshots tag to ensure reproducible builds.

    uses: keyfactor/actions/.github/workflows/starter.yml@screenshots

Copilot · 2025-07-07T20:06:42Z

integration-manifest.json

+                      "DependsOn": "",
+                      "DefaultValue": "",
+                      "Options": "",
+                      "Description": "One to many comma delmited F5 SSL Profile names the certificate is bound to"


Fix typo: change "delmited" to "delimited" in the description.

Suggested change

"Description": "One to many comma delmited F5 SSL Profile names the certificate is bound to"

"Description": "One to many comma delimited F5 SSL Profile names the certificate is bound to"

Copilot · 2025-07-07T20:06:42Z

SSLProfile/Inventory.cs

@@ -45,7 +45,7 @@ public override JobResult ProcessJob(InventoryJobConfiguration config, SubmitInv
                ValidateF5Release(logger, JobConfig.CertificateStoreDetails, f5);

                LogHandlerCommon.Debug(logger, JobConfig.CertificateStoreDetails, $"Getting inventory from '{config.CertificateStoreDetails.StorePath}'");
-                inventory = f5.GetSSLProfiles(20);
+                inventory = f5.GetCertificateEntries(50);


[nitpick] Avoid hardcoded page size; consider extracting the literal 50 into a named constant or configuration.

Suggested change

inventory = f5.GetCertificateEntries(50);

inventory = f5.GetCertificateEntries(DefaultPageSize);

Copilot · 2025-07-07T20:06:43Z

F5Client.cs

+                pagedProfiles = REST.Get<F5PagedSSLProfiles>(query);
+            }
+
+            LogHandlerCommon.MethodExit(logger, CertificateStore, "GetCertificateEntries");


Mismatched exit method name: in GetSSLProfiles, the exit log still references GetCertificateEntries.

Suggested change

LogHandlerCommon.MethodExit(logger, CertificateStore, "GetCertificateEntries");

LogHandlerCommon.MethodExit(logger, CertificateStore, "GetSSLProfiles");

…strator into ab#72824

Keyfactor and others added 23 commits June 19, 2025 17:45

Update generated docs

6b5ca37

Ab#71127 (#59)

c356dc2

* ab#71127 * Update generated docs --------- Co-authored-by: Lee Fine <lfine@keyfactor.com> Co-authored-by: Keyfactor <keyfactor@keyfactor.github.io>

Update generated docs

bdfc1fa

ab#72700

1632a44

Merge branch 'ab#72700' of https://github.com/Keyfactor/f5-rest-orche…

9481547

…strator into ab#72700

ab#72700

85becd3

Update generated docs

2571d62

ab#72824

6481e27

Update generated docs

4a2103d

ab#72824

a0e596a

Merge branch 'ab#72824' of https://github.com/Keyfactor/f5-rest-orche…

47ba014

…strator into ab#72824

ab#72824

7a59bf4

Update generated docs

31cc2ed

ab#72824

5ba8fb6

Merge branch 'ab#72824' of https://github.com/Keyfactor/f5-rest-orche…

6a4fd9b

…strator into ab#72824

Update generated docs

cab6c20

chore(docs): trigger doctool

1fc1323

Update generated docs

1cd6ede

Merge pull request #61 from Keyfactor/ab#72700

cceca22

Ab#72700

Merge pull request #65 from Keyfactor/release-1.8

18cff0a

Release 1.8.1

Merge remote-tracking branch 'origin/main' into ab#72824

8d49aad

# Conflicts: # CHANGELOG.md # README.md # docsource/f5-sl-rest.md

chore(docs): Trigger doctool

dd9c324

spbsoluble requested a review from Copilot July 7, 2025 19:58

Update generated docs

bc87b27

This comment was marked as outdated.

Sign in to view

spbsoluble approved these changes Jul 7, 2025

View reviewed changes

spbsoluble requested a review from Copilot July 7, 2025 20:05

Copilot AI reviewed Jul 7, 2025

View reviewed changes

ab#72824

28b977c

Lee Fine and others added 2 commits July 7, 2025 20:23

Merge branch 'ab#72824' of https://github.com/Keyfactor/f5-rest-orche…

d4c4637

…strator into ab#72824

Update generated docs

4760cd8

spbsoluble merged commit 20d70a0 into release-1.9 Jul 24, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Ab#72824 #64

Ab#72824 #64

Uh oh!

leefine02 commented Jun 30, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Copilot AI Jul 7, 2025

Uh oh!

Uh oh!

	"Description": "One to many comma delmited F5 SSL Profile names the certificate is bound to"
	"Description": "One to many comma delimited F5 SSL Profile names the certificate is bound to"

	inventory = f5.GetCertificateEntries(50);
	inventory = f5.GetCertificateEntries(DefaultPageSize);

	LogHandlerCommon.MethodExit(logger, CertificateStore, "GetCertificateEntries");
	LogHandlerCommon.MethodExit(logger, CertificateStore, "GetSSLProfiles");

Ab#72824 #64

Ab#72824 #64

Uh oh!

Conversation

leefine02 commented Jun 30, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!