Skip to content

Commit

Permalink
command: replace `` with '
Browse files Browse the repository at this point in the history
  • Loading branch information
mmatczuk committed Dec 27, 2021
1 parent 6d7fac4 commit 2ad5c94
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 54 deletions.
24 changes: 12 additions & 12 deletions pkg/command/backup/backuplist/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,24 @@ all-clusters: |
Shows backups for all clusters. Useful for listing clusters that are no longer available locally but are backed up in the past to remote location.
min-date: |
Specifies minimal snapshot `date` expressed in RFC3339 form or ``now[+duration]``, ex. ``now+3d2h10m``.
Specifies minimal snapshot `date` expressed in RFC3339 form or 'now[+duration]', ex. 'now+3d2h10m'.
Valid units are:
* ``d`` - days
* ``h`` - hours
* ``m`` - minutes
* ``s`` - seconds
* ``now`` - happens immediately
* 'd' - days
* 'h' - hours
* 'm' - minutes
* 's' - seconds
* 'now' - happens immediately
max-date: |
Specifies maximal snapshot `date` expressed in RFC3339 form or ``now[+duration]``, ex. ``now+3d2h10m``.
Specifies maximal snapshot `date` expressed in RFC3339 form or 'now[+duration]', ex. 'now+3d2h10m'.
Valid units are:
* ``d`` - days
* ``h`` - hours
* ``m`` - minutes
* ``s`` - seconds
* ``now`` - happens immediately
* 'd' - days
* 'h' - hours
* 'm' - minutes
* 's' - seconds
* 'now' - happens immediately
show-tables: |
Prints table names together with keyspace.
2 changes: 1 addition & 1 deletion pkg/command/backup/backupvalidate/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ short: Validate backup files in remote locations
long: |
This command schedules a backup validation task.
It checks that all needed files are in tact, and that there are no unexpected files occupying your storage.
To delete the unexpected files provide the ``--delete-orphaned-files`` parameter.
To delete the unexpected files provide the '--delete-orphaned-files' parameter.
To see the validation results use :ref:`task-progress` command.
It is safe to run backup and backup validation at the same time.
Expand Down
12 changes: 6 additions & 6 deletions pkg/command/backup/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ rate-limit: |
snapshot-parallel: |
A comma-separated list of snapshot parallelism limits in the format `[<dc>:]<limit>`.
The ``dc`` part is optional and allows for specifying different limits in selected datacenters.
If the ``dc`` part is not set, the limit is global and the runs are parallel in ``n`` nodes.
If for example, you were to set 'dc1:2,5', then ``dc1`` would have two parallel nodes and there would be five parallel nodes in the other DCs.
The 'dc' part is optional and allows for specifying different limits in selected datacenters.
If the 'dc' part is not set, the limit is global and the runs are parallel in 'n' nodes.
If for example, you were to set 'dc1:2,5', then 'dc1' would have two parallel nodes and there would be five parallel nodes in the other DCs.
upload-parallel: |
A comma-separated list of upload parallelism limits in the format `[<dc>:]<limit>`.
The ``dc`` part is optional and allows for specifying different limits in selected datacenters.
If the ``dc`` part is not set, the limit is global (e.g. 'dc1:2,5') the runs are parallel in ``n`` nodes.
If for example, you were to set 'dc1:2,5', then ``dc1`` would have two parallel nodes and there would be five parallel nodes in the other DCs.
The 'dc' part is optional and allows for specifying different limits in selected datacenters.
If the 'dc' part is not set, the limit is global (e.g. 'dc1:2,5') the runs are parallel in 'n' nodes.
If for example, you were to set 'dc1:2,5', then 'dc1' would have two parallel nodes and there would be five parallel nodes in the other DCs.
dry-run: |
Validates and prints backup information without actually scheduling a backup.
Expand Down
2 changes: 1 addition & 1 deletion pkg/command/cluster/clusteradd/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ port: |
Alternate Scylla Manager agent `port`.
auth-token: |
The authentication `token` you identified in ``/etc/scylla-manager-agent/scylla-manager-agent.yaml``.
The authentication `token` you identified in '/etc/scylla-manager-agent/scylla-manager-agent.yaml'.
username: |
CQL `username`, for security reasons this user should NOT have access to your data.
Expand Down
4 changes: 2 additions & 2 deletions pkg/command/cluster/clusterupdate/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ long: |
This command modifies managed cluster parameters
example: |
In this example, the cluster named ``cluster`` has been renamed to ``prod-cluster``.
In this example, the cluster named 'cluster' has been renamed to 'prod-cluster'.
sctool cluster update -c cluster --name prod-cluster
Expand All @@ -24,7 +24,7 @@ port: |
Alternate Scylla Manager agent `port`.
auth-token: |
The authentication `token` you identified in ``/etc/scylla-manager-agent/scylla-manager-agent.yaml``.
The authentication `token` you identified in '/etc/scylla-manager-agent/scylla-manager-agent.yaml'.
username: |
CQL `username`, for security reasons this user should NOT have access to your data.
Expand Down
30 changes: 15 additions & 15 deletions pkg/command/flag/task.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ window: |
interval: |
Time after which a successfully completed task would be run again, supported units are:
* ``d`` - days
* ``h`` - hours
* ``m`` - minutes
* ``s`` - seconds
* ``ms`` - milliseconds
* 'd' - days
* 'h' - hours
* 'm' - minutes
* 's' - seconds
* 'ms' - milliseconds
The task run date is aligned with ``--start date`` value.
For example, if you select ``--interval 7d`` task would run weekly at the ``--start-date`` time.
The task run date is aligned with '--start date' value.
For example, if you select '--interval 7d' task would run weekly at the '--start-date' time.
start-date: |
The date can be expressed relatively to now or as a RFC3339 formatted string.
To run the task in 2 hours use ``now+2h``, supported units are:
To run the task in 2 hours use 'now+2h', supported units are:
* ``d`` - days
* ``h`` - hours
* ``m`` - minutes
* ``s`` - seconds
* ``ms`` - milliseconds
* 'd' - days
* 'h' - hours
* 'm' - minutes
* 's' - seconds
* 'ms' - milliseconds
If you want the task to start at a specified date use RFC3339 formatted string i.e. ``2018-01-02T15:04:05-07:00``.
If you want the repair to start immediately, use the value ``now`` or skip this flag.
If you want the task to start at a specified date use RFC3339 formatted string i.e. '2018-01-02T15:04:05-07:00'.
If you want the repair to start immediately, use the value 'now' or skip this flag.
num-retries: |
Number of times a task reruns following a failure.
Expand Down
22 changes: 11 additions & 11 deletions pkg/command/flag/usage.yaml
Original file line number Diff line number Diff line change
@@ -1,38 +1,38 @@
glob: |
The following syntax for glob patterns is supported:
* ``*`` - matches any number of any characters including none
* ``?`` - matches any single character
* ``[abc]`` - matches one character given in the bracket
* ``[a-z]`` - matches one character from the range given in the bracket
* '*' - matches any number of any characters including none
* '?' - matches any single character
* '[abc]' - matches one character given in the bracket
* '[a-z]' - matches one character from the range given in the bracket
Patterns are evaluated from left to right.
If a pattern starts with ``!`` it unselects items that were selected by previous patterns i.e. ``a?,!aa`` selects *ab* but not *aa*.
If a pattern starts with '!' it unselects items that were selected by previous patterns i.e. 'a?,!aa' selects *ab* but not *aa*.
cluster: |
The target cluster `name or ID` (envvar SCYLLA_MANAGER_CLUSTER).
dc: |
A list of datacenter `glob` patterns separated by a comma, e.g. ``dc1,!otherdc*`` used to specify the datacenters to include or exclude.
A list of datacenter `glob` patterns separated by a comma, e.g. 'dc1,!otherdc*' used to specify the datacenters to include or exclude.
${glob}
fail-fast: |
Stops the task run on the first error.
keyspace: |
A list of `glob` patterns separated by a comma used to include or exclude tables.
The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. ``keyspace,!keyspace.table_prefix_*``.
The patterns match keyspaces and tables, separate the keyspace name from the table name with a dot e.g. 'keyspace,!keyspace.table_prefix_*'.
${glob}
location: |
A list of backup locations separated by a comma, specifies where to place the backup, the format is `[<dc>:]<provider>:<bucket>`.
The ``<dc>`` parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter.
The supported storage ``<provider>``s are ``azure``, ``gcs``, ``s3``.
The ``name`` parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
The '<dc>' parameter is optional it allows to specify location for a datacenter in a multi-dc setting, it must match Scylla nodes datacenter.
The supported storage '<provider>'s are 'azure', 'gcs', 's3'.
The 'name' parameter is a bucket name, it must be an alphanumeric string and **may contain a dash and or a dot, but other characters are forbidden**.
api-url: |
Base `URL` of Scylla Manager server (envvar SCYLLA_MANAGER_API_URL).
If running sctool on the same machine as server, it's generated based on ``/etc/scylla-manager/scylla-manager.yaml`` file.
If running sctool on the same machine as server, it's generated based on '/etc/scylla-manager/scylla-manager.yaml' file.
api-cert-file: |
File `path` to HTTPS client certificate used to access the Scylla Manager server when client certificate validation is enabled (envvar SCYLLA_MANAGER_API_CERT_FILE).
Expand Down
4 changes: 2 additions & 2 deletions pkg/command/legacy/task/tasklist/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ long: |
For more information on a task consult history and progress.
all: |
Lists all tasks, including those which have been disabled, disabled tasks are prefixed with ``*``.
Lists all tasks, including those which have been disabled, disabled tasks are prefixed with '*'.
status: |
Filters tasks according to their last run `status`.
Expand All @@ -23,4 +23,4 @@ type: |
sort: |
Returns a list of tasks sorted according to the last run status and sort `key` which you provide.
Accepted sort key values are: ``start-time``, ``next-activation``, ``end-time``, ``status``.
Accepted sort key values are: 'start-time', 'next-activation', 'end-time', 'status'.
4 changes: 2 additions & 2 deletions pkg/command/status/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ use: status
short: Show version information

long: |
This command is an extended version of ``nodetool status``.
This command is an extended version of 'nodetool status'.
It can show status for all the managed clusters.
The first column shows node status in nodetool status format.
Expand All @@ -13,7 +13,7 @@ long: |
* UP - Situation normal
* DOWN - Failed to connect to host or CQL error
* ERROR - Precondition failure, no request was sent
* UNAUTHORISED - Wrong username or password - only if ``username`` is specified for cluster
* UNAUTHORISED - Wrong username or password - only if 'username' is specified for cluster
* TIMEOUT - Timeout
The REST column shows the status of Scylla Manager Server to Scylla API communication, and time the check took.
Expand Down
4 changes: 2 additions & 2 deletions pkg/command/tasks/res.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ long: |
For more information on a task consult history and progress.
all: |
Lists all tasks, including those which have been disabled, disabled tasks are prefixed with ``*``.
Lists all tasks, including those which have been disabled, disabled tasks are prefixed with '*'.
status: |
Filters tasks according to their last run `status`.
Expand All @@ -20,4 +20,4 @@ type: |
sort: |
Returns a list of tasks sorted according to the last run status and sort `key` which you provide.
Accepted sort key values are: ``start-time``, ``next-activation``, ``end-time``, ``status``.
Accepted sort key values are: 'start-time', 'next-activation', 'end-time', 'status'.

0 comments on commit 2ad5c94

Please sign in to comment.