Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #7

Merged
merged 3 commits into from
Jul 4, 2024
Merged

Update README.md #7

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ab183ab
Update README.md
imoore76 Jul 4, 2024
9b76373
Update README.md
imoore76 Jul 4, 2024
8510859
Update README.md
imoore76 Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
<img src="images/LDLM%20Logo%20Symbol.png" height="95" width="100" alt="ldlm logo" />
</p>

# ldlm
# LDLM

ldlm is a lightweight distributed lock manager implemented over gRPC and REST.
LDLM is a **L**ightweight **D**istributed **L**ock **M**anager implemented over gRPC and REST.

## Installation

Expand Down Expand Up @@ -206,11 +206,11 @@ The first client that obtains the lock within the uptime of the LDLM server will

## Lock Keys

Lock keys are meant to detect when ldlm and a client are out of sync. They are not cryptographic. They are not secret. They are not meant to deter malicious users from releasing locks.
Lock keys are meant to detect when LDLM and a client are out of sync. They are not cryptographic. They are not secret. They are not meant to deter malicious users from releasing locks.

## ldlm-lock commands

The ldlm-lock command is used to manipulate locks in a running ldlm server on the CLI. See also `ldlm-lock -help`.
The ldlm-lock command is used to manipulate locks in a running LDLM server on the CLI. See also `ldlm-lock -help`.

### List Locks

Expand All @@ -220,11 +220,11 @@ This prints a list of locks and their keys

### Force Unlocking

If a lock ever becomes deadlocked (this *should* not happen), you can unlock it by running the following on the same machine as a running ldlm server:
If a lock ever becomes deadlocked (this *should* not happen), you can unlock it by running the following on the same machine as a running LDLM server:

ldlm-lock unlock <lock name>

## Examples
## Use Cases

### Primary / Secondary Failover

Expand Down
Loading