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

doc: Marking online archive as preview feature for GCP #2802

Merged
merged 3 commits into from
Nov 15, 2024
Merged

doc: Marking online archive as preview feature for GCP #2802

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
aa3c5cd
change to online archive resource doc
cveticm Nov 14, 2024
8b7f745
changing location of private preview information
cveticm Nov 14, 2024
6f14c42
implemented review feedback
cveticm Nov 15, 2024
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
4 changes: 3 additions & 1 deletion docs/resources/online_archive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@

~> **IMPORTANT:** There are fields that are immutable after creation, i.e if `date_field` value does not exist in the collection, the online archive state will be pending forever, and this field cannot be updated, that means a destroy is required, known error `ONLINE_ARCHIVE_CANNOT_MODIFY_FIELD`

~> **IMPORTANT:** Support for Online Archive on `GCP` is available in Private Preview. To request access and participate in the Private Preview release of this feature, see the [registration sign-up](https://www.mongodb.com/products/platform/atlas-online-archive#promo).
Copy link
Collaborator

@EspenAlbert EspenAlbert Nov 14, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, potentially I would remove release of this feature from:

To request access and participate in the Private Preview release of this feature

--> To request access and participate in the Private Preview, see the ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wording was taken from here. I think its clearer to keep it as is as the alternative wording to me suggests all of private preview will be accessible.

cveticm marked this conversation as resolved.
Show resolved Hide resolved

## Example Usages
```terraform
resource "mongodbatlas_online_archive" "test" {
Expand Down Expand Up @@ -139,7 +141,7 @@ The only field required for criteria type `CUSTOM`
* `expire_after_days` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.

### Data Process Region
* `cloud_provider` - Human-readable label that identifies the Cloud service provider where you wish to store your archived data. `AZURE` may be selected only if Azure is the Cloud service provider for the cluster and no AWS online archive has been created for the cluster.
* `cloud_provider` - Human-readable label that identifies the Cloud service provider where you wish to store your archived data. `AZURE` may be selected only if Azure is the Cloud service provider for the cluster and no AWS online archive has been created for the cluster.
* `region` - Human-readable label that identifies the geographic location of the region where you wish to store your archived data. For allowed values, see [MongoDB Atlas API documentation](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive)

### Schedule
Expand Down