Skip to content
This repository has been archived by the owner on Feb 1, 2024. It is now read-only.

Adjust documentation for Raft decommissioning #211

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions docs/1.2/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,9 +177,10 @@ Raft consensus
with a restricted membership. Raft is crash fault tolerant, not
Byzantine fault tolerant, and has finality (does not fork). For more
information, see [Raft (computer science) on
Wikipedia](https://en.wikipedia.org/wiki/Raft_(computer_science))
and the [Sawtooth Raft
documentation](https://sawtooth.hyperledger.org/docs/raft/nightly/master/introduction.html).
Wikipedia](https://en.wikipedia.org/wiki/Raft_(computer_science)).
**Sawtooth Raft is due for removal** because the prototype was never ready
for production, and applications requiring finality can use PBFT consensus
instead.

REST API

Expand Down
4 changes: 0 additions & 4 deletions docs/1.2/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,10 +181,6 @@ for these algorithms:
> simulator is also called \"PoET/CFT\" because it is crash
> fault tolerant, not Byzantine fault tolerant.
>
> - [Sawtooth Raft]({% link docs/1.2/raft/index.md %}) is a
> leader-based consensus algorithm that provides crash fault
> tolerance for a small network with restricted membership.
>
> - Devmode (short for \"developer mode\") is a simplified
> random-leader algorithm that is useful for developing and testing
> a transaction processor. Devmode is not recommended for multi-node
Expand Down
58 changes: 6 additions & 52 deletions docs/1.2/sysadmin_guide/about_dynamic_consensus.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,59 +234,13 @@ Requirements:

## Raft Consensus {#raft-consensus-label}

[Sawtooth Raft]({% link docs/1.2/glossary.md %}#term-sawtooth-raft) provides a
simple consensus algorithm that is easy to understand. It is leader-based, crash
fault tolerant, and does not fork. For more information, see the [Raft
documentation]({% link docs/1.2/raft/index.md %}).
Sawtooth Raft was intended to provide a simple consensus algorithm that is
easy to understand. Raft is leader-based, crash fault tolerant, and does not
fork.

> **Note**
>
> Sawtooth Raft is currently a prototype (not yet released). For more
> information, see the
> [sawtooth-raft](https://github.com/hyperledger/sawtooth-raft)
> repository.

Requirements:

- Each node must install the Raft consensus engine package,
`sawtooth-raft-engine`.

- Each node must run the Raft consensus engine:

- Service: `sawtooth-raft-engine.service`
- Executable: `raft-engine`

For more information, see
[Running Sawtooth as a Service]({% link
docs/1.2/sysadmin_guide/setting_up_sawtooth_network.md
%}#running-sawtooth-as-a-service). (To start the consensus engine on the
command line, see [Step 5. Start Sawtooth on the First Node]({% link
docs/1.2/app_developers_guide/ubuntu_test_network.md %})).

- Specify static peering when starting each validator. Use the
`--peering` option when starting the validator (see [sawtooth-validator]({%
link docs/1.2/cli/sawtooth-validator.md %})) or set the off-chain `peers`
setting in the `validator.toml` configuration file (see
[About Sawtooth Configuration Files]({% link
docs/1.2/sysadmin_guide/configuring_sawtooth.md %})).

- Use these on-chain settings for Raft consensus:

``` none
sawtooth.consensus.algorithm.name=raft
sawtooth.consensus.algorithm.version=[VERSION]
sawtooth.consensus.raft.peers=[VAL1KEY,VAL2KEY,...,VALnKEY]
```

For the version number, see the `Cargo.toml` file. Use only the
first two digits (for example, `[0.1]`).

For `VALxKEY`, specify the validator public key of each node in the
network.

- For other on-chain settings for Raft, see [Optional
Settings]({% link docs/1.2/raft/configuring_deploying.md %})
in the Raft documentation.
**Sawtooth Raft is due for removal** because the prototype was never ready
for production, and applications requiring finality can use PBFT consensus
instead.

## Devmode Consensus {#devmode-consensus-label}

Expand Down
Loading