Skip to content

Commit

Permalink
docs: regenerate views
Browse files Browse the repository at this point in the history
  • Loading branch information
karol-kokoszka committed Mar 18, 2024
1 parent cfaa9ba commit b2b8f88
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 2 deletions.
3 changes: 2 additions & 1 deletion docs/source/sctool/partials/sctool_backup.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ name: sctool backup
synopsis: Schedule a backup (ad-hoc or scheduled)
description: |
This command allows you to schedule or run ad-hoc cluster backup.
usage: sctool backup --cluster <id|name> --location [<dc>:]<provider>:<bucket> [--keyspace <glob>] [flags]
usage: sctool backup --cluster <id|name> --location [<dc>:]<provider>:<bucket> [--keyspace
<glob>] [flags]
options:
- name: cluster
shorthand: c
Expand Down
8 changes: 8 additions & 0 deletions docs/source/sctool/partials/sctool_cluster_add.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ options:
- name: auth-token
usage: |
The authentication `token` you identified in '/etc/scylla-manager-agent/scylla-manager-agent.yaml'.
- name: force-non-ssl-session-port
default_value: "false"
usage: |
Forces Scylla Manager to always use the non-SSL port for TLS-enabled cluster CQL sessions.
- name: force-tls-disabled
default_value: "false"
usage: |
Forces Scylla Manager to always disable TLS for the cluster's CQL session, even if TLS is enabled in scylla.yaml.
- name: help
shorthand: h
default_value: "false"
Expand Down
8 changes: 8 additions & 0 deletions docs/source/sctool/partials/sctool_cluster_update.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ options:
default_value: "false"
usage: |
Deletes SSL user certificate, added with --ssl-user-cert-file flag.
- name: force-non-ssl-session-port
default_value: "false"
usage: |
Forces Scylla Manager to always use the non-SSL port for TLS-enabled cluster CQL sessions.
- name: force-tls-disabled
default_value: "false"
usage: |
Forces Scylla Manager to always disable TLS for the cluster's CQL session, even if TLS is enabled in scylla.yaml.
- name: help
shorthand: h
default_value: "false"
Expand Down
3 changes: 2 additions & 1 deletion docs/source/sctool/partials/sctool_restore.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ description: |
Restore is always one of two types: restore schema ('--restore-schema' flag) or restore tables' contents ('--restore-tables' flag).
In both cases, for the restore effects to be visible, you need to perform
a specific follow-up action described by selected type.
usage: sctool restore --cluster <id|name> --location [<dc>:]<provider>:<bucket> --snapshot-tag <tag> [flags]
usage: sctool restore --cluster <id|name> --location [<dc>:]<provider>:<bucket> --snapshot-tag
<tag> [flags]
options:
- name: batch-size
default_value: "2"
Expand Down

0 comments on commit b2b8f88

Please sign in to comment.