Skip to content

Commit d894656

Browse files
ajanikowajanikow
authored
[Feature] [Platform] Improve Platform Components names (#1910)
1 parent 6f46af4 commit d894656

File tree

8 files changed

+49
-36
lines changed

8 files changed

+49
-36
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
- (Bugfix) Implement Missing Group Tolerations
2222
- (Feature) (Platform) OpenID Logout Endpoints
2323
- (Maintenance) Grade Doc Field
24+
- (Feature) (Platform) Improve Platform Components names
2425

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

‎docs/cli/arangodb_operator_platform.md

Lines changed: 32 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,9 @@ Available Commands:
4040
status Describes Charts Status
4141
4242
Flags:
43-
-h, --help help for registry
44-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
43+
-h, --help help for registry
44+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
45+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
4546
4647
Global Flags:
4748
-n, --namespace string Kubernetes Namespace (default "default")
@@ -60,11 +61,12 @@ Usage:
6061
arangodb_operator_platform registry install [flags] [...charts]
6162
6263
Flags:
63-
-a, --all Runs on all items
64-
-h, --help help for install
65-
-o, --output string Output format. Allowed table, json, yaml (default "table")
66-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
67-
-u, --upgrade Enable upgrade procedure
64+
-a, --all Runs on all items
65+
-h, --help help for install
66+
-o, --output string Output format. Allowed table, json, yaml (default "table")
67+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
68+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
69+
-u, --upgrade Enable upgrade procedure
6870
6971
Global Flags:
7072
-n, --namespace string Kubernetes Namespace (default "default")
@@ -81,9 +83,10 @@ Usage:
8183
arangodb_operator_platform registry status [flags]
8284
8385
Flags:
84-
-h, --help help for status
85-
-o, --output string Output format. Allowed table, json, yaml (default "table")
86-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
86+
-h, --help help for status
87+
-o, --output string Output format. Allowed table, json, yaml (default "table")
88+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
89+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
8790
8891
Global Flags:
8992
-n, --namespace string Kubernetes Namespace (default "default")
@@ -105,8 +108,9 @@ Available Commands:
105108
status Shows Service Status
106109
107110
Flags:
108-
-h, --help help for service
109-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
111+
-h, --help help for service
112+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
113+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
110114
111115
Global Flags:
112116
-n, --namespace string Kubernetes Namespace (default "default")
@@ -125,9 +129,10 @@ Usage:
125129
arangodb_operator_platform service enable [flags] deployment name chart
126130
127131
Flags:
128-
-h, --help help for enable
129-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
130-
-f, --values strings Chart values
132+
-h, --help help for enable
133+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
134+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
135+
-f, --values strings Chart values
131136
132137
Global Flags:
133138
-n, --namespace string Kubernetes Namespace (default "default")
@@ -144,9 +149,10 @@ Usage:
144149
arangodb_operator_platform service enable-service [flags] deployment chart
145150
146151
Flags:
147-
-h, --help help for enable-service
148-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
149-
-f, --values strings Chart values
152+
-h, --help help for enable-service
153+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
154+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
155+
-f, --values strings Chart values
150156
151157
Global Flags:
152158
-n, --namespace string Kubernetes Namespace (default "default")
@@ -163,9 +169,10 @@ Usage:
163169
arangodb_operator_platform service status [flags] deployment
164170
165171
Flags:
166-
-h, --help help for status
167-
-o, --output string Output format. Allowed table, json, yaml (default "table")
168-
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
172+
-h, --help help for status
173+
-o, --output string Output format. Allowed table, json, yaml (default "table")
174+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
175+
--platform.name string Kubernetes Platform Name (name of the ArangoDeployment)
169176
170177
Global Flags:
171178
-n, --namespace string Kubernetes Namespace (default "default")
@@ -203,7 +210,7 @@ Use "arangodb_operator_platform package [command] --help" for more information a
203210
Dumps the current setup of the platform
204211
205212
Usage:
206-
arangodb_operator_platform package dump [flags] deployment
213+
arangodb_operator_platform package dump [flags]
207214
208215
Flags:
209216
-h, --help help for dump
@@ -221,10 +228,11 @@ Global Flags:
221228
Installs the specified setup of the platform
222229
223230
Usage:
224-
arangodb_operator_platform package install [flags] deployment package
231+
arangodb_operator_platform package install [flags] package
225232
226233
Flags:
227-
-h, --help help for install
234+
-h, --help help for install
235+
--platform.endpoint string Platform Repository URL (default "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com")
228236
229237
Global Flags:
230238
-n, --namespace string Kubernetes Namespace (default "default")

‎pkg/apis/shared/names.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ import (
2828
)
2929

3030
var (
31-
arangodPrefixes = []string{"CRDN-", "PRMR-", "AGNT-", "SNGL-"}
31+
arangodPrefixes = []string{"CRDN-", "PRMR-", "AGNT-", "SNGL-", "GWAY-"}
3232
)
3333

3434
const (

‎pkg/deployment/resources/gateway/gateway_config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -290,7 +290,7 @@ func (c Config) RenderIntegrationSidecarFilter() (*httpConnectionManagerAPI.Http
290290
ClusterName: "integration_sidecar",
291291
},
292292
},
293-
Timeout: durationpb.New(500 * time.Millisecond),
293+
Timeout: durationpb.New(2 * time.Second),
294294
},
295295
},
296296
IncludePeerCertificate: true,

‎pkg/platform/flags.go

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ var (
6565
Description: "Platform Repository URL",
6666
Default: "https://arangodb-platform-prd-chart-registry.s3.amazonaws.com",
6767
Persistent: true,
68-
Hidden: true,
6968
}
7069

7170
flagUpgradeVersions = cli.Flag[bool]{

‎pkg/platform/package_dump.go

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ import (
3535
func packageDump() (*cobra.Command, error) {
3636
var cmd cobra.Command
3737

38-
cmd.Use = "dump [flags] deployment"
38+
cmd.Use = "dump [flags]"
3939
cmd.Short = "Dumps the current setup of the platform"
4040

4141
if err := cli.RegisterFlags(&cmd); err != nil {
@@ -58,12 +58,11 @@ func packageDumpRun(cmd *cobra.Command, args []string) error {
5858
return err
5959
}
6060

61-
if len(args) < 1 {
62-
return errors.Errorf("Invalid arguments")
61+
deployment, err := flagPlatformName.Get(cmd)
62+
if err != nil {
63+
return err
6364
}
6465

65-
deployment := args[0]
66-
6766
out, err := helm.NewPackage(cmd.Context(), client, ns, deployment)
6867
if err != nil {
6968
return err

‎pkg/platform/package_install.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ import (
4141
func packageInstall() (*cobra.Command, error) {
4242
var cmd cobra.Command
4343

44-
cmd.Use = "install [flags] deployment package"
44+
cmd.Use = "install [flags] package"
4545
cmd.Short = "Installs the specified setup of the platform"
4646

4747
if err := cli.RegisterFlags(&cmd, flagPlatformEndpoint); err != nil {
@@ -74,17 +74,21 @@ func packageInstallRun(cmd *cobra.Command, args []string) error {
7474
return err
7575
}
7676

77+
deployment, err := flagPlatformName.Get(cmd)
78+
if err != nil {
79+
return err
80+
}
81+
7782
hclient, err := getHelmClient(cmd)
7883
if err != nil {
7984
return errors.Wrapf(err, "Unable to get helm client")
8085
}
8186

82-
if len(args) < 2 {
87+
if len(args) < 1 {
8388
return errors.Errorf("Invalid arguments")
8489
}
8590

86-
deployment := args[0]
87-
file := args[1]
91+
file := args[0]
8892

8993
data, err := os.ReadFile(file)
9094
if err != nil {

‎pkg/util/k8sutil/names/id.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ func GetArangodIDPrefix(group api.ServerGroup) string {
5353
return "PRMR-"
5454
case api.ServerGroupAgents:
5555
return "AGNT-"
56+
case api.ServerGroupGateways:
57+
return "GWAY-"
5658
default:
5759
return ""
5860
}

0 commit comments

Comments
 (0)