Documentation update, added info about the cloud storage UI (#3724)

main
amotovx 4 years ago committed by GitHub
parent 701168af8a
commit 4d8172c64a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -0,0 +1,62 @@
---
title: 'Attach cloud storage'
linkTitle: 'Attach cloud storage'
weight: 21
description: 'Instructions on how to attach cloud storage using UI'
---
In CVAT you can use AWS-S3 and Azure Blob Container cloud storages to store image datasets for your tasks.
Initially you need to create a manifest file for your image dataset. Information on how to do that is available
on the [Simple command line to prepare dataset manifest file](/docs/manual/advanced/dataset_manifest) page.
After the manifest file has been created, you can upload it and your dataset to an AWS-S3 or
Azure Blob Container cloud storage.
After that you will be able to attach a cloud storage. To do this, press the `Attach new cloud storage`
button on the `Cloud storages` page and fill out the following form:
![](/images/image228.jpg)
- `Display name` - the display name of the cloud storage.
- `Description` (optional) - description of the cloud storage, appears when you click on the `?` button
of an item on cloud storages page.
- `Provider` - choose provider of the cloud storage:
- [AWS-S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/GetStartedWithS3.html):
- `Bucket` - cloud storage bucket name
- [`Authorization type`](https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-control-best-practices.html):
- `Key id and secret access key pair`:
- `ACCESS KEY ID`
- `SECRET ACCESS KEY ID`
- `Anonymous access`
- `Region` - here you can choose a region from the list or add a new one. To get more information click
on [`?`](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions)
</br>
- [Azure Blob Container](https://docs.microsoft.com/en-us/azure/storage/blobs/):
- `Container name` - name of the cloud storage container
- `Authorization type`:
- [`Account name and SAS token`](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/document-translation/create-sas-tokens?tabs=blobs):
- `Account name`
- `SAS token`
- [`Anonymous access`](https://docs.microsoft.com/en-us/azure/storage/blobs/anonymous-read-access-configure?tabs=portal)
- `Account name`
</br>
- `Manifest` - the path to the manifest file on your cloud storage.
You can add multiple file manifests using the `Add manifest` button.
For more information click on [`?`](/docs/manual/advanced/dataset_manifest/).
To publish the cloud storage, click `submit`, after which it will be available on
the [Cloud storages page](/docs/manual/basics/cloud-storages/).

@ -0,0 +1,23 @@
---
title: 'Cloud storages page'
linkTitle: 'Cloud storages page'
weight: 20
description: 'Overview of the cloud storages page.'
---
![](/images/image227.jpg)
The cloud storagespagecontainselements,eachofthemrelatingtoaseparatecloud storage.
Eachelementcontains:preview, cloud storagename,provider, creation and update info, status,
`?` button for displaying the descriptionand theactions menu.
Eachbuttoninthe action menu is responsible for aspecificfunction:
- `Update`update this cloud storage
- `Delete`delete cloud storage.
![](/images/cloud_storage_icon.jpg)
This preview will appear when it is impossible to get a real preview (e.g. storage is empty or
invalid credentials were used).
Click the `Attach a new storage` button to [attach a new storage](/docs/manual/basics/attach-cloud-storage/).

@ -76,6 +76,9 @@ If you select tab `Connected file share` you can choose files for annotation fro
If you select ` Remote source` , you'll see a field where you can enter a list of URLs (one URL per line).
If you upload a video or dataset with images and select `Use cache` option, you can attach a `manifest.jsonl` file.
You can find how to prepare it [here](/docs/manual/advanced/dataset_manifest/).
If you select the `Cloud Storage` tab, you can select a cloud storage (for this type the cloud storage name),
after that choose the manifest file and select the required files.
For more information on how to attach cloud storage, see [attach cloud storage](/docs/manual/basics/attach-cloud-storage/)
![](/images/image127.jpg)

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Loading…
Cancel
Save