Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: regenerate views #3757

Merged
merged 1 commit into from
Mar 18, 2024
Merged

docs: regenerate views #3757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 2 additions & 1 deletion docs/source/sctool/partials/sctool_backup.yaml
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
Loading