Skip to content

Commit 6f12821

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 0652296 commit 6f12821

File tree

1 file changed

+120
-50
lines changed

1 file changed

+120
-50
lines changed

‎README.md‎

Lines changed: 120 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<b>Related Integrations</b>
2929
</a>
3030
</p>
31-
31+
3232
## Overview
3333

3434
The WinCertStore Orchestrator remotely manages certificates in a Windows Server local machine certificate store. Users are able to determine which store they wish to place certificates in by entering the correct store path. For a complete list of local machine cert stores you can execute the PowerShell command:
@@ -154,13 +154,22 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
154154
<details><summary>Windows Certificate (WinCert)</summary>
155155

156156

157-
* **Create WinCert using kfutil**:
157+
### Using kfutil:
158+
159+
#### Using online definition from GitHub:
160+
This will reach out to GitHub and pull the latest store-type definition
161+
```shell
162+
# Windows Certificate
163+
kfutil store-types create WinCert
164+
```
158165

159-
```shell
160-
# Windows Certificate
161-
kfutil store-types create WinCert
162-
```
166+
#### Offline creation using integration-manifest file:
167+
If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo.
168+
```shell
169+
kfutil store-types create --from-file integration-manifest.json
170+
```
163171

172+
### Manually
164173
* **Create WinCert manually in the Command UI**:
165174
<details><summary>Create WinCert manually in the Command UI</summary>
166175

@@ -231,19 +240,28 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
231240

232241

233242

234-
</details>
243+
235244
</details>
236245

237246
<details><summary>IIS Bound Certificate (IISU)</summary>
238247

239248

240-
* **Create IISU using kfutil**:
249+
### Using kfutil:
241250

242-
```shell
243-
# IIS Bound Certificate
244-
kfutil store-types create IISU
245-
```
251+
#### Using online definition from GitHub:
252+
This will reach out to GitHub and pull the latest store-type definition
253+
```shell
254+
# IIS Bound Certificate
255+
kfutil store-types create IISU
256+
```
246257

258+
#### Offline creation using integration-manifest file:
259+
If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo.
260+
```shell
261+
kfutil store-types create --from-file integration-manifest.json
262+
```
263+
264+
### Manually
247265
* **Create IISU manually in the Command UI**:
248266
<details><summary>Create IISU manually in the Command UI</summary>
249267

@@ -320,19 +338,28 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
320338

321339

322340

323-
</details>
341+
324342
</details>
325343

326344
<details><summary>WinSql (WinSql)</summary>
327345

328346

329-
* **Create WinSql using kfutil**:
347+
### Using kfutil:
348+
349+
#### Using online definition from GitHub:
350+
This will reach out to GitHub and pull the latest store-type definition
351+
```shell
352+
# WinSql
353+
kfutil store-types create WinSql
354+
```
330355

331-
```shell
332-
# WinSql
333-
kfutil store-types create WinSql
334-
```
356+
#### Offline creation using integration-manifest file:
357+
If required, it is possible to create store types from the [integration-manifest.json](./integration-manifest.json) included in this repo.
358+
```shell
359+
kfutil store-types create --from-file integration-manifest.json
360+
```
335361

362+
### Manually
336363
* **Create WinSql manually in the Command UI**:
337364
<details><summary>Create WinSql manually in the Command UI</summary>
338365

@@ -405,7 +432,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
405432

406433

407434

408-
</details>
435+
409436
</details>
410437

411438

@@ -414,6 +441,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
414441
1. **Download the latest Windows Certificate Universal Orchestrator extension from GitHub.**
415442

416443
Navigate to the [Windows Certificate Universal Orchestrator extension GitHub version page](https://github.com/Keyfactor/iis-orchestrator/releases/latest). Refer to the compatibility matrix below to determine whether the `net6.0` or `net8.0` asset should be downloaded. Then, click the corresponding asset to download the zip archive.
444+
417445
| Universal Orchestrator Version | Latest .NET version installed on the Universal Orchestrator server | `rollForward` condition in `Orchestrator.runtimeconfig.json` | `iis-orchestrator` .NET version to download |
418446
| --------- | ----------- | ----------- | ----------- |
419447
| Older than `11.0.0` | | | `net6.0` |
@@ -443,8 +471,14 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
443471
Refer to [Starting/Restarting the Universal Orchestrator service](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/StarttheService.htm).
444472

445473

474+
6. **(optional) PAM Integration**
475+
476+
The Windows Certificate Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.
477+
478+
To configure a PAM provider, [reference the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam) to select an extension, and follow the associated instructions to install it on the Universal Orchestrator (remote).
446479

447-
> The above installation steps can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/InstallingAgents/NetCoreOrchestrator/CustomExtensions.htm?Highlight=extensions).
480+
481+
> 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).
448482
449483

450484

@@ -455,6 +489,8 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
455489
<details><summary>Windows Certificate (WinCert)</summary>
456490

457491

492+
### Store Creation
493+
458494
* **Manually with the Command UI**
459495

460496
<details><summary>Create Certificate Stores manually in the UI</summary>
@@ -466,6 +502,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
466502
2. **Add a Certificate Store.**
467503

468504
Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.
505+
469506
| Attribute | Description |
470507
| --------- | ----------- |
471508
| Category | Select "Windows Certificate" or the customized certificate store name from the previous step. |
@@ -479,12 +516,9 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
479516
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
480517
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
481518
| ServerUseSsl | Determine whether the server uses SSL or not (This field is automatically created) |
482-
483-
484-
485-
486519
</details>
487520

521+
488522
* **Using kfutil**
489523

490524
<details><summary>Create Certificate Stores with kfutil</summary>
@@ -497,6 +531,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
497531
2. **Populate the generated CSV file**
498532

499533
Open the CSV file, and reference the table below to populate parameters for each **Attribute**.
534+
500535
| Attribute | Description |
501536
| --------- | ----------- |
502537
| Category | Select "Windows Certificate" or the customized certificate store name from the previous step. |
@@ -510,25 +545,38 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
510545
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
511546
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
512547
| ServerUseSsl | Determine whether the server uses SSL or not (This field is automatically created) |
513-
514-
515-
516-
517-
3. **Import the CSV file to create the certificate stores**
548+
3. **Import the CSV file to create the certificate stores**
518549

519550
```shell
520551
kfutil stores import csv --store-type-name WinCert --file WinCert.csv
521552
```
553+
554+
* **PAM Provider Eligible Fields**
555+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
556+
557+
If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
558+
559+
| Attribute | Description |
560+
| --------- | ----------- |
561+
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
562+
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
563+
564+
Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
565+
566+
> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
522567
</details>
523568

524-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
569+
570+
> 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).
525571

526572

527573
</details>
528574

529575
<details><summary>IIS Bound Certificate (IISU)</summary>
530576

531577

578+
### Store Creation
579+
532580
* **Manually with the Command UI**
533581

534582
<details><summary>Create Certificate Stores manually in the UI</summary>
@@ -540,6 +588,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
540588
2. **Add a Certificate Store.**
541589

542590
Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.
591+
543592
| Attribute | Description |
544593
| --------- | ----------- |
545594
| Category | Select "IIS Bound Certificate" or the customized certificate store name from the previous step. |
@@ -553,12 +602,9 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
553602
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
554603
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
555604
| ServerUseSsl | Determine whether the server uses SSL or not (This field is automatically created) |
556-
557-
558-
559-
560605
</details>
561606

607+
562608
* **Using kfutil**
563609

564610
<details><summary>Create Certificate Stores with kfutil</summary>
@@ -571,6 +617,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
571617
2. **Populate the generated CSV file**
572618

573619
Open the CSV file, and reference the table below to populate parameters for each **Attribute**.
620+
574621
| Attribute | Description |
575622
| --------- | ----------- |
576623
| Category | Select "IIS Bound Certificate" or the customized certificate store name from the previous step. |
@@ -584,25 +631,38 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
584631
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
585632
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
586633
| ServerUseSsl | Determine whether the server uses SSL or not (This field is automatically created) |
587-
588-
589-
590-
591-
3. **Import the CSV file to create the certificate stores**
634+
3. **Import the CSV file to create the certificate stores**
592635

593636
```shell
594637
kfutil stores import csv --store-type-name IISU --file IISU.csv
595638
```
639+
640+
* **PAM Provider Eligible Fields**
641+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
642+
643+
If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
644+
645+
| Attribute | Description |
646+
| --------- | ----------- |
647+
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
648+
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
649+
650+
Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
651+
652+
> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
596653
</details>
597654

598-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
655+
656+
> 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).
599657

600658

601659
</details>
602660

603661
<details><summary>WinSql (WinSql)</summary>
604662

605663

664+
### Store Creation
665+
606666
* **Manually with the Command UI**
607667

608668
<details><summary>Create Certificate Stores manually in the UI</summary>
@@ -614,6 +674,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
614674
2. **Add a Certificate Store.**
615675

616676
Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.
677+
617678
| Attribute | Description |
618679
| --------- | ----------- |
619680
| Category | Select "WinSql" or the customized certificate store name from the previous step. |
@@ -628,12 +689,9 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
628689
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
629690
| ServerUseSsl | Determine whether the server uses SSL or not (This field is automatically created) |
630691
| RestartService | Boolean value (true or false) indicating whether to restart the SQL Server service after installing the certificate. Example: 'true' to enable service restart after installation. |
631-
632-
633-
634-
635692
</details>
636693

694+
637695
* **Using kfutil**
638696

639697
<details><summary>Create Certificate Stores with kfutil</summary>
@@ -646,6 +704,7 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
646704
2. **Populate the generated CSV file**
647705

648706
Open the CSV file, and reference the table below to populate parameters for each **Attribute**.
707+
649708
| Attribute | Description |
650709
| --------- | ----------- |
651710
| Category | Select "WinSql" or the customized certificate store name from the previous step. |
@@ -660,18 +719,29 @@ The Windows Certificate Universal Orchestrator extension implements 3 Certificat
660719
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
661720
| ServerUseSsl | Determine whether the server uses SSL or not (This field is automatically created) |
662721
| RestartService | Boolean value (true or false) indicating whether to restart the SQL Server service after installing the certificate. Example: 'true' to enable service restart after installation. |
663-
664-
665-
666-
667-
3. **Import the CSV file to create the certificate stores**
722+
3. **Import the CSV file to create the certificate stores**
668723

669724
```shell
670725
kfutil stores import csv --store-type-name WinSql --file WinSql.csv
671726
```
727+
728+
* **PAM Provider Eligible Fields**
729+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
730+
731+
If a PAM provider was installed _on the Universal Orchestrator_ in the [Installation](#Installation) section, the following parameters can be configured for retrieval _on the Universal Orchestrator_.
732+
733+
| Attribute | Description |
734+
| --------- | ----------- |
735+
| ServerUsername | Username used to log into the target server for establishing the WinRM session. Example: 'administrator' or 'domain\username'. |
736+
| ServerPassword | Password corresponding to the Server Username used to log into the target server for establishing the WinRM session. Example: 'P@ssw0rd123'. |
737+
738+
Please refer to the **Universal Orchestrator (remote)** usage section ([PAM providers on the Keyfactor Integration Catalog](https://keyfactor.github.io/integrations-catalog/content/pam)) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
739+
740+
> Any secret can be rendered by a PAM provider _installed on the Keyfactor Command server_. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
672741
</details>
673742

674-
> The content in this section can be supplimented by the [official Command documentation](https://software.keyfactor.com/Core-OnPrem/Current/Content/ReferenceGuide/Certificate%20Stores.htm?Highlight=certificate%20store).
743+
744+
> 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).
675745

676746

677747
</details>

0 commit comments

Comments
 (0)