Skip to content

Commit

Permalink
chore: modified documentation due changes
Browse files Browse the repository at this point in the history
  • Loading branch information
PacoDw committed Dec 26, 2019
1 parent ae4ec77 commit c4b4a48
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions website/docs/r/maintenance_window.html.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,18 @@ description: |-

# mongodbatlas_maintenance_window

`mongodbatlas_maintenance_window` provides a resource to take a scheduled maintenance event for a project up to two times.
Deferred maintenance events occur during your preferred maintenance window exactly one week after the previously scheduled date and time.
`mongodbatlas_maintenance_window` provides a resource to schedule maintenance window for your MongoDB Atlas Project, defer a scheduled maintenance up to two times, and to start an available maintenance ASAP.

-> **NOTE:** Groups and projects are synonymous terms. You may find `groupId` in the official documentation.

## Maintenance Window Considerations:
- Urgent Maintenance Activities Cannot Wait: Urgent maintenance activities such as security patches cannot wait for your chosen window. Atlas will start those maintenance activities when needed.

Once maintenance is scheduled for your cluster, you cannot change your maintenance window until the current maintenance efforts have completed.
- Maintenance Requires Replica Set Elections: Atlas performs maintenance the same way as the manual maintenance procedure. This requires at least one replica set election during the maintenance window per replica set.
- Maintenance Starts As Close to the Hour As Possible: Maintenance always begins as close to the scheduled hour as possible, but in-progress cluster updates or expected system issues could delay the start time.


## Example Usage

```hcl
Expand All @@ -24,13 +31,20 @@ Deferred maintenance events occur during your preferred maintenance window exact
```

```hcl
resource "mongodbatlas_maintenance_window" "test" {
project_id = "<your-project-id>"
defer = true
}
```

## Argument Reference

* `project_id` - The unique identifier of the project for the Maintenance Window.
* `day_of_week` - Day of the week when you would like the maintenance window to start as a 1-based integer: S=1, M=2, T=3, W=4, T=5, F=6, S=7.
* `hour_of_day` - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12.
* `hour_of_day` - Hour of the day when you would like the maintenance window to start. This parameter uses the 24-hour clock, where midnight is 0, noon is 12 (Time zone is UTC).
* `start_asap` - Flag indicating whether project maintenance has been directed to start immediately. If you request that maintenance begin immediately, this field returns true from the time the request was made until the time the maintenance event completes.
* `number_of_deferrals` - Number of times the current maintenance event for this project has been deferred.
* `number_of_deferrals` - Number of times the current maintenance event for this project has been deferred, you can set a maximum of 2 deferrals.
* `defer` - Defer maintenance for the given project for one week.

-> **NOTE:** The `start_asap` attribute can't be used because of breaks the Terraform flow, but you can enable via API.
Expand Down

0 comments on commit c4b4a48

Please sign in to comment.