Skip to content

Commit

Permalink
Address review suggestions
Browse files Browse the repository at this point in the history
  • Loading branch information
SupriyaKasten committed Aug 21, 2019
1 parent 248bb29 commit a678637
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
14 changes: 7 additions & 7 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ Outputs:
:widths: 5,5,15

`backupTag`,`string`, unique tag added to the backup
`backupID`,`string`, unique snapshot id generated by restic during backup
`backupID`,`string`, unique snapshot id generated during backup

Example:

Expand Down Expand Up @@ -323,7 +323,7 @@ Example:
BackupDataAll
-------------

This function concurrently backs up data from more than one pods into an any
This function concurrently backs up data from one or more pods into an any
object store supported by Kanister.

.. note::
Expand Down Expand Up @@ -401,7 +401,7 @@ and restores data to the specified path.
`namespace`, Yes, `string`, namespace in which to execute
`image`, Yes, `string`, image to be used for running restore
`backupArtifactPrefix`, Yes, `string`, path to the backup on the object store
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated by restic during backup
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated during backup
`backupTag`, No, `string`, (required if backupIdentifier not provided) unique tag added during the backup
`restorePath`, No, `string`, path where data is restored
`pod`, No, `string`, pod to which the volumes are attached
Expand Down Expand Up @@ -456,9 +456,9 @@ RestoreDataAll
--------------

This function concurrently restores data backed up by the :ref:`backupdataall`
function, on more than one pods.
function, on one or more pods.
It concurrently runs a job Pod for each workload Pod, that mounts the
respective PVCs of that Pod and restores data to the specified path.
respective PVCs and restores data to the specified path.

.. note::
It is extremely important that, the PVCs are not be currently
Expand Down Expand Up @@ -557,7 +557,7 @@ Outputs:
:align: left
:widths: 5,5,15

`backupID`,`string`, unique snapshot id generated by restic where data was copied
`backupID`,`string`, unique snapshot id generated when data was copied
`backupRoot`,`string`, parent directory location of the data copied from
`backupArtifactLocation`,`string`, location in objectstore where data was copied
`backupTag`,`string`, unique string to identify this data copy
Expand Down Expand Up @@ -588,7 +588,7 @@ This function deletes the snapshot data backed up by the BackupData function.

`namespace`, Yes, `string`, namespace in which to execute
`backupArtifactPrefix`, Yes, `string`, path to the backup on the object store
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated by restic during backup
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated during backup
`backupTag`, No, `string`, (required if backupIdentifier not provided) unique tag added during the backup
`encryptionKey`, No, `string`, encryption key to be used during backups

Expand Down
1 change: 0 additions & 1 deletion docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ actionset
objectstore
Elasticsearch
backupInfo
restic
backupTag
backupIdentifier
gcs

0 comments on commit a678637

Please sign in to comment.