Skip to content

Commit b10de54

Browse files
committed
chore(docs): Update stores import csv top level synopsis with mapping table for credential fields.
Signed-off-by: spbsoluble <1661003+spbsoluble@users.noreply.github.com>
1 parent be591a2 commit b10de54

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+90
-61
lines changed

cmd/storesBulkOperations.go

+19-5
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,25 @@ var importStoresCmd = &cobra.Command{
106106
var storesCreateFromCSVCmd = &cobra.Command{
107107
Use: "csv --file <file name to import> --store-type-id <store type id> --store-type-name <store type name> --results-path <filepath for results> --dry-run <check fields only>",
108108
Short: "Create certificate stores from CSV file.",
109-
Long: `Certificate stores: Will parse a CSV and attempt to create a certificate store for each row with the provided parameters.
110-
'store-type-name' OR 'store-type-id' are required.
111-
'file' is the path to the file to be imported.
112-
'resultspath' is where the import results will be written to.
113-
*NOTE*: If you do not wish to include credentials in your CSV file they can be provided one of three ways:
109+
Long: `Will parse a CSV file and attempt to create a certificate store for each row with the provided parameters.
110+
Any errors encountered will be logged to the <file_name>_results.csv file, under the 'Errors' column.
111+
112+
Required Flags:
113+
- '--store-type-name' OR '--store-type-id'
114+
- '--file' is the path to the file to be imported.
115+
116+
#### Credentials
117+
118+
##### In the CSV file:
119+
120+
| Header | Description |
121+
| --- | --- |
122+
| Properties.ServerUsername | This is equivalent to the 'ServerUsername' field in the Command Certificate Store UI. |
123+
| Properties.ServerPassword | This is equivalent to the 'ServerPassword' field in the Command Certificate Store UI. |
124+
| Password | This is equivalent to the 'StorePassword' field in the Command Certificate Store UI. |
125+
126+
##### Outside CSV file:
127+
If you do not wish to include credentials in your CSV file they can be provided one of three ways:
114128
- via the --server-username --server-password and --store-password flags
115129
- via environment variables: KFUTIL_CSV_SERVER_USERNAME, KFUTIL_CSV_SERVER_PASSWORD, KFUTIL_CSV_STORE_PASSWORD
116130
- via interactive prompts

docs/kfutil.md

+1-1

docs/kfutil_completion.md

+1-1

docs/kfutil_completion_bash.md

+1-1

docs/kfutil_completion_fish.md

+1-1

docs/kfutil_completion_powershell.md

+1-1

docs/kfutil_completion_zsh.md

+1-1

docs/kfutil_containers.md

+1-1

docs/kfutil_containers_get.md

+1-1

docs/kfutil_containers_list.md

+1-1

docs/kfutil_export.md

+1-1

docs/kfutil_helm.md

+1-1

docs/kfutil_helm_uo.md

+1-1

docs/kfutil_import.md

+1-1

docs/kfutil_login.md

+1-1

docs/kfutil_logout.md

+1-1

docs/kfutil_orchs.md

+1-1

docs/kfutil_orchs_approve.md

+1-1

docs/kfutil_orchs_disapprove.md

+1-1

docs/kfutil_orchs_ext.md

+1-1

docs/kfutil_orchs_get.md

+1-1

docs/kfutil_orchs_list.md

+1-1

docs/kfutil_orchs_logs.md

+1-1

docs/kfutil_orchs_reset.md

+1-1

docs/kfutil_pam.md

+1-1

docs/kfutil_pam_create.md

+1-1

docs/kfutil_pam_delete.md

+1-1

docs/kfutil_pam_get.md

+1-1

docs/kfutil_pam_list.md

+1-1

docs/kfutil_pam_types-create.md

+1-1

docs/kfutil_pam_types-list.md

+1-1

docs/kfutil_pam_update.md

+1-1

docs/kfutil_status.md

+1-1

docs/kfutil_store-types.md

+1-1

docs/kfutil_store-types_create.md

+1-1

docs/kfutil_store-types_delete.md

+1-1

docs/kfutil_store-types_get.md

+1-1

docs/kfutil_store-types_list.md

+1-1

docs/kfutil_store-types_templates-fetch.md

+1-1

docs/kfutil_stores.md

+1-1

docs/kfutil_stores_delete.md

+1-1

docs/kfutil_stores_export.md

+1-1

docs/kfutil_stores_get.md

+1-1

docs/kfutil_stores_import.md

+1-1

docs/kfutil_stores_import_csv.md

+21-6

docs/kfutil_stores_import_generate-template.md

+1-1

docs/kfutil_stores_inventory.md

+1-1

docs/kfutil_stores_inventory_add.md

+1-1

docs/kfutil_stores_inventory_remove.md

+1-1

docs/kfutil_stores_inventory_show.md

+1-1

docs/kfutil_stores_list.md

+1-1

docs/kfutil_version.md

+1-1

0 commit comments

Comments
 (0)