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

doc: versions #100

Merged
merged 3 commits into from
Jul 17, 2024
Merged

doc: versions #100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86746f3
doc: versions
snadrus Jul 16, 2024
f478bc8
auto update
snadrus Jul 17, 2024
6acc56e
add boost version
LexLuthr Jul 17, 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
1 change: 1 addition & 0 deletions documentation/en/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
* [Sealing](design/sealing.md)
* [Harmony Tasks](design/harmony-tasks.md)
* [Getting Started](getting-started.md)
* [Versions](versions.md)
* [Installation](installation.md)
* [Setup](setup.md)
* [Curio Service](curio-service.md)
Expand Down
9 changes: 0 additions & 9 deletions documentation/en/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,6 @@ description: This is a step by step guide for new users to get onboarded with Cu

# Getting Started

## Compatibility

This is the Curio and Lotus compatibility matrix.

| Curio Version | Lotus Version | Go Version |
| ------------- | ------------- | ---------- |
| 1.22.0 | v1.27.0 | 1.21.7 |
| 1.22.1 | v1.27.x | 1.22.3 |

## Curio Database and Distributed Architecture

### Familiarizing Yourself with Curio
Expand Down
35 changes: 35 additions & 0 deletions documentation/en/versions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@

# Version Compatibility

This is the compatibility matrix for the latest free Curio releases.

| Curio Version | Lotus Version | Boost | Yugabyte | Forest |
| ------------------- | ------------- | ----------- | ------------------ | ---------------- |
| 1.22.1 / Automatic | v1.27.X | v2.3.0-rc2 | 2.20.X / Automatic | 0.19 / Automatic |
| 1.23.0 | v1.28.0-rcX | Coming soon | 2.20.X / Automatic | 0.19 / Automatic |

No preference is denoted by "X".

Configurations and the number of machines needed:
A: Lotus, Curio (numerous), Yugabyte (1 or 3), (optional Boost)
B: Forest, Curio (numerous), Yugabyte (1 or 3)

## Automatic Updates

- Docker has Watchtower which offers automatic updates which work for Yugabyte and Forest.
- Curio can automatically be updated on MainNet through the Debian update process on Ubuntu.
- Today, only Lotus & Boost lacks automatic updates and must be built and deployed.
- Curio's DEBs include curio-cuda (for Nvidia) and curio-opencl (others like ATI).
- These can be mixed in a Curio cluster as they only relate to the hardware on the box.

## Notes

- Forest (0.19+ & Docker Watchtower) is a light alternative to Lotus Client. It meets Curio's needs, but Boost compatability is in development.

## Building for CalibrationNet

- Required for CalibrationNet participation
- Use the Go version specified in curio/GO_VERSION_MIN
- The available Curio branches are named as release/vVERSION like: release/v1.23.4
- CalibrationNet may be a network-version ahead of MainNet.
- DEBs are only for MainNet releases and will be available early so MainNet upgrades cause no interruption.