Skip to content

Commit e16bb57

Browse files
authored
[Maintenance] Add Common Api Import (#1897)
1 parent 1fa4a6b commit e16bb57

23 files changed

+83
-78
lines changed

.golangci.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,8 @@ linters-settings:
8787
pkg: github.com/arangodb/kube-arangodb/integrations/storage/v2/shared/s3
8888
- alias: pbStorageV2
8989
pkg: github.com/arangodb/kube-arangodb/integrations/storage/v2/definition
90+
- alias: api
91+
pkg: github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1
9092
- alias: analyticsApi
9193
pkg: github.com/arangodb/kube-arangodb/pkg/apis/analytics/v1alpha1
9294
- alias: mlApiv1alpha1
@@ -97,6 +99,8 @@ linters-settings:
9799
pkg: github.com/arangodb/kube-arangodb/pkg/apis/networking/v1alpha1
98100
- alias: platformApi
99101
pkg: github.com/arangodb/kube-arangodb/pkg/apis/platform/v1alpha1
102+
- alias: platformAuthenticationApi
103+
pkg: github.com/arangodb/kube-arangodb/pkg/apis/platform/v1alpha1/authentication
100104
- alias: schedulerApiv1alpha1
101105
pkg: github.com/arangodb/kube-arangodb/pkg/apis/scheduler/v1alpha1
102106
- alias: schedulerContainerApiv1alpha1

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
- (Feature) (Platform) OpenID Integration - API Extension
1212
- (Feature) Windows Platform CLI
1313
- (Feature) (Platform) Auth User Creation
14+
- (Maintenance) Add Common Api Import
1415

1516
## [1.2.48](https://github.com/arangodb/kube-arangodb/tree/1.2.48) (2025-05-08)
1617
- (Maintenance) Extend Documentation

cmd/lifecycle_wait.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2022 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2025 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -28,7 +28,7 @@ import (
2828

2929
"github.com/spf13/cobra"
3030

31-
v1 "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
31+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
3232
"github.com/arangodb/kube-arangodb/pkg/util"
3333
"github.com/arangodb/kube-arangodb/pkg/util/constants"
3434
)
@@ -82,7 +82,7 @@ func cmdLifecycleWaitCheck(cmd *cobra.Command, _ []string) {
8282
}
8383

8484
if isUpToDate {
85-
logger.Info(fmt.Sprintf("ArangoDeployment: %s is %s", d.Name, v1.ConditionTypeUpToDate))
85+
logger.Info(fmt.Sprintf("ArangoDeployment: %s is %s", d.Name, api.ConditionTypeUpToDate))
8686
return
8787
}
8888

@@ -93,7 +93,7 @@ func cmdLifecycleWaitCheck(cmd *cobra.Command, _ []string) {
9393
logger.Info("ArangoDeployment: %s is not ready yet. Waiting...", d.Name)
9494
continue
9595
case <-time.After(watchTimeout):
96-
logger.Error("ArangoDeployment: %s is not %s yet - operation timed out!", d.Name, v1.ConditionTypeUpToDate)
96+
logger.Error("ArangoDeployment: %s is not %s yet - operation timed out!", d.Name, api.ConditionTypeUpToDate)
9797
return
9898
}
9999
}

internal/cr_validation_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ import (
3636
analyticsApi "github.com/arangodb/kube-arangodb/pkg/apis/analytics/v1alpha1"
3737
appsv1 "github.com/arangodb/kube-arangodb/pkg/apis/apps/v1"
3838
backupv1 "github.com/arangodb/kube-arangodb/pkg/apis/backup/v1"
39-
deploymentv1 "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
39+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
4040
deploymentv2alpha1 "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v2alpha1"
4141
mlApiv1alpha1 "github.com/arangodb/kube-arangodb/pkg/apis/ml/v1alpha1"
4242
mlApi "github.com/arangodb/kube-arangodb/pkg/apis/ml/v1beta1"
@@ -106,7 +106,7 @@ func Test_GenerateCRValidationSchemas(t *testing.T) {
106106
fmt.Sprintf("%s/pkg/apis/deployment", root): {
107107
"v1": {
108108
objects: map[string]interface{}{
109-
"spec": deploymentv1.ArangoDeployment{}.Spec,
109+
"spec": api.ArangoDeployment{}.Spec,
110110
},
111111
},
112112
"v2alpha1": {
@@ -120,7 +120,7 @@ func Test_GenerateCRValidationSchemas(t *testing.T) {
120120
fmt.Sprintf("%s/pkg/apis/deployment", root): {
121121
"v1": {
122122
objects: map[string]interface{}{
123-
"spec": deploymentv1.ArangoMember{}.Spec,
123+
"spec": api.ArangoMember{}.Spec,
124124
},
125125
},
126126
"v2alpha1": {
@@ -134,7 +134,7 @@ func Test_GenerateCRValidationSchemas(t *testing.T) {
134134
fmt.Sprintf("%s/pkg/apis/deployment", root): {
135135
"v1": {
136136
objects: map[string]interface{}{
137-
"spec": deploymentv1.ArangoClusterSynchronization{}.Spec,
137+
"spec": api.ArangoClusterSynchronization{}.Spec,
138138
},
139139
},
140140
"v2alpha1": {
@@ -148,7 +148,7 @@ func Test_GenerateCRValidationSchemas(t *testing.T) {
148148
fmt.Sprintf("%s/pkg/apis/deployment", root): {
149149
"v1": {
150150
objects: map[string]interface{}{
151-
"spec": deploymentv1.ArangoTask{}.Spec,
151+
"spec": api.ArangoTask{}.Spec,
152152
},
153153
},
154154
"v2alpha1": {

internal/docs_test.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import (
4141
analyticsApi "github.com/arangodb/kube-arangodb/pkg/apis/analytics/v1alpha1"
4242
appsApi "github.com/arangodb/kube-arangodb/pkg/apis/apps/v1"
4343
backupApi "github.com/arangodb/kube-arangodb/pkg/apis/backup/v1"
44-
deploymentApi "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
44+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
4545
mlApiv1alpha1 "github.com/arangodb/kube-arangodb/pkg/apis/ml/v1alpha1"
4646
mlApi "github.com/arangodb/kube-arangodb/pkg/apis/ml/v1beta1"
4747
networkingApi "github.com/arangodb/kube-arangodb/pkg/apis/networking/v1alpha1"
@@ -172,10 +172,10 @@ func Test_GenerateAPIDocs(t *testing.T) {
172172
"v1": {
173173
Types: inputPackageTypes{
174174
"ArangoDeployment.V1": {
175-
"Spec": deploymentApi.ArangoDeployment{}.Spec,
175+
"Spec": api.ArangoDeployment{}.Spec,
176176
},
177177
"ArangoMember.V1": {
178-
"Spec": deploymentApi.ArangoMember{}.Spec,
178+
"Spec": api.ArangoMember{}.Spec,
179179
},
180180
},
181181
Shared: []string{

pkg/apis/backup/v1/backup_policy.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
//
22
// DISCLAIMER
33
//
4-
// Copyright 2016-2023 ArangoDB GmbH, Cologne, Germany
4+
// Copyright 2016-2025 ArangoDB GmbH, Cologne, Germany
55
//
66
// Licensed under the Apache License, Version 2.0 (the "License");
77
// you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ import (
2525

2626
meta "k8s.io/apimachinery/pkg/apis/meta/v1"
2727

28-
deployment "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
28+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
2929
"github.com/arangodb/kube-arangodb/pkg/handlers/utils"
3030
)
3131

@@ -51,7 +51,7 @@ type ArangoBackupPolicy struct {
5151
Status ArangoBackupPolicyStatus `json:"status"`
5252
}
5353

54-
func (a *ArangoBackupPolicy) NewBackup(d *deployment.ArangoDeployment) *ArangoBackup {
54+
func (a *ArangoBackupPolicy) NewBackup(d *api.ArangoDeployment) *ArangoBackup {
5555
policyName := a.Name
5656

5757
spec := &ArangoBackupSpec{

pkg/deployment/pod/builder.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,20 @@ import (
2424
core "k8s.io/api/core/v1"
2525
meta "k8s.io/apimachinery/pkg/apis/meta/v1"
2626

27-
deploymentApi "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
27+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
2828
"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
2929
"github.com/arangodb/kube-arangodb/pkg/util/k8sutil/interfaces"
3030
)
3131

3232
type Input struct {
3333
ApiObject meta.Object
34-
Deployment deploymentApi.DeploymentSpec
35-
Status deploymentApi.DeploymentStatus
36-
GroupSpec deploymentApi.ServerGroupSpec
37-
Group deploymentApi.ServerGroup
38-
Image deploymentApi.ImageInfo
39-
Member deploymentApi.MemberStatus
40-
ArangoMember deploymentApi.ArangoMember
34+
Deployment api.DeploymentSpec
35+
Status api.DeploymentStatus
36+
GroupSpec api.ServerGroupSpec
37+
Group api.ServerGroup
38+
Image api.ImageInfo
39+
Member api.MemberStatus
40+
ArangoMember api.ArangoMember
4141
AutoUpgrade bool
4242
}
4343

pkg/deployment/pod/upgrade.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ package pod
2323
import (
2424
core "k8s.io/api/core/v1"
2525

26-
deploymentApi "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
26+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
2727
"github.com/arangodb/kube-arangodb/pkg/util/k8sutil"
2828
"github.com/arangodb/kube-arangodb/pkg/util/k8sutil/interfaces"
2929
)
@@ -50,7 +50,7 @@ func (u autoUpgrade) Args(i Input) k8sutil.OptionPairs {
5050
// Always add upgrade flag due to fact it is now only in initContainers
5151
if i.Image.ArangoDBVersion.CompareTo("3.6.0") >= 0 {
5252
switch i.Group {
53-
case deploymentApi.ServerGroupCoordinators:
53+
case api.ServerGroupCoordinators:
5454
return k8sutil.NewOptionPair(k8sutil.OptionPair{Key: "--cluster.upgrade", Value: "online"})
5555
}
5656
}

pkg/deployment/resources/servicemonitor.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ import (
3030
"k8s.io/apimachinery/pkg/runtime/schema"
3131

3232
"github.com/arangodb/kube-arangodb/pkg/apis/deployment"
33-
deploymentApi "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
33+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
3434
"github.com/arangodb/kube-arangodb/pkg/util/constants"
3535
"github.com/arangodb/kube-arangodb/pkg/util/errors"
3636
"github.com/arangodb/kube-arangodb/pkg/util/globals"
@@ -39,7 +39,7 @@ import (
3939
"github.com/arangodb/kube-arangodb/pkg/util/kclient"
4040
)
4141

42-
func LabelsForExporterServiceMonitor(name string, obj deploymentApi.DeploymentSpec) map[string]string {
42+
func LabelsForExporterServiceMonitor(name string, obj api.DeploymentSpec) map[string]string {
4343
base := LabelsForExporterServiceMonitorSelector(name)
4444

4545
for k, v := range obj.Metrics.ServiceMonitor.GetLabels(map[string]string{
@@ -87,7 +87,7 @@ func (r *Resources) serviceMonitorSpec() (monitoringApi.ServiceMonitorSpec, erro
8787

8888
//nolint:staticcheck
8989
switch spec.Metrics.Mode.Get() {
90-
case deploymentApi.MetricsModeInternal:
90+
case api.MetricsModeInternal:
9191
if spec.Metrics.Authentication.JWTTokenSecretName == nil {
9292
return monitoringApi.ServiceMonitorSpec{}, apiErrors.NewNotFound(schema.GroupResource{Group: "v1/secret"}, "metrics-secret")
9393
}

pkg/handlers/backup/arango_client.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import (
2626
"github.com/arangodb/go-driver"
2727

2828
backupApi "github.com/arangodb/kube-arangodb/pkg/apis/backup/v1"
29-
database "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
29+
api "github.com/arangodb/kube-arangodb/pkg/apis/deployment/v1"
3030
"github.com/arangodb/kube-arangodb/pkg/handlers/utils"
3131
)
3232

@@ -41,7 +41,7 @@ var (
4141
)
4242

4343
// ArangoClientFactory factory type for creating clients
44-
type ArangoClientFactory func(deployment *database.ArangoDeployment, backup *backupApi.ArangoBackup) (ArangoBackupClient, error)
44+
type ArangoClientFactory func(deployment *api.ArangoDeployment, backup *backupApi.ArangoBackup) (ArangoBackupClient, error)
4545

4646
// ArangoBackupProgress progress info
4747
type ArangoBackupProgress struct {

0 commit comments

Comments
 (0)