Skip to content

Commit 16c5114

Browse files
committed
Iter
1 parent abdf0e6 commit 16c5114

File tree

3 files changed

+60
-0
lines changed

3 files changed

+60
-0
lines changed

docs/api/ArangoDeployment.V1.md

+56
Original file line numberDiff line numberDiff line change
@@ -446,6 +446,8 @@ Default Value: `2`
446446
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256)</sup>
447447

448448
> [!WARNING]
449+
> ***DEPRECATED***
450+
>
449451
> **This field is deprecated, kept only for backward compatibility.**
450452
451453
OldReadinessProbeDisabled if true readinessProbes are disabled
@@ -632,6 +634,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
632634
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
633635

634636
> [!WARNING]
637+
> ***DEPRECATED***
638+
>
635639
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
636640
637641
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -795,6 +799,8 @@ Links:
795799
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93)</sup>
796800

797801
> [!WARNING]
802+
> ***DEPRECATED***
803+
>
798804
> **Use VolumeClaimTemplate instead.**
799805

800806
StorageClassName specifies the classname for storage of the servers.
@@ -830,6 +836,8 @@ Links:
830836
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
831837

832838
> [!WARNING]
839+
> ***DEPRECATED***
840+
>
833841
> **VolumeAllowShrink allows shrink the volume**
834842

835843
VolumeAllowShrink allows shrinking of the volume
@@ -1504,6 +1512,8 @@ Default Value: `2`
15041512
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256)</sup>
15051513

15061514
> [!WARNING]
1515+
> ***DEPRECATED***
1516+
>
15071517
> **This field is deprecated, kept only for backward compatibility.**
15081518

15091519
OldReadinessProbeDisabled if true readinessProbes are disabled
@@ -1690,6 +1700,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
16901700
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
16911701

16921702
> [!WARNING]
1703+
> ***DEPRECATED***
1704+
>
16931705
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
16941706

16951707
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -1853,6 +1865,8 @@ Links:
18531865
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93)</sup>
18541866

18551867
> [!WARNING]
1868+
> ***DEPRECATED***
1869+
>
18561870
> **Use VolumeClaimTemplate instead.**
18571871

18581872
StorageClassName specifies the classname for storage of the servers.
@@ -1888,6 +1902,8 @@ Links:
18881902
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
18891903

18901904
> [!WARNING]
1905+
> ***DEPRECATED***
1906+
>
18911907
> **VolumeAllowShrink allows shrink the volume**
18921908

18931909
VolumeAllowShrink allows shrinking of the volume
@@ -2430,6 +2446,8 @@ Default Value: `2`
24302446
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256)</sup>
24312447

24322448
> [!WARNING]
2449+
> ***DEPRECATED***
2450+
>
24332451
> **This field is deprecated, kept only for backward compatibility.**
24342452

24352453
OldReadinessProbeDisabled if true readinessProbes are disabled
@@ -2616,6 +2634,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
26162634
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
26172635

26182636
> [!WARNING]
2637+
> ***DEPRECATED***
2638+
>
26192639
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
26202640

26212641
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -2779,6 +2799,8 @@ Links:
27792799
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93)</sup>
27802800

27812801
> [!WARNING]
2802+
> ***DEPRECATED***
2803+
>
27822804
> **Use VolumeClaimTemplate instead.**
27832805

27842806
StorageClassName specifies the classname for storage of the servers.
@@ -2814,6 +2836,8 @@ Links:
28142836
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
28152837

28162838
> [!WARNING]
2839+
> ***DEPRECATED***
2840+
>
28172841
> **VolumeAllowShrink allows shrink the volume**
28182842

28192843
VolumeAllowShrink allows shrinking of the volume
@@ -3118,6 +3142,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
31183142
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
31193143

31203144
> [!WARNING]
3145+
> ***DEPRECATED***
3146+
>
31213147
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
31223148

31233149
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -3384,6 +3410,8 @@ Default Value: `false`
33843410
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/deployment_metrics_spec.go#L86)</sup>
33853411

33863412
> [!WARNING]
3413+
> ***DEPRECATED***
3414+
>
33873415
> **Image is now extracted from Operator Pod**
33883416

33893417
Image used for the Metrics Sidecar
@@ -3395,6 +3423,8 @@ Image used for the Metrics Sidecar
33953423
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/deployment_metrics_spec.go#L97)</sup>
33963424

33973425
> [!WARNING]
3426+
> ***DEPRECATED***
3427+
>
33983428
> **Not used anymore**
33993429

34003430
Mode define metrics exported mode
@@ -3494,6 +3524,8 @@ Type: `integer` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.
34943524
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/rebalancer_spec.go#L63)</sup>
34953525

34963526
> [!WARNING]
3527+
> ***DEPRECATED***
3528+
>
34973529
> **does not work in Rebalancer V2**
34983530

34993531
Count Enable Shard Count machanism
@@ -3980,6 +4012,8 @@ Default Value: `2`
39804012
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256)</sup>
39814013

39824014
> [!WARNING]
4015+
> ***DEPRECATED***
4016+
>
39834017
> **This field is deprecated, kept only for backward compatibility.**
39844018

39854019
OldReadinessProbeDisabled if true readinessProbes are disabled
@@ -4166,6 +4200,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
41664200
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
41674201

41684202
> [!WARNING]
4203+
> ***DEPRECATED***
4204+
>
41694205
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
41704206

41714207
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -4329,6 +4365,8 @@ Links:
43294365
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93)</sup>
43304366

43314367
> [!WARNING]
4368+
> ***DEPRECATED***
4369+
>
43324370
> **Use VolumeClaimTemplate instead.**
43334371

43344372
StorageClassName specifies the classname for storage of the servers.
@@ -4364,6 +4402,8 @@ Links:
43644402
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
43654403

43664404
> [!WARNING]
4405+
> ***DEPRECATED***
4406+
>
43674407
> **VolumeAllowShrink allows shrink the volume**
43684408

43694409
VolumeAllowShrink allows shrinking of the volume
@@ -5107,6 +5147,8 @@ Default Value: `2`
51075147
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256)</sup>
51085148

51095149
> [!WARNING]
5150+
> ***DEPRECATED***
5151+
>
51105152
> **This field is deprecated, kept only for backward compatibility.**
51115153

51125154
OldReadinessProbeDisabled if true readinessProbes are disabled
@@ -5293,6 +5335,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
52935335
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
52945336

52955337
> [!WARNING]
5338+
> ***DEPRECATED***
5339+
>
52965340
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
52975341

52985342
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -5456,6 +5500,8 @@ Links:
54565500
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93)</sup>
54575501

54585502
> [!WARNING]
5503+
> ***DEPRECATED***
5504+
>
54595505
> **Use VolumeClaimTemplate instead.**
54605506

54615507
StorageClassName specifies the classname for storage of the servers.
@@ -5491,6 +5537,8 @@ Links:
54915537
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
54925538

54935539
> [!WARNING]
5540+
> ***DEPRECATED***
5541+
>
54945542
> **VolumeAllowShrink allows shrink the volume**
54955543

54965544
VolumeAllowShrink allows shrinking of the volume
@@ -6025,6 +6073,8 @@ Default Value: `2`
60256073
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256)</sup>
60266074

60276075
> [!WARNING]
6076+
> ***DEPRECATED***
6077+
>
60286078
> **This field is deprecated, kept only for backward compatibility.**
60296079

60306080
OldReadinessProbeDisabled if true readinessProbes are disabled
@@ -6211,6 +6261,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha
62116261
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38)</sup>
62126262

62136263
> [!WARNING]
6264+
> ***DEPRECATED***
6265+
>
62146266
> **This field is added for backward compatibility. Will be removed in 1.1.0.**
62156267

62166268
DropAllCapabilities specifies if capabilities should be dropped for this pod containers
@@ -6374,6 +6426,8 @@ Links:
63746426
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93)</sup>
63756427

63766428
> [!WARNING]
6429+
> ***DEPRECATED***
6430+
>
63776431
> **Use VolumeClaimTemplate instead.**
63786432

63796433
StorageClassName specifies the classname for storage of the servers.
@@ -6409,6 +6463,8 @@ Links:
64096463
Type: `boolean` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176)</sup>
64106464

64116465
> [!WARNING]
6466+
> ***DEPRECATED***
6467+
>
64126468
> **VolumeAllowShrink allows shrink the volume**
64136469

64146470
VolumeAllowShrink allows shrinking of the volume

docs/api/ArangoMember.V1.md

+2
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,8 @@ Checksum keep the Pod Spec Checksum (with ignored fields).
7575
Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/arango_member_pod_template.go#L63)</sup>
7676

7777
> [!WARNING]
78+
> ***DEPRECATED***
79+
>
7880
> **Endpoint is not saved into the template**
7981
8082
***

internal/docs_test.go

+2
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by
6363

6464
if d := el.Deprecated; len(d) > 0 {
6565
write(t, out, "> [!WARNING]\n")
66+
write(t, out, "> ***DEPRECATED***\n")
67+
write(t, out, "> \n")
6668
for _, line := range d {
6769
write(t, out, "> **%s**\n", line)
6870
}

0 commit comments

Comments
 (0)