README
¶
cloudlock
Regular filelock, but in cloud.
Cloudlock is a distributed lock based on cloud storage. It uses a bucket to store a lock file. When a lock is acquired, the lock file is created. When the lock is released, the lock file is deleted. Great for distributed CI/CD pipelines or any kind of coordination between multiple processes.
Supported environments
- Google Cloud
- AWS S3
- Minio
- Github
Instalation
go install github.com/jsam/cloudlock
GCS configuration
To start using cloudlock with GCS, there are 2 required settings - project identifier and service account.
They can be provided via environment:
export GOOGLE_APPLICATION_CREDENTIALS=
export GCP_PROJECT_ID=
or via the command line:
cl [command] [args] --project <project_id> --service-account <svc_account_path>
Usage
Create a lock
cl lock [lock-name]
Release a lock
cl unlock [lock-name]
Documentation
¶
Overview ¶
Copyright © 2022 sam <contact@justsam.io>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Source Files
Directories