Skip to content

Commit cc1f196

Browse files
ajanikowajanikow
authored
[Docs] Update docs for DeploymentSpec (#1367)
1 parent ba6dcc0 commit cc1f196

File tree

7 files changed

+36
-36
lines changed

7 files changed

+36
-36
lines changed

‎docs/api/ArangoDeployment.V1.md‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1746,7 +1746,9 @@ LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer S
17461746
If specified and supported by the platform, this will restrict traffic through the cloud-provider
17471747
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
17481748
cloud-provider does not support the feature.
1749-
+docs/link: Cloud Provider Firewall|https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
1749+
1750+
Links:
1751+
* [Cloud Provider Firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/)
17501752
17511753
[Code Reference](/pkg/apis/deployment/v1/external_access_spec.go#L52)
17521754
@@ -1766,10 +1768,12 @@ NodePort define optional port used in case of Auto or NodePort type.
17661768
### .spec.externalAccess.type: string
17671769

17681770
Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
1769-
+ doc/enum: Auto|Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
1770-
+ doc/enum: None|limit access to application running inside the Kubernetes cluster.
1771-
+ doc/enum: LoadBalancer|Create a Service of type LoadBalancer for the ArangoDB deployment.
1772-
+ doc/enum: NodePort|Create a Service of type NodePort for the ArangoDB deployment.
1771+
1772+
Possible Values:
1773+
* Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
1774+
* None - limit access to application running inside the Kubernetes cluster.
1775+
* LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
1776+
* NodePort - Create a Service of type NodePort for the ArangoDB deployment.
17731777

17741778
[Code Reference](/pkg/apis/deployment/v1/external_access_spec.go#L39)
17751779

@@ -2712,7 +2716,9 @@ LoadBalancerSourceRanges define LoadBalancerSourceRanges used for LoadBalancer S
27122716
If specified and supported by the platform, this will restrict traffic through the cloud-provider
27132717
load-balancer will be restricted to the specified client IPs. This field will be ignored if the
27142718
cloud-provider does not support the feature.
2715-
+docs/link: Cloud Provider Firewall|https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
2719+
2720+
Links:
2721+
* [Cloud Provider Firewall](https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/)
27162722

27172723
[Code Reference](/pkg/apis/deployment/v1/external_access_spec.go#L52)
27182724

@@ -2736,10 +2742,12 @@ NodePort define optional port used in case of Auto or NodePort type.
27362742
### .spec.sync.externalAccess.type: string
27372743

27382744
Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
2739-
+ doc/enum: Auto|Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
2740-
+ doc/enum: None|limit access to application running inside the Kubernetes cluster.
2741-
+ doc/enum: LoadBalancer|Create a Service of type LoadBalancer for the ArangoDB deployment.
2742-
+ doc/enum: NodePort|Create a Service of type NodePort for the ArangoDB deployment.
2745+
2746+
Possible Values:
2747+
* Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
2748+
* None - limit access to application running inside the Kubernetes cluster.
2749+
* LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
2750+
* NodePort - Create a Service of type NodePort for the ArangoDB deployment.
27432751

27442752
[Code Reference](/pkg/apis/deployment/v1/external_access_spec.go#L39)
27452753

‎pkg/apis/deployment/v1/architecture.go‎

Lines changed: 3 additions & 7 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-2023 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.
@@ -30,12 +30,8 @@ import (
3030
)
3131

3232
// ArangoDeploymentArchitecture defines the list of supported architectures.
33-
// Possible values are:
34-
// - `amd64`: Use processors with the x86-64 architecture.
35-
// - `arm64`: Use processors with the 64-bit ARM architecture.
36-
// The setting expects a list of strings, but you should only specify a single list item for the architecture, except when you want to migrate from one architecture to the other.
37-
// The first list item defines the new default architecture for the deployment that you want to migrate to.
38-
// To use the ARM architecture, you need to enable it in the operator first using --set "operator.architectures={amd64,arm64}". See Installation with Helm.
33+
// +doc/enum: amd64|Use processors with the x86-64 architecture.
34+
// +doc/enum: arm64|Use processors with the 64-bit ARM architecture.
3935
type ArangoDeploymentArchitecture []ArangoDeploymentArchitectureType
4036

4137
func (a ArangoDeploymentArchitecture) GetDefault() ArangoDeploymentArchitectureType {

‎pkg/apis/deployment/v1/external_access_spec.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ import (
3232
type ExternalAccessSpec struct {
3333

3434
// Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
35-
// + doc/enum: Auto|Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
36-
// + doc/enum: None|limit access to application running inside the Kubernetes cluster.
37-
// + doc/enum: LoadBalancer|Create a Service of type LoadBalancer for the ArangoDB deployment.
38-
// + doc/enum: NodePort|Create a Service of type NodePort for the ArangoDB deployment.
35+
// +doc/enum: Auto|Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
36+
// +doc/enum: None|limit access to application running inside the Kubernetes cluster.
37+
// +doc/enum: LoadBalancer|Create a Service of type LoadBalancer for the ArangoDB deployment.
38+
// +doc/enum: NodePort|Create a Service of type NodePort for the ArangoDB deployment.
3939
Type *ExternalAccessType `json:"type,omitempty"`
4040

4141
// NodePort define optional port used in case of Auto or NodePort type.
@@ -48,7 +48,7 @@ type ExternalAccessSpec struct {
4848
// If specified and supported by the platform, this will restrict traffic through the cloud-provider
4949
// load-balancer will be restricted to the specified client IPs. This field will be ignored if the
5050
// cloud-provider does not support the feature.
51-
// +docs/link: Cloud Provider Firewall|https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
51+
// +doc/link: Cloud Provider Firewall|https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
5252
LoadBalancerSourceRanges []string `json:"loadBalancerSourceRanges,omitempty"`
5353

5454
// AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint

‎pkg/apis/deployment/v1/storage_engine.go‎

Lines changed: 1 addition & 1 deletion
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-2023 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.

‎pkg/apis/deployment/v2alpha1/architecture.go‎

Lines changed: 3 additions & 7 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-2023 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.
@@ -30,12 +30,8 @@ import (
3030
)
3131

3232
// ArangoDeploymentArchitecture defines the list of supported architectures.
33-
// Possible values are:
34-
// - `amd64`: Use processors with the x86-64 architecture.
35-
// - `arm64`: Use processors with the 64-bit ARM architecture.
36-
// The setting expects a list of strings, but you should only specify a single list item for the architecture, except when you want to migrate from one architecture to the other.
37-
// The first list item defines the new default architecture for the deployment that you want to migrate to.
38-
// To use the ARM architecture, you need to enable it in the operator first using --set "operator.architectures={amd64,arm64}". See Installation with Helm.
33+
// +doc/enum: amd64|Use processors with the x86-64 architecture.
34+
// +doc/enum: arm64|Use processors with the 64-bit ARM architecture.
3935
type ArangoDeploymentArchitecture []ArangoDeploymentArchitectureType
4036

4137
func (a ArangoDeploymentArchitecture) GetDefault() ArangoDeploymentArchitectureType {

‎pkg/apis/deployment/v2alpha1/external_access_spec.go‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,10 +32,10 @@ import (
3232
type ExternalAccessSpec struct {
3333

3434
// Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
35-
// + doc/enum: Auto|Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
36-
// + doc/enum: None|limit access to application running inside the Kubernetes cluster.
37-
// + doc/enum: LoadBalancer|Create a Service of type LoadBalancer for the ArangoDB deployment.
38-
// + doc/enum: NodePort|Create a Service of type NodePort for the ArangoDB deployment.
35+
// +doc/enum: Auto|Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
36+
// +doc/enum: None|limit access to application running inside the Kubernetes cluster.
37+
// +doc/enum: LoadBalancer|Create a Service of type LoadBalancer for the ArangoDB deployment.
38+
// +doc/enum: NodePort|Create a Service of type NodePort for the ArangoDB deployment.
3939
Type *ExternalAccessType `json:"type,omitempty"`
4040

4141
// NodePort define optional port used in case of Auto or NodePort type.
@@ -48,7 +48,7 @@ type ExternalAccessSpec struct {
4848
// If specified and supported by the platform, this will restrict traffic through the cloud-provider
4949
// load-balancer will be restricted to the specified client IPs. This field will be ignored if the
5050
// cloud-provider does not support the feature.
51-
// +docs/link: Cloud Provider Firewall|https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
51+
// +doc/link: Cloud Provider Firewall|https://kubernetes.io/docs/tasks/access-application-cluster/configure-cloud-provider-firewall/
5252
LoadBalancerSourceRanges []string `json:"loadBalancerSourceRanges,omitempty"`
5353

5454
// AdvertisedEndpoint is passed to the coordinators/single servers for advertising a specific endpoint

‎pkg/apis/deployment/v2alpha1/storage_engine.go‎

Lines changed: 1 addition & 1 deletion
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-2023 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.

0 commit comments

Comments
 (0)