Skip to content

Commit

Permalink
Spelling, limit words per line
Browse files Browse the repository at this point in the history
  • Loading branch information
SupriyaKasten committed Aug 16, 2019
1 parent a46aedb commit 03328ea
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -339,10 +339,10 @@ Arguments:
:widths: 5,5,5,15

`namespace`, Yes, `string`, namespace in which to execute
`pods`, No, `string`, pods in which to execute (by default, runs on all the pods)
`pods`, No, `string`, pods in which to execute (by default runs on all the pods)
`container`, Yes, `string`, container in which to execute
`includePath`, Yes, `string`, path of the data to be backed up
`backupArtifactPrefix`, Yes, `string`, path to store the backup on the object store, appended by pod name later
`backupArtifactPrefix`, Yes, `string`, path to store the backup on the object store appended by pod name later
`encryptionKey`, No, `string`, encryption key to be used for backups

Outputs:
Expand Down Expand Up @@ -401,8 +401,8 @@ 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
`backupTag`, No, `string`, (required if backupIdentifier not provided)unique tag added during the backup
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated by restic 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
`volumes`, No, `map[string]string`, Mapping of `pvcName` to `mountPath` under which the volume will be available
Expand Down Expand Up @@ -457,7 +457,7 @@ RestoreDataAll

This function concurrently restores data backed up by the :ref:`backupdataall`
function, on more than one pods.
It concurrenlty runs a job Pod for each workload Pod, that mounts the
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.

.. note::
Expand Down Expand Up @@ -493,8 +493,8 @@ Example:

Consider a scenario where you wish to restore the data backed up by the
:ref:`backupdataall` function. We will first scale down the application,
restore the data and then scale it back up. We will not specify `pods`
arg, so this function will restore data on all pods concurrently.
restore the data and then scale it back up. We will not specify `pods` in
args, so this function will restore data on all pods concurrently.
For this phase, we will use the `params` Artifact provided by
BackupDataAll function.

Expand Down Expand Up @@ -588,8 +588,8 @@ 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
`backupTag`, No, `string`, (required if backupIdentifier not provided)unique tag added during the backup
`backupIdentifier`, No, `string`, (required if backupTag not provided) unique snapshot id generated by restic 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

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

0 comments on commit 03328ea

Please sign in to comment.