From 4a8379f48502c893203d9120a6129d1a65383867 Mon Sep 17 00:00:00 2001 From: akondur Date: Wed, 9 Dec 2020 22:25:33 -0800 Subject: [PATCH] Docs fix for pass4Symmkey --- docs/Examples.md | 12 ++++++------ docs/PasswordManagement.md | 16 ++++++++-------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/Examples.md b/docs/Examples.md index 290cf775f..4c865ea20 100644 --- a/docs/Examples.md +++ b/docs/Examples.md @@ -643,7 +643,7 @@ pass4SymmKey for authentication. There are two ways to configure `pass4Symmkey` with an External LM: #### Approach 1 -- Setup the desired plain-text [`pass4Symmkey`](PasswordManagement.md#pass4symmkey) in the global secret object(Note: The `pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object). +- Setup the desired plain-text [`pass4Symmkey`](PasswordManagement.md#pass4Symmkey) in the global secret object(Note: The `pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object). - Setup the same plain-text `pass4SymmKey` in the `[general]` section of your LM's `server.conf` file. #### Approach 2 @@ -662,7 +662,7 @@ There are two ways to configure `pass4Symmkey` with an External LM: ``` $SPLUNK_HOME/bin/splunk show-decrypted --value '$7$Sw0A+wvJdTztMcA2Ge7u435XmpTzPqyaq49kUZqn0yfAgwFpwrArM2JjWJ3mUyf/FyHAnCZkE/U=' ``` -- Setup the above decrypted plain-text [`pass4Symmkey`](PasswordManagement.md#pass4symmkey) in the global secret object(Note: The `pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object) +- Setup the above decrypted plain-text [`pass4Symmkey`](PasswordManagement.md#pass4Symmkey) in the global secret object(Note: The `pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object) ### Configuring license_master_url: @@ -712,7 +712,7 @@ operator & the external indexer cluster, and configure the `splunk.cluster_maste There are two ways to configure `IDXC pass4Symmkey` with an External Indexer Cluster: #### Approach 1 -- Setup the desired plain-text [`IDXC pass4Symmkey`](PasswordManagement.md#idxc-pass4symmkey) in the global secret object(Note: The `IDXC pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object). +- Setup the desired plain-text [`IDXC pass4Symmkey`](PasswordManagement.md#idxc-pass4Symmkey) in the global secret object(Note: The `IDXC pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object). - Setup the same plain-text `IDXC pass4SymmKey` in the `[clustering]` section of your cluster master's and indexers' `server.conf` file. #### Approach 2 @@ -731,7 +731,7 @@ There are two ways to configure `IDXC pass4Symmkey` with an External Indexer Clu ``` $SPLUNK_HOME/bin/splunk show-decrypted --value '$7$Sw0A+wvJdTztMcA2Ge7u435XmpTzPqyaq49kUZqn0yfAgwFpwrArM2JjWJ3mUyf/FyHAnCZkE/U=' ``` -- Setup the above decrypted plain-text [`IDXC pass4Symmkey`](PasswordManagement.md#idxc-pass4symmkey) in the global secret object(Note: The `IDXC pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object) +- Setup the above decrypted plain-text [`IDXC pass4Symmkey`](PasswordManagement.md#idxc-pass4Symmkey) in the global secret object(Note: The `IDXC pass4Symmkey` would be stored in a base64 encoded format). For details see [updating global kubernetes secret object](#updating-global-kubernetes-secret-object) ### Configuring cluster_master_url: @@ -777,8 +777,8 @@ Use the kubectl command to create the global kubernetes secret object: 2. Gather the password values for the secret tokens you want to configure. To see all available secret tokens defined for the global kubernetes secret object, review [password management](PasswordManagement.md#splunk-secret-tokens-in-the-global-secret-object) 3. Create a kubernetes secret object referencing the namespace. Example: splunk-`-secret. -In the example below, we are creating the global kubernetes secret object, defining the default administrator and pass4symmkey tokens, and passing in the values. -`kubectl create secret generic splunk--secret --from-literal='password=' --from-literal='pass4symmkey='` +In the example below, we are creating the global kubernetes secret object, defining the default administrator and pass4Symmkey tokens, and passing in the values. +`kubectl create secret generic splunk--secret --from-literal='password=' --from-literal='pass4Symmkey='` ### Reading global kubernetes secret object diff --git a/docs/PasswordManagement.md b/docs/PasswordManagement.md index adde67004..7a64b638d 100644 --- a/docs/PasswordManagement.md +++ b/docs/PasswordManagement.md @@ -5,9 +5,9 @@ - [Splunk Secret Tokens in the global secret object](#splunk-secret-tokens-in-the-global-secret-object) - [HEC Token](#hec-token) - [Default administrator password](#default-administrator-password) - - [Pass4symmkey](#pass4symmkey) - - [IDXC Pass4symmkey](#idxc-pass4symmkey) - - [SHC Pass4symmkey](#shc-pass4symmkey) + - [pass4Symmkey](#pass4Symmkey) + - [IDXC pass4Symmkey](#idxc-pass4Symmkey) + - [SHC pass4Symmkey](#shc-pass4Symmkey) - [Information for Splunk Enterprise administrator](#information-for-splunk-enterprise-administrator) - [Secrets on Docker Splunk](#secrets-on-docker-splunk) @@ -42,15 +42,15 @@ The configurable Splunk Secret Tokens include: **Key name in global kubernetes secret object**: `password` **Description**: password refers to the default administrator password for Splunk. -#### Pass4symmkey -**Key name in global kubernetes secret object**: `pass4symmkey` -**Description**: pass4symmkey is an authentication token for inter-communication within Splunk Enterprise. +#### pass4Symmkey +**Key name in global kubernetes secret object**: `pass4Symmkey` +**Description**: pass4Symmkey is an authentication token for inter-communication within Splunk Enterprise. -#### IDXC Pass4symmkey +#### IDXC pass4Symmkey **Key name in global kubernetes secret object**: `idxc.secret` **Description**: idxc.secret is an authentication token for inter-communication specifically for indexer clustering in Splunk Enterprise. -#### SHC Pass4symmkey +#### SHC pass4Symmkey **Key name in global kubernetes secret object**: `shc.secret` **Description**: shc.secret is an authentication token for inter-communication specifically for search head clustering in Splunk Enterprise.