Skip to content

Commit

Permalink
document remove and convert special cases
Browse files Browse the repository at this point in the history
  • Loading branch information
reidsunderland committed Dec 1, 2023
1 parent db3cfe5 commit c190c2b
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,11 @@ Usage: `sr3d [ -h ] (convert|declare|devsnap|dump|edit|log|restart|sanity|setup|

See [`man sr3`](https://metpx.github.io/sarracenia/Reference/sr3.1.html).

**Special Cases:**

- `convert`: converts the config from v2 to sr3 on the first node in the cluster, then copies the sr3 config to your workstation and removes the config from the node. The user needs to manually disable the v2 config, commit the sr3 config, and run `sr3_pull` to update the cluster.
- `remove`: runs `sr3 remove ...` on the cluster and deletes the config from your Git repo.

**Examples:**

- `sr3d start subscribe/my_config`
Expand Down Expand Up @@ -195,6 +200,14 @@ Usage: `sr3r your_command`

<br>

### `sr3_scp`

Usage: `sr3_scp user@server:/remote/file /local/file`

Like *sr3_ssh*, but for scp.

<br>

### `sr3_ssh`

Usage: `sr3_ssh user@server`
Expand Down

0 comments on commit c190c2b

Please sign in to comment.