Skip to content

Commit

Permalink
Addition of more-methodical testing and many example scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
Corionis committed Sep 4, 2021
1 parent d49f95e commit 4640f58
Show file tree
Hide file tree
Showing 101 changed files with 1,298 additions and 736 deletions.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions .idea/runConfigurations/50_01_Hints_local_only.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 0 additions & 16 deletions .idea/runConfigurations/Hints_Remote_Publisher_backup.xml

This file was deleted.

16 changes: 0 additions & 16 deletions .idea/runConfigurations/Hints_Remote_Publisher_dry_run.xml

This file was deleted.

13 changes: 0 additions & 13 deletions .idea/runConfigurations/Hints_Subscriber_listener.xml

This file was deleted.

2 changes: 1 addition & 1 deletion .idea/runConfigurations/Local_Status_Publisher_backup.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .idea/runConfigurations/Local_Status_Publisher_dry_run.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion .idea/runConfigurations/Local_Status_local_only.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 12 additions & 1 deletion artifacts/document/command-line.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,12 @@ files have been specified.

### Parameters

//////////////////// Not used: g j y z
////////////////////
// Not used yet: g j y z
// -g for the 4.0.0 --gui
// -j for a "jump start" service for launching ELS named profiles
// Or extend that idea into a launcher/general ELS monitor, maybe 4.1.0
////////////////////

* -a | --authorize [password] : The password required for authorized accesss
when in -r | --remote mode and allowing STTY interactive access to a listener
Expand Down Expand Up @@ -131,6 +136,9 @@ files have been specified.

* -q | --quit-status : Send quit command to hint status server when operation complete

* -Q | --force-quit : Force the hint status server to quit, then end. Specifically
intended to shut it down.

* -s | --subscriber-libraries [file] : Subscriber JSON library file

* -S | --subscriber-collection [file] : Subscriber JSON collection file
Expand Down Expand Up @@ -184,6 +192,9 @@ path leading to the library is not touched.
The -p | --publisher-libraries option will perform library scans as needed.
The -P | --publisher-collection option does not do any scans.

The -Q | --force-quit options requires a --hints file and a -p | -P publisher
file to provide the necessary to/from ends.

The -s | --subscriber-libraries option will perform library scans as needed.
The -S | --subscriber-collection option does not do any scans.

Expand Down
4 changes: 3 additions & 1 deletion artifacts/document/hint-status.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ tracker. The tracker may be used locally or the Hint Status Server may be run to
provide the needed functionality when using the -r | --remote option.

ELS Hints are optional. Hint tracking is optional when using hints. But the ELS
Hint Status Server (HSS) is required when using hints and hint tracking with the
Hint Status Server (HSS) is **required** when using hints and hint tracking with the
-r | --remote option.

The ELS Hint Keys file introduced with 3.0.0 is used by the HSS for authentication
during the complex ELS automated handshake.
3 changes: 3 additions & 0 deletions artifacts/document/hints.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ When all systems have executed the hint the file is automatically deleted.
To correlate publisher and subscriber collections with status keys in ELS hint
files a single keys file is needed.

The keys are also used by the Hint Status Server introduced in ELS 3.1.0 for
authentication during the complex ELS automated handshake.

Example:

```
Expand Down
18 changes: 11 additions & 7 deletions artifacts/document/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
## Version 3.1.0

Release 3.1.0 of ELS adds a new mode - the ELS Hint Status Server (HSS). Only needed when
more than one remote back-up is being used the HSS coordinates the status
two or more remote back-ups are being used the HSS coordinates the status
of all back-ups to facilitate automatic maintenance of the ELS Hint mechanism.

This new HSS mode is optional. All previous features and behavior remain the same. It
is an additional separate process that is executed before any operation requiring
is an additional separate process that is executed before any remote operation requiring
hint coordination. Options are available to allow the HSS to run continuously or
"ordered" to quit by any publisher or subscriber when an operation is completed. A
separate TCP/IP port is required for the status server listener service.
separate TCP/IP port is required for the status server listener.

### Enhancements

1. ELS Hint Server.

### Command Line Changes

1. -h has been repurposed, -H added.
1. -h has been repurposed, -H added for hints.

The -h | --version options used to be for help that only displayed the version.
The --version option still does that.
Previously the -h | --version options were used for help that only displayed
the version. The --version option still does that.

The -h option is now -h | --hints [file] : Hints Status Server file to enable
connection to the new ELS Hint Status Server.
Expand All @@ -33,7 +33,11 @@ separate TCP/IP port is required for the status server listener service.
The execution sequence **must** be the HSS, then subscriber, then publisher. The
publisher commands the subscriber to quit automatically when the operation is
done. So it is best to add the --quit-status option to the subscriber so when
it shuts down it will command the Hint Status Server to quit.
it shuts down it will command the Hint Status Server to quit - if desired.

3. Added -Q | --force-quit : Special option that only connects to the HSS to
send a quit command, then it ends. Requires a --hint file and -p | -P publisher
file to specify the to/from connection ends respectively.

### Bug Fixes

Expand Down
Loading

0 comments on commit 4640f58

Please sign in to comment.