Skip to content

Commit 1de8974

Browse files
authored
Merge pull request #1174 from dpulitano/danp/add-params-op-conductor
Add params to most op-conductor RPC examples
2 parents 2f3d699 + 22ec185 commit 1de8974

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

pages/builders/chain-operators/tools/op-conductor.mdx

+10-10
Original file line numberDiff line numberDiff line change
@@ -544,14 +544,14 @@ AddServerAsVoter adds a server as a voter to the cluster.
544544
<Tabs.Tab>
545545
```sh
546546
curl -X POST -H "Content-Type: application/json" --data \
547-
'{"jsonrpc":"2.0","method":"conductor_addServerAsVoter","params":[<id>, <raft-consensus-addr>, <version>],"id":1}' \
547+
'{"jsonrpc":"2.0","method":"conductor_addServerAsVoter","params":[<raft-server-id>, <raft-consensus-addr>, <raft-config-version>],"id":1}' \
548548
http://127.0.0.1:8547
549549
```
550550
</Tabs.Tab>
551551

552552
<Tabs.Tab>
553553
```sh
554-
cast rpc conductor_addServerAsVoter --rpc-url http://127.0.0.1:8547 <id> <raft-consensus-addr> <version>
554+
cast rpc conductor_addServerAsVoter <raft-server-id> <raft-consensus-addr> <raft-config-version> --rpc-url http://127.0.0.1:8547
555555
```
556556
</Tabs.Tab>
557557
</Tabs>
@@ -569,14 +569,14 @@ The non-voter will not participate in the leader election.
569569
<Tabs.Tab>
570570
```sh
571571
curl -X POST -H "Content-Type: application/json" --data \
572-
'{"jsonrpc":"2.0","method":"conductor_addServerAsNonvoter","params":[],"id":1}' \
572+
'{"jsonrpc":"2.0","method":"conductor_addServerAsNonvoter","params":[<raft-server-id>, <raft-consensus-addr>, <raft-config-version>],"id":1}' \
573573
http://127.0.0.1:8547
574574
```
575575
</Tabs.Tab>
576576

577577
<Tabs.Tab>
578578
```sh
579-
cast rpc conductor_addServerAsNonvoter --rpc-url http://127.0.0.1:8547
579+
cast rpc conductor_addServerAsNonvoter <raft-server-id> <raft-consensus-addr> <raft-config-version> --rpc-url http://127.0.0.1:8547
580580
```
581581
</Tabs.Tab>
582582
</Tabs>
@@ -593,14 +593,14 @@ RemoveServer removes a server from the cluster.
593593
<Tabs.Tab>
594594
```sh
595595
curl -X POST -H "Content-Type: application/json" --data \
596-
'{"jsonrpc":"2.0","method":"conductor_removeServer","params":[],"id":1}' \
596+
'{"jsonrpc":"2.0","method":"conductor_removeServer","params":[<raft-server-id>, <raft-config-version>],"id":1}' \
597597
http://127.0.0.1:8547
598598
```
599599
</Tabs.Tab>
600600

601601
<Tabs.Tab>
602602
```sh
603-
cast rpc conductor_removeServer --rpc-url http://127.0.0.1:8547
603+
cast rpc conductor_removeServer <raft-server-id> <raft-config-version> --rpc-url http://127.0.0.1:8547
604604
```
605605
</Tabs.Tab>
606606
</Tabs>
@@ -611,7 +611,7 @@ RemoveServer removes a server from the cluster.
611611
API related to consensus.
612612
</Callout>
613613

614-
TransferLeader transfers leadership to another server.
614+
TransferLeader transfers leadership to another server (resigns).
615615

616616
<Tabs items={['curl', 'cast']}>
617617
<Tabs.Tab>
@@ -641,14 +641,14 @@ TransferLeaderToServer transfers leadership to a specific server.
641641
<Tabs.Tab>
642642
```sh
643643
curl -X POST -H "Content-Type: application/json" --data \
644-
'{"jsonrpc":"2.0","method":"conductor_transferLeaderToServer","params":[],"id":1}' \
644+
'{"jsonrpc":"2.0","method":"conductor_transferLeaderToServer","params":[<raft-server-id>, <raft-consensus-addr>, <raft-config-version>],"id":1}' \
645645
http://127.0.0.1:8547
646646
```
647647
</Tabs.Tab>
648648

649649
<Tabs.Tab>
650650
```sh
651-
cast rpc conductor_transferLeaderToServer --rpc-url http://127.0.0.1:8547
651+
cast rpc conductor_transferLeaderToServer <raft-server-id> <raft-consensus-addr> <raft-config-version> --rpc-url http://127.0.0.1:8547
652652
```
653653
</Tabs.Tab>
654654
</Tabs>
@@ -704,7 +704,7 @@ Active returns true if the op-conductor is active (not paused or stopped).
704704
</Callout>
705705

706706
CommitUnsafePayload commits an unsafe payload (latest head) to the consensus
707-
layer.
707+
layer. TODO - usage examples that include required params are needed
708708

709709
<Tabs items={['curl', 'cast']}>
710710
<Tabs.Tab>

0 commit comments

Comments
 (0)