Skip to content

Commit 8371758

Browse files
ajanikowajanikow
authored
[Feature] Action PlaceHolder (#1121)
1 parent 39532e8 commit 8371758

File tree

9 files changed

+97
-0
lines changed

9 files changed

+97
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Change Log
22

33
## [master](https://github.com/arangodb/kube-arangodb/tree/master) (N/A)
4+
- (Feature) Define Actions PlaceHolder
45

56
## [1.2.17](https://github.com/arangodb/kube-arangodb/tree/1.2.17) (2022-09-22)
67
- (Feature) Add new field to DeploymentReplicationStatus with details on DC2DC sync status=

‎docs/generated/actions.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141
| MemberRIDUpdate | 10m0s | Community & Enterprise | Update Run ID of member |
4242
| PVCResize | 30m0s | Community & Enterprise | Start the resize procedure. Updates PVC Requests field |
4343
| PVCResized | 15m0s | Community & Enterprise | Waits for PVC resize to be completed |
44+
| PlaceHolder | 10m0s | Community & Enterprise | Empty placeholder action |
4445
| RebalancerCheck | 10m0s | Enterprise Only | Check Rebalancer job progress |
4546
| RebalancerClean | 10m0s | Enterprise Only | Cleans Rebalancer jobs |
4647
| RebalancerGenerate | 10m0s | Enterprise Only | Generates the Rebalancer plan |
@@ -121,6 +122,7 @@ spec:
121122
MemberRIDUpdate: 10m0s
122123
PVCResize: 30m0s
123124
PVCResized: 15m0s
125+
PlaceHolder: 10m0s
124126
RebalancerCheck: 10m0s
125127
RebalancerClean: 10m0s
126128
RebalancerGenerate: 10m0s

‎internal/actions.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
default_timeout: 10m
44

55
actions:
6+
PlaceHolder:
7+
description: Empty placeholder action
68
Idle:
79
description: Define idle operation in case if preconditions are not meet
810
AddMember:

‎pkg/apis/deployment/v1/actions.generated.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ const (
9999
ActionPVCResizeDefaultTimeout time.Duration = 1800 * time.Second // 30m0s
100100
// ActionPVCResizedDefaultTimeout define default timeout for action ActionPVCResized
101101
ActionPVCResizedDefaultTimeout time.Duration = 900 * time.Second // 15m0s
102+
// ActionPlaceHolderDefaultTimeout define default timeout for action ActionPlaceHolder
103+
ActionPlaceHolderDefaultTimeout time.Duration = ActionsDefaultTimeout
102104
// ActionRebalancerCheckDefaultTimeout define default timeout for action ActionRebalancerCheck
103105
ActionRebalancerCheckDefaultTimeout time.Duration = ActionsDefaultTimeout
104106
// ActionRebalancerCleanDefaultTimeout define default timeout for action ActionRebalancerClean
@@ -246,6 +248,8 @@ const (
246248
ActionTypePVCResize ActionType = "PVCResize"
247249
// ActionTypePVCResized in scopes Normal. Waits for PVC resize to be completed
248250
ActionTypePVCResized ActionType = "PVCResized"
251+
// ActionTypePlaceHolder in scopes Normal. Empty placeholder action
252+
ActionTypePlaceHolder ActionType = "PlaceHolder"
249253
// ActionTypeRebalancerCheck in scopes Normal. Check Rebalancer job progress
250254
ActionTypeRebalancerCheck ActionType = "RebalancerCheck"
251255
// ActionTypeRebalancerClean in scopes Normal. Cleans Rebalancer jobs
@@ -394,6 +398,8 @@ func ActionDefaultTimeout(in ActionType) time.Duration {
394398
return ActionPVCResizeDefaultTimeout
395399
case ActionTypePVCResized:
396400
return ActionPVCResizedDefaultTimeout
401+
case ActionTypePlaceHolder:
402+
return ActionPlaceHolderDefaultTimeout
397403
case ActionTypeRebalancerCheck:
398404
return ActionRebalancerCheckDefaultTimeout
399405
case ActionTypeRebalancerClean:
@@ -545,6 +551,8 @@ func GetActionPriority(in ActionType) ActionPriority {
545551
return ActionPriorityNormal
546552
case ActionTypePVCResized:
547553
return ActionPriorityNormal
554+
case ActionTypePlaceHolder:
555+
return ActionPriorityNormal
548556
case ActionTypeRebalancerCheck:
549557
return ActionPriorityNormal
550558
case ActionTypeRebalancerClean:

‎pkg/apis/deployment/v2alpha1/actions.generated.go‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,8 @@ const (
9999
ActionPVCResizeDefaultTimeout time.Duration = 1800 * time.Second // 30m0s
100100
// ActionPVCResizedDefaultTimeout define default timeout for action ActionPVCResized
101101
ActionPVCResizedDefaultTimeout time.Duration = 900 * time.Second // 15m0s
102+
// ActionPlaceHolderDefaultTimeout define default timeout for action ActionPlaceHolder
103+
ActionPlaceHolderDefaultTimeout time.Duration = ActionsDefaultTimeout
102104
// ActionRebalancerCheckDefaultTimeout define default timeout for action ActionRebalancerCheck
103105
ActionRebalancerCheckDefaultTimeout time.Duration = ActionsDefaultTimeout
104106
// ActionRebalancerCleanDefaultTimeout define default timeout for action ActionRebalancerClean
@@ -246,6 +248,8 @@ const (
246248
ActionTypePVCResize ActionType = "PVCResize"
247249
// ActionTypePVCResized in scopes Normal. Waits for PVC resize to be completed
248250
ActionTypePVCResized ActionType = "PVCResized"
251+
// ActionTypePlaceHolder in scopes Normal. Empty placeholder action
252+
ActionTypePlaceHolder ActionType = "PlaceHolder"
249253
// ActionTypeRebalancerCheck in scopes Normal. Check Rebalancer job progress
250254
ActionTypeRebalancerCheck ActionType = "RebalancerCheck"
251255
// ActionTypeRebalancerClean in scopes Normal. Cleans Rebalancer jobs
@@ -394,6 +398,8 @@ func ActionDefaultTimeout(in ActionType) time.Duration {
394398
return ActionPVCResizeDefaultTimeout
395399
case ActionTypePVCResized:
396400
return ActionPVCResizedDefaultTimeout
401+
case ActionTypePlaceHolder:
402+
return ActionPlaceHolderDefaultTimeout
397403
case ActionTypeRebalancerCheck:
398404
return ActionRebalancerCheckDefaultTimeout
399405
case ActionTypeRebalancerClean:
@@ -545,6 +551,8 @@ func GetActionPriority(in ActionType) ActionPriority {
545551
return ActionPriorityNormal
546552
case ActionTypePVCResized:
547553
return ActionPriorityNormal
554+
case ActionTypePlaceHolder:
555+
return ActionPriorityNormal
548556
case ActionTypeRebalancerCheck:
549557
return ActionPriorityNormal
550558
case ActionTypeRebalancerClean:

‎pkg/deployment/reconcile/action.register.generated.go‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,9 @@ var (
138138
_ Action = &actionPVCResized{}
139139
_ actionFactory = newPVCResizedAction
140140

141+
_ Action = &actionPlaceHolder{}
142+
_ actionFactory = newPlaceHolderAction
143+
141144
_ Action = &actionRebalancerCheck{}
142145
_ actionFactory = newRebalancerCheckAction
143146

@@ -691,6 +694,18 @@ func init() {
691694
registerAction(action, function)
692695
}
693696

697+
// PlaceHolder
698+
{
699+
// Get Action defition
700+
function := newPlaceHolderAction
701+
action := api.ActionTypePlaceHolder
702+
703+
// Wrap action main function
704+
705+
// Register action
706+
registerAction(action, function)
707+
}
708+
694709
// RebalancerCheck
695710
{
696711
// Get Action defition

‎pkg/deployment/reconcile/action.register.generated_test.go‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,10 @@ func Test_Actions(t *testing.T) {
178178
ActionsExistence(t, api.ActionTypePVCResized)
179179
})
180180

181+
t.Run("PlaceHolder", func(t *testing.T) {
182+
ActionsExistence(t, api.ActionTypePlaceHolder)
183+
})
184+
181185
t.Run("RebalancerCheck", func(t *testing.T) {
182186
ActionsExistence(t, api.ActionTypeRebalancerCheck)
183187
})

‎pkg/deployment/reconcile/action_placeholder.community.go‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
//
2+
// DISCLAIMER
3+
//
4+
// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
5+
//
6+
// Licensed under the Apache License, Version 2.0 (the "License");
7+
// you may not use this file except in compliance with the License.
8+
// You may obtain a copy of the License at
9+
//
10+
// http://www.apache.org/licenses/LICENSE-2.0
11+
//
12+
// Unless required by applicable law or agreed to in writing, software
13+
// distributed under the License is distributed on an "AS IS" BASIS,
14+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
// See the License for the specific language governing permissions and
16+
// limitations under the License.
17+
//
18+
// Copyright holder is ArangoDB GmbH, Cologne, Germany
19+
//go:build !enterprise
20+
// +build !enterprise
21+
22+
package reconcile
23+
24+
type actionPlaceHolder struct {
25+
actionEmpty
26+
}

‎pkg/deployment/reconcile/action_placeholder.go‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
//
2+
// DISCLAIMER
3+
//
4+
// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
5+
//
6+
// Licensed under the Apache License, Version 2.0 (the "License");
7+
// you may not use this file except in compliance with the License.
8+
// You may obtain a copy of the License at
9+
//
10+
// http://www.apache.org/licenses/LICENSE-2.0
11+
//
12+
// Unless required by applicable law or agreed to in writing, software
13+
// distributed under the License is distributed on an "AS IS" BASIS,
14+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
// See the License for the specific language governing permissions and
16+
// limitations under the License.
17+
//
18+
// Copyright holder is ArangoDB GmbH, Cologne, Germany
19+
//
20+
21+
package reconcile
22+
23+
import api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
24+
25+
func newPlaceHolderAction(action api.Action, actionCtx ActionContext) Action {
26+
a := &actionPlaceHolder{}
27+
28+
a.actionImpl = newActionImplDefRef(action, actionCtx)
29+
30+
return a
31+
}

0 commit comments

Comments
 (0)