Skip to content

Commit

Permalink
fix: clarify readme up-to-date'ness
Browse files Browse the repository at this point in the history
  • Loading branch information
Jorres committed Jun 16, 2024
1 parent 88af9c5 commit c619c02
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

`ydbops` utility is used to perform various ad-hoc and maintenance operations on YDB clusters.

## On the up-to-date'ness of this readme

Soon an official documentation on [ydb.tech](https://ydb.tech) will be available.

For now, please use the below info for reference only, it might be slightly outdated.

## Prerequisites:

1. Go 1.21
Expand All @@ -28,7 +34,7 @@ Please browse the `ydbops --help` first. Then read along for examples (substitut
ydbops restart --storage \
--endpoint grpc://<cluster-fqdn> \
--ssh-args=pssh,-A,-J,<bastion-fqdn>,--ycp-profile,prod,--no-yubikey \
--verbose --hosts <node1-fqdn>,<node2-fqdn>,<node3-fqdn>
--verbose --hosts=<node1-fqdn>,<node2-fqdn>,<node3-fqdn>
```

#### Restarting hosts without specifying filters will restart all of them
Expand All @@ -45,7 +51,7 @@ ydbops restart --storage \
```
ydbops run \
--endpoint grpc://<cluster-fqdn> \
--availability-mode strong --verbose --hosts 7,8 \
--availability-mode strong --verbose --hosts=7,8 \
--payload ./tests/payloads/payload-echo-helloworld.sh
```

Expand All @@ -54,7 +60,7 @@ ydbops run \
```
ydbops run \
--endpoint grpc://<cluster-fqdn> \
--availability-mode strong --verbose --hosts 5,6 \
--availability-mode strong --verbose --hosts=5,6 \
--payload ./tests/payloads/payload-restart-ydbd.sh
```

Expand All @@ -66,6 +72,6 @@ An example of authenticating with static credentials:
export YDB_PASSWORD=password_123
ydbops restart --storage \
--endpoint grpc://<cluster-fqdn> \
--availability-mode strong --verbose --hosts 7,8 \
--availability-mode strong --verbose --hosts=7,8 \
--user jorres --kubeconfig ~/.kube/config
```

0 comments on commit c619c02

Please sign in to comment.