Skip to content

Commit 369853f

Browse files
committed
readme updates
1 parent 009c121 commit 369853f

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,25 @@ This is Oxide's long-term maintenance branch/fork of [CockroachDB 22.1](https://
22

33
Oxide uses CockroachDB for control plane data storage on the Oxide Cloud Computer, which uses [illumos](https://illumos.org) (specifically [Helios](https://github.com/oxidecomputer/helios)) as the underlying operating system. We launched our product with CockroachDB 22.1. After Cockroach Labs' announcement that they will change to a strictly proprietary (source-available) model, we made the decision to continue self-supporting on this BSL-licensed version for the foreseeable future. For more context, see [RFD 110](https://rfd.shared.oxide.computer/rfd/110) and [RFD 508](https://rfd.shared.oxide.computer/rfd/508).
44

5-
The primary goal of this branch is to keep the wheels of building and testing CockroachDB rolling smoothly to enable our ability to self-support. Our product runs illumos, but we also support development of our product on Linux and macOS, so it's important to us that our bug fixes that go into the illumos build also end up on developer machines too. Currently we have illumos and Linux builds going as well as Linux tests; we're working on CI parity for illumos and macOS.
5+
The primary goal of this branch is to keep the wheels of building and testing CockroachDB rolling smoothly to enable our ability to self-support. Our product runs illumos, but we also support development of our product on Linux and macOS, so it's important to us that our bug fixes that go into the illumos build also end up on developer machines too. Currently we have builds for illumos, Linux, and macOS; and run the test suite on illumos and Linux.
66

77
You're welcome to use this branch under [the same terms we are](./licenses/BSL.txt), but note that we're unable to provide any support outside the context of its use in our product.
88

9+
## Binary downloads
10+
11+
Binaries for each commit are available via Buildomat's published artefact APIs:
12+
13+
```
14+
https://buildomat.eng.oxide.computer/public/file/oxidecomputer/cockroach/$SERIES/$COMMIT/cockroach.tgz
15+
```
16+
17+
where:
18+
19+
- `$SERIES` is one of `illumos-amd64`, `linux-amd64`, or `macos-amd64` (or `macos-arm64`, both refer to the same universal binary)
20+
- `$COMMIT` is the full 40-character commit hash
21+
22+
A SHA-256 checksum is also available at `cockroach.tgz.sha256`.
23+
924
## Major changes from upstream
1025

1126
- We've removed all CCL-licensed code. The "Cockroach Community License" primarily covers enterprise features of the database. The split between BSL-licensed and CCL-licensed code was fairly clean, but we're not planning to maintain it, so we shouldn't keep it around.

0 commit comments

Comments
 (0)