Skip to content

Commit 4fca821

Browse files
author
Keyfactor
committed
Update generated docs
1 parent 5e6174c commit 4fca821

File tree

1 file changed

+104
-37
lines changed

1 file changed

+104
-37
lines changed

‎README.md‎

Lines changed: 104 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,6 @@ The IBM DataPower Orchestrator allows for the management of certificates in the
3737

3838

3939

40-
### FortiWeb
41-
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
42-
43-
44-
TODO Overview is a required section
45-
4640
## Compatibility
4741

4842
This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later.
@@ -59,41 +53,31 @@ Before installing the DataPower Universal Orchestrator extension, we recommend t
5953

6054
The IBM DataPower Orchestrator allows for the management of certificates in the IBM Datapower platform. Inventory, Add and Remove functions are supported. This integration can add/replace certificates in any domain\directory combination. For example default\pubcert
6155

62-
### FortiWeb Requirements
63-
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
64-
65-
66-
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
67-
68-
69-
70-
71-
## Create the FortiWeb Certificate Store Type
7256

73-
To use the DataPower Universal Orchestrator extension, you **must** create the FortiWeb Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
57+
## Create the DataPower Certificate Store Type
7458

59+
To use the DataPower Universal Orchestrator extension, you **must** create the DataPower Certificate Store Type. This only needs to happen _once_ per Keyfactor Command instance.
7560

76-
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
7761

7862

79-
* **Create FortiWeb using kfutil**:
63+
* **Create DataPower using kfutil**:
8064

8165
```shell
82-
# FortiWeb
83-
kfutil store-types create FortiWeb
66+
# IBM Data Power
67+
kfutil store-types create DataPower
8468
```
8569

86-
* **Create FortiWeb manually in the Command UI**:
87-
<details><summary>Create FortiWeb manually in the Command UI</summary>
70+
* **Create DataPower manually in the Command UI**:
71+
<details><summary>Create DataPower manually in the Command UI</summary>
8872

89-
Create a store type called `FortiWeb` with the attributes in the tables below:
73+
Create a store type called `DataPower` with the attributes in the tables below:
9074

9175
#### Basic Tab
9276
| Attribute | Value | Description |
9377
| --------- | ----- | ----- |
94-
| Name | FortiWeb | Display name for the store type (may be customized) |
95-
| Short Name | FortiWeb | Short display name for the store type |
96-
| Capability | FortiWeb | Store type name orchestrator will register with. Check the box to allow entry of value |
78+
| Name | IBM Data Power | Display name for the store type (may be customized) |
79+
| Short Name | DataPower | Short display name for the store type |
80+
| Capability | DataPower | Store type name orchestrator will register with. Check the box to allow entry of value |
9781
| Supports Add | ✅ Checked | Check the box. Indicates that the Store Type supports Management Add |
9882
| Supports Remove | 🔲 Unchecked | Indicates that the Store Type supports Management Remove |
9983
| Supports Discovery | 🔲 Unchecked | Indicates that the Store Type supports Discovery |
@@ -107,7 +91,7 @@ TODO Global Store Type Section is an optional section. If this section doesn't s
10791

10892
The Basic tab should look like this:
10993

110-
![FortiWeb Basic Tab](docsource/images/FortiWeb-basic-store-type-dialog.png)
94+
![DataPower Basic Tab](docsource/images/DataPower-basic-store-type-dialog.png)
11195

11296
#### Advanced Tab
11397
| Attribute | Value | Description |
@@ -118,7 +102,7 @@ TODO Global Store Type Section is an optional section. If this section doesn't s
118102

119103
The Advanced tab should look like this:
120104

121-
![FortiWeb Advanced Tab](docsource/images/FortiWeb-advanced-store-type-dialog.png)
105+
![DataPower Advanced Tab](docsource/images/DataPower-advanced-store-type-dialog.png)
122106

123107
#### Custom Fields Tab
124108
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
@@ -135,7 +119,7 @@ TODO Global Store Type Section is an optional section. If this section doesn't s
135119

136120
The Custom Fields tab should look like this:
137121

138-
![FortiWeb Custom Fields Tab](docsource/images/FortiWeb-custom-fields-store-type-dialog.png)
122+
![DataPower Custom Fields Tab](docsource/images/DataPower-custom-fields-store-type-dialog.png)
139123

140124

141125

@@ -189,22 +173,105 @@ TODO Global Store Type Section is an optional section. If this section doesn't s
189173
## Defining Certificate Stores
190174
191175
192-
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
193176
194-
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
177+
* **Manually with the Command UI**
195178
179+
<details><summary>Create Certificate Stores manually in the UI</summary>
196180
181+
1. **Navigate to the _Certificate Stores_ page in Keyfactor Command.**
197182
198-
> 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).
183+
Log into Keyfactor Command, toggle the _Locations_ dropdown, and click _Certificate Stores_.
184+
185+
2. **Add a Certificate Store.**
186+
187+
Click the Add button to add a new Certificate Store. Use the table below to populate the **Attributes** in the **Add** form.
188+
| Attribute | Description |
189+
| --------- | ----------- |
190+
| Category | Select "IBM Data Power" or the customized certificate store name from the previous step. |
191+
| Container | Optional container to associate certificate store with. |
192+
| Client Machine | The Client Machine field should contain the IP or Domain name and Port Needed for REST API Access. For SSH Access, Port 22 will be used. |
193+
| Store Path | The Store Path field should always be / unless we later determine there are alternate locations needed. |
194+
| Orchestrator | Select an approved orchestrator capable of managing `DataPower` certificates. Specifically, one with the `DataPower` capability. |
195+
| ServerUsername | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
196+
| ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). |
197+
| ServerUseSsl | Should be true, http is not supported. |
198+
| InventoryBlackList | Comma seperated list of alias values you do not want to inventory from DataPower. |
199+
| Protocol | Comma seperated list of alias values you do not want to inventory from DataPower. |
200+
| PublicCertStoreName | This probably will remain pubcert unless someone changed the default name in DataPower. |
201+
| InventoryPageSize | This determines the page size during the inventory calls. (100 should be fine). |
199202
200203
201-
## Discovering Certificate Stores with the Discovery Job
204+
205+
206+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
202207
203-
### FortiWeb Discovery Job
204-
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
208+
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_.
209+
| Attribute | Description |
210+
| --------- | ----------- |
211+
| ServerUsername | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
212+
| ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). |
213+
214+
215+
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.
216+
217+
> 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.
218+
</details>
219+
205220
221+
</details>
222+
223+
* **Using kfutil**
224+
225+
<details><summary>Create Certificate Stores with kfutil</summary>
226+
227+
1. **Generate a CSV template for the DataPower certificate store**
228+
229+
```shell
230+
kfutil stores import generate-template --store-type-name DataPower --outpath DataPower.csv
231+
```
232+
2. **Populate the generated CSV file**
233+
234+
Open the CSV file, and reference the table below to populate parameters for each **Attribute**.
235+
| Attribute | Description |
236+
| --------- | ----------- |
237+
| Category | Select "IBM Data Power" or the customized certificate store name from the previous step. |
238+
| Container | Optional container to associate certificate store with. |
239+
| Client Machine | The Client Machine field should contain the IP or Domain name and Port Needed for REST API Access. For SSH Access, Port 22 will be used. |
240+
| Store Path | The Store Path field should always be / unless we later determine there are alternate locations needed. |
241+
| Orchestrator | Select an approved orchestrator capable of managing `DataPower` certificates. Specifically, one with the `DataPower` capability. |
242+
| ServerUsername | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
243+
| ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). |
244+
| ServerUseSsl | Should be true, http is not supported. |
245+
| InventoryBlackList | Comma seperated list of alias values you do not want to inventory from DataPower. |
246+
| Protocol | Comma seperated list of alias values you do not want to inventory from DataPower. |
247+
| PublicCertStoreName | This probably will remain pubcert unless someone changed the default name in DataPower. |
248+
| InventoryPageSize | This determines the page size during the inventory calls. (100 should be fine). |
249+
250+
251+
252+
253+
<details><summary>Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator</summary>
254+
255+
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_.
256+
| Attribute | Description |
257+
| --------- | ----------- |
258+
| ServerUsername | Api UserName for DataPower. (or valid PAM key if the username is stored in a KF Command configured PAM integration). |
259+
| ServerPassword | A password for DataPower API access. Used for inventory.(or valid PAM key if the password is stored in a KF Command configured PAM integration). |
260+
261+
262+
> 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.
263+
</details>
264+
265+
266+
3. **Import the CSV file to create the certificate stores**
267+
268+
```shell
269+
kfutil stores import csv --store-type-name DataPower --file DataPower.csv
270+
```
271+
</details>
272+
273+
> 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).
206274
207-
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
208275
209276
210277

0 commit comments

Comments
 (0)