Skip to content

feat(rdb): add apply maintenance #2029

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.

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

Merged
merged 1 commit into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 49 additions & 0 deletions api/documentdb/v1beta1/documentdb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -437,6 +437,7 @@ const (
MaintenanceStatusPending = MaintenanceStatus("pending")
MaintenanceStatusDone = MaintenanceStatus("done")
MaintenanceStatusCanceled = MaintenanceStatus("canceled")
MaintenanceStatusOngoing = MaintenanceStatus("ongoing")
)

func (enum MaintenanceStatus) String() string {
Expand Down Expand Up @@ -899,6 +900,9 @@ type Maintenance struct {
// Status: status of the maintenance.
// Default value: unknown
Status MaintenanceStatus `json:"status"`

// ForcedAt: time when Scaleway-side maintenance will be applied.
ForcedAt *time.Time `json:"forced_at"`
}

// ReadReplica: read replica.
Expand Down Expand Up @@ -1317,6 +1321,15 @@ type AddInstanceSettingsResponse struct {
Settings []*InstanceSetting `json:"settings"`
}

// ApplyInstanceMaintenanceRequest: apply instance maintenance request.
type ApplyInstanceMaintenanceRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`

// InstanceID: UUID of the Database Instance to which you want to apply maintenance.
InstanceID string `json:"-"`
}

// CloneInstanceRequest: clone instance request.
type CloneInstanceRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Expand Down Expand Up @@ -4069,3 +4082,39 @@ func (s *API) MigrateEndpoint(req *MigrateEndpointRequest, opts ...scw.RequestOp
}
return &resp, nil
}

// ApplyInstanceMaintenance: Apply a pending instance maintenance on your instance. This action can generate some service interruption.
func (s *API) ApplyInstanceMaintenance(req *ApplyInstanceMaintenanceRequest, opts ...scw.RequestOption) (*Maintenance, error) {
var err error

if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}

if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}

if fmt.Sprint(req.InstanceID) == "" {
return nil, errors.New("field InstanceID cannot be empty in request")
}

scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/document-db/v1beta1/regions/" + fmt.Sprint(req.Region) + "/instances/" + fmt.Sprint(req.InstanceID) + "/apply-maintenance",
}

err = scwReq.SetBody(req)
if err != nil {
return nil, err
}

var resp Maintenance

err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}
49 changes: 49 additions & 0 deletions api/rdb/v1/rdb_sdk.go
Original file line number Diff line number Diff line change
Expand Up @@ -507,6 +507,7 @@ const (
MaintenanceStatusPending = MaintenanceStatus("pending")
MaintenanceStatusDone = MaintenanceStatus("done")
MaintenanceStatusCanceled = MaintenanceStatus("canceled")
MaintenanceStatusOngoing = MaintenanceStatus("ongoing")
)

func (enum MaintenanceStatus) String() string {
Expand Down Expand Up @@ -969,6 +970,9 @@ type Maintenance struct {
// Status: status of the maintenance.
// Default value: unknown
Status MaintenanceStatus `json:"status"`

// ForcedAt: time when Scaleway-side maintenance will be applied.
ForcedAt *time.Time `json:"forced_at"`
}

// ReadReplica: read replica.
Expand Down Expand Up @@ -1436,6 +1440,15 @@ type AddInstanceSettingsResponse struct {
Settings []*InstanceSetting `json:"settings"`
}

// ApplyInstanceMaintenanceRequest: apply instance maintenance request.
type ApplyInstanceMaintenanceRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Region scw.Region `json:"-"`

// InstanceID: UUID of the Database Instance you want to apply maintenance.
InstanceID string `json:"-"`
}

// CloneInstanceRequest: clone instance request.
type CloneInstanceRequest struct {
// Region: region to target. If none is passed will use default region from the config.
Expand Down Expand Up @@ -4622,3 +4635,39 @@ func (s *API) MigrateEndpoint(req *MigrateEndpointRequest, opts ...scw.RequestOp
}
return &resp, nil
}

// ApplyInstanceMaintenance: Apply maintenance tasks to your Database Instance. This will trigger pending maintenance tasks to start in your Database Instance and can generate service interruption. Maintenance tasks can be applied between `starts_at` and `stops_at` times, and are run directly by Scaleway at `forced_at` timestamp.
func (s *API) ApplyInstanceMaintenance(req *ApplyInstanceMaintenanceRequest, opts ...scw.RequestOption) (*Maintenance, error) {
var err error

if req.Region == "" {
defaultRegion, _ := s.client.GetDefaultRegion()
req.Region = defaultRegion
}

if fmt.Sprint(req.Region) == "" {
return nil, errors.New("field Region cannot be empty in request")
}

if fmt.Sprint(req.InstanceID) == "" {
return nil, errors.New("field InstanceID cannot be empty in request")
}

scwReq := &scw.ScalewayRequest{
Method: "POST",
Path: "/rdb/v1/regions/" + fmt.Sprint(req.Region) + "/instances/" + fmt.Sprint(req.InstanceID) + "/apply-maintenance",
}

err = scwReq.SetBody(req)
if err != nil {
return nil, err
}

var resp Maintenance

err = s.client.Do(scwReq, &resp, opts...)
if err != nil {
return nil, err
}
return &resp, nil
}