Skip to content

Commit

Permalink
remove a few corrosion2 mentions, tweak readme (#49)
Browse files Browse the repository at this point in the history
  • Loading branch information
jeromegn authored Sep 18, 2023
1 parent 798f7e8 commit d84aff9
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .buildkite/upload.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ buildkite-agent artifact download 'builds/*.tar.gz' ./builds
BUILD_NAME="${BUILDKITE_BRANCH//[^a-zA-Z0-9-]/--}"

# upload
aws s3 cp builds/corrosion.tar.gz s3://flyio-builds/corrosion2/${BUILD_NAME}-${BUILDKITE_COMMIT:0:8}.tar.gz --region us-east-2 &
aws s3 cp builds/corrosion.tar.gz ${UPLOAD_BUCKET_PATH}/${BUILD_NAME}-${BUILDKITE_COMMIT:0:8}.tar.gz --region us-east-2 &
wait

aws s3 cp s3://flyio-builds/corrosion2/${BUILD_NAME}-${BUILDKITE_COMMIT:0:8}.tar.gz s3://flyio-builds/corrosion2/${BUILD_NAME}.tar.gz --region us-east-2 &
aws s3 cp ${UPLOAD_BUCKET_PATH}/${BUILD_NAME}-${BUILDKITE_COMMIT:0:8}.tar.gz ${UPLOAD_BUCKET_PATH}/${BUILD_NAME}.tar.gz --region us-east-2 &
wait
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Corrosion
Corrosion: Gossip-based service discovery (and more) for large distributed systems, written in Rust.
Gossip-based service discovery (and more) for large distributed systems.

## Why we built Corrosion

Expand All @@ -11,9 +11,9 @@ Our new tool needed to deliver the following:

Getting state (data) from a central remote source can be incredibly expensive (at least 300ms for a round-trip to something on the other side of the world), but usually takes less than 1ms from a local source.

### Fast consistency
### Fast, eventual, consistency

Strong consistency by RAFT consensus can be too slow. Eventual consistency works, if it's fast.
Strong consistency by RAFT consensus can be too slow. Eventual consistency works for our use case, if it's fast.

### Flexibility

Expand All @@ -40,21 +40,21 @@ In a nutshell, Corrosion:

## Usage overview

Run the Corrosion agent on every node/host in the cluster. Other programs running on the node use [Corrosion's HTTP API](/doc/api/README.md) to query the local Corrosion SQLite database, add and update data, and subscribe to change notifications.
Run the Corrosion agent on every node/host in the cluster. Other programs running on the node use [Corrosion's HTTP API](https://superfly.github.io/corrosion/api/index.html) to query the local Corrosion SQLite database, add and update data, and subscribe to change notifications.

The [Corrosion CLI](/doc/cli/README.md) provides commands for administration and access to database and features.
The [Corrosion CLI](https://superfly.github.io/corrosion/cli/index.html) provides commands for administration and access to database and features.

### Quick start

- [Prepare the Corrosion configuration file](config/README.md)
- [Specify the initial database schema](schema.md)
- [Start the Corrosion agent](cli/agent.md)
- [Prepare the Corrosion configuration file](https://superfly.github.io/corrosion/config/)
- [Specify the initial database schema](https://superfly.github.io/corrosion/schema.html)
- [Start the Corrosion agent](https://superfly.github.io/corrosion/cli/agent.html)

See the WIP [Corrosion documentation](/doc/SUMMARY.md) for more details.
See the WIP [Corrosion documentation](https://superfly.github.io/corrosion/) for more details.

## Building Corrosion

Clone [https://github.com/superfly/corrosion2.git](https://github.com/superfly/corrosion2.git).
Clone [https://github.com/superfly/corrosion.git](https://github.com/superfly/corrosion.git).

From within the repo directory:

Expand Down

0 comments on commit d84aff9

Please sign in to comment.