Skip to content

Commit

Permalink
Documented the option timeout
Browse files Browse the repository at this point in the history
  • Loading branch information
marikrg committed Mar 21, 2017
1 parent b033829 commit 7b0b921
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 8 deletions.
6 changes: 3 additions & 3 deletions RESOURCES.md
Original file line number Diff line number Diff line change
Expand Up @@ -582,14 +582,14 @@ Example file: [volume_template.pp](examples/volume_template.pp)

This resource provides the following ensurable methods for managing Artifact Bundles on the Image Streamer appliance:

* `present` - Adds, uploads, or updates an artifact bundle resource based upon the attributes specified within `data`.
* `present` - Adds, uploads, or updates an artifact bundle resource based upon the attributes specified within `data`. If you are adding an artifact bundle zip file, you can set a `timeout` (in seconds) within the `data`.
* `found` - Searches for `image_streamer_artifact_bundle` resources on the appliance (with or without specific filters) and prints the name and uri of matches to the standard output.
* `extract` - Extracts an artifact bundle and creates the artifacts on the appliance.
* `download` - Downloads the content of an artifact bundle to a local drive.
* `get_backups` - Gets information about the backups.
* `extract_backup` - Extracts the existing backup bundle on the appliance and creates all the artifacts. :exclamation: If there are any artifacts existing, they will be removed before the extract operation.
* `create_backup` - Creates a backup bundle with all the artifacts present on the appliance. At any given point only one backup bundle will exist on the appliance.
* `create_backup_from_file` - Uploads a backup bundle from a local drive and extracts all the artifacts present in the uploaded file. :exclamation: If there are any artifacts existing, they will be removed before the extract operation.
* `create_backup_from_file` - Uploads a backup bundle from a local drive and extracts all the artifacts present in the uploaded file. You can set a `timeout` (in seconds) within the `data`. :exclamation: If there are any artifacts existing, they will be removed before the extract operation.
* `download_backup` - Downloads a backup.
* `absent` - Deletes an Artifact Bundle.

Expand Down Expand Up @@ -629,7 +629,7 @@ Example file: [deployment_group.pp](examples/image_streamer/deployment_group.pp)

This resource provides the following ensurable methods for managing Golden Images on the Image Streamer appliance:

* `present` - Adds or updates a golden resource based upon the attributes specified within `data`.
* `present` - Adds or updates a golden resource based upon the attributes specified within `data`. If you are adding a golden image zip file, you can set a `timeout` (in seconds) within the `data`.
* `found` - Searches for `image_streamer_golden_image` resources on the appliance (with or without specific filters) and prints the name and uri of matches to the standard output.
* `download` - Downloads the content of a golden image.
* `download_details_archive` - Downloads the details of the golden image capture logs which has been archived.
Expand Down
4 changes: 2 additions & 2 deletions examples/image_streamer/artifact_bundle.pp
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
data => {
name => 'Artifact_Bundle_2_Puppet',
artifact_bundle_path => 'examples/image_streamer/artifact_bundle.zip', # can be either an absolute or relative path
timeout => 3600
timeout => 3600 # you can set a timeout (in seconds) for the upload
}
}

Expand Down Expand Up @@ -112,7 +112,7 @@
data => {
deploymentGroupUri => 'OSDS',
backup_upload_path => 'examples/image_streamer/ci-backup2017-03-01T17_40_31.628Z.zip', # can be either an absolute or relative path
timeout => 3600
timeout => 3600 # you can set a timeout (in seconds) for the upload
}
}

Expand Down
2 changes: 1 addition & 1 deletion examples/image_streamer/golden_image.pp
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
name => 'Golden_Image_2',
description => 'Golden image added from the file that is uploaded from a local drive',
golden_image_path => 'golden_image.zip', # can be either an absolute or relative path
timeout => 3600
timeout => 3600 # you can set a timeout (in seconds) for the upload
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,9 @@ def exists?

def create
current_resource = @resourcetype.find_by(@client, unique_id).first
return super unless @golden_image_path && !current_resource
timeout = @data.delete('timeout') || OneviewSDK::Rest::READ_TIMEOUT
return super unless @golden_image_path && !current_resource
@resourcetype.add(@client, @golden_image_path, @data, timeout)
true
end

def download_details_archive
Expand Down

0 comments on commit 7b0b921

Please sign in to comment.