Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cloud versioning changes #4359

Merged
merged 1 commit into from
Mar 3, 2023
Merged

Cloud versioning changes #4359

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions content/docs/start/data-management/data-versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ set up earlier. The remote storage directory should look like this:
   └── a1a2931c8370d3aeedd7183606fd7f
```

If you prefer to keep human-readable filenames, you can use [cloud versioning].

[cloud versioning]: /doc/user-guide/data-management/cloud-versioning

</details>

Usually, we also want to `git commit` (and `git push`) the project config
Expand Down Expand Up @@ -241,11 +245,11 @@ $ type %TEMP%\data.xml >> data\data.xml
$ dvc add data/data.xml
```

Usually you would also run `git commit` and `dvc push` to save the changes:
Usually you would also run `dvc push` and `git commit` to save the changes:

```cli
$ git commit data/data.xml.dvc -m "Dataset updates"
$ dvc push
$ git commit data/data.xml.dvc -m "Dataset updates"
```

## Switching between versions
Expand Down
23 changes: 14 additions & 9 deletions content/docs/user-guide/data-management/cloud-versioning.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,5 @@
# Cloud Versioning

<admon type="warn">

Cloud versioning features are currently under active development and should be
considered experimental. These features are subject to frequent change, and the
documentation may not always reflect changes available in the latest DVC
release.

</admon>

When cloud versioning is enabled, DVC will store files in the remote according
to their original directory location and filenames. Different versions of a file
will then be stored as separate versions of the corresponding object in cloud
Expand Down Expand Up @@ -66,6 +57,20 @@ Currently, it is supported on the following `dvc remote` types:
/doc/user-guide/data-management/remote-storage/google-cloud-storage
[object versioning]: https://cloud.google.com/storage/docs/object-versioning

Lifecycle management policies may delete object versions, in which case DVC will
be unable to recover those versions. For more information about lifecycle
management, see:

- [Amazon S3]
- Microsoft [Azure Blob Storage]
- [Google Cloud Storage]

[amazon s3]:
https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html
[azure blob storage]:
https://learn.microsoft.com/en-us/azure/storage/blobs/lifecycle-management-policy-configure
[google cloud storage]: https://cloud.google.com/storage/docs/lifecycle

## Version-aware remotes

When the `version_aware` option is enabled on a `dvc remote`:
Expand Down
7 changes: 3 additions & 4 deletions content/docs/user-guide/how-to/update-tracked-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,11 @@ Add the new version of the file back with DVC:

```cli
$ dvc add train.tsv
$ dvc push # If you have remote storage.

$ git add train.tsv.dvc
$ git commit -m "modify train data"

# If you have remote storage and/or an upstream repo:
$ dvc push
$ git push
$ git push # If you have an upstream repo.
```

## Replacing files
Expand Down