Skip to content

Commit be591a2

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

File tree

2 files changed

+11
-1
lines changed

2 files changed

+11
-1
lines changed

cmd/storesBulkOperations.go

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,12 @@ var storesCreateFromCSVCmd = &cobra.Command{
109109
Long: `Certificate stores: Will parse a CSV and attempt to create a certificate store for each row with the provided parameters.
110110
'store-type-name' OR 'store-type-id' are required.
111111
'file' is the path to the file to be imported.
112-
'resultspath' is where the import results will be written to.`,
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:
114+
- via the --server-username --server-password and --store-password flags
115+
- via environment variables: KFUTIL_CSV_SERVER_USERNAME, KFUTIL_CSV_SERVER_PASSWORD, KFUTIL_CSV_STORE_PASSWORD
116+
- via interactive prompts
117+
`,
113118
RunE: func(cmd *cobra.Command, args []string) error {
114119
// Specific flags
115120
storeTypeName, _ := cmd.Flags().GetString("store-type-name")

docs/kfutil_stores_import_csv.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,11 @@ Certificate stores: Will parse a CSV and attempt to create a certificate store f
88
'store-type-name' OR 'store-type-id' are required.
99
'file' is the path to the file to be imported.
1010
'resultspath' is where the import results will be written to.
11+
*NOTE*: If you do not wish to include credentials in your CSV file they can be provided one of three ways:
12+
13+
- via the --server-username --server-password and --store-password flags
14+
- via environment variables: KFUTIL_CSV_SERVER_USERNAME, KFUTIL_CSV_SERVER_PASSWORD, KFUTIL_CSV_STORE_PASSWORD
15+
- via interactive prompts
1116

1217
```
1318
kfutil stores import 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> [flags]

0 commit comments

Comments
 (0)