Skip to content

Commit

Permalink
Update docs (kanisterio#3253)
Browse files Browse the repository at this point in the history
  • Loading branch information
pavannd1 authored and Alex Vorbau committed Jun 22, 2018
1 parent 31b7291 commit 267b362
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/functions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,7 @@ ScaleWorkload.

`namespace`, Yes, `string`, namespace in which to execute
`image`, Yes, `string`, image to be used the command
`volumes`, Yes, `map[string]string`, Mapping of `pvcName`
to `mountPath` under which the volume will be available
`volumes`, Yes, `map[string]string`, Mapping of `pvcName` to `mountPath` under which the volume will be available
`command`, Yes, `[]string`, command list to execute

.. note::
Expand Down Expand Up @@ -313,15 +312,18 @@ by the specified Pod and restores data to the specified path.
:widths: 5,5,5,15

`namespace`, Yes, `string`, namespace in which to execute
`pod`, Yes, `string`, pod to which the volumes are attached
`image`, Yes, `string`, image to be used for running restore
`backupArtifact`, Yes, `string`, path to the backup on the object store
`restorePath`, Yes, `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

.. note::
The `image` argument requires the use of `kanisterio/kanister-tools`
image since it includes the required tools to restore data from
the S3 compatible object store.
Between the `pod` and `volumes` arguments, exactly one argument
must be specified.

Example:

Expand Down

0 comments on commit 267b362

Please sign in to comment.