Skip to content

Commit 44939c3

Browse files
authored
Update README.md
1 parent 0e1022c commit 44939c3

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ The following assumptions are made:
6363
- git is accessible on the command line, this has been tested on Linux & Windows with git for Windows installed
6464
- git is using an SSH-based URL and the remote git repository allows the machine running the SplunkVersionControl application to remotely access the repository without a username/password prompt (i.e. SSH keys are in use)
6565
- git will work from the user running the Splunk process over SSH, note that on Windows this will be the system account by default, on Linux the splunk user
66+
- the git repository is dedicated to this particular backup as the root / top level of the git repo will be used to create backups
6667

6768
## Do the modular input backup and restore tasks need to be on the same Splunk instance?
6869
No. However, the backup/restore modular input must have access to its own git temporary directory on the OS filesystem, the temporary directory should be unique for both backup and restore operations
@@ -117,6 +118,7 @@ Or the internal index which also has these log files with the sourcetype splunkv
117118
- If you are running the newer `splunkversioncontrol_restore_dynamic` dashboard the macros `splunk_vc_name`, `splunk_vc_url`, `splunk_vc_timeout` may need customisation to match your environment. In particular the `splunk_vc_name` assumes you have called your SplunkVersionControlRestore modular input "Prod". See the macros section of this document for more information
118119
- Ensure the directory where the git repository will be cloned to is empty (i.e. the git clone can create it)
119120
- Ensure the git repository has at least 1 commit (i.e. it is initialized and a git checkout master will work if you clone the git repo)
121+
- Ensure the git repository is not shared with anything other than this particular backup, as other items may be overwritten
120122
- When you create the Splunk Version Control Backup (via Settings -> Data Inputs -> Splunk Version Control Backup), click "More settings" and set the backup interval you would like (tags will only be created if config has changed within Splunk)
121123
- When you create the Splunk Version Control Restore (via Settings -> Data Inputs -> Splunk Version Control Restore), if you are using the newer `splunkversioncontrol_restore_dynamic` dashboard then you do not need to set a run interval, if you are using the older method you want to run this on an interval to check if the lookup file has been updated and if a restore is required...
122124

@@ -131,7 +133,7 @@ Or the internal index which also has these log files with the sourcetype splunkv
131133
- Configure the remoteAppName within the Splunk Version Control Backup & Splunk Version Control Restore modular inputs to "SplunkVersionControlCloud"
132134

133135
## How do I initialize a git repository?
134-
github and other websites may offer to initlize the repository for you, if they do not the steps are usually similar to:
136+
github and other websites may offer to initialize the repository for you, if they do not the steps are usually similar to:
135137
- git clone git@<website>:testing.git
136138
- cd testing
137139
- touch README.md
@@ -261,6 +263,9 @@ To do this you will need to install Version Control For SplunkCloud on your Splu
261263
[SplunkVersionControlCloud github](https://github.com/gjanders/SplunkVersionControlCloud)
262264

263265
## Release Notes
266+
### 1.1.8
267+
README.md update - git repositories must be dedicated per-backup and not shared with other items as the root level / top level directory is used
268+
264269
### 1.1.7
265270
Increase timeout for commands to a default of 60 seconds
266271
Ensure a valid message is sent back to the user if a dynamic restore fails

0 commit comments

Comments
 (0)