From 16c5114d4e3ed2676a1ffe8859141b7b22c7e026 Mon Sep 17 00:00:00 2001 From: ajanikow <12255597+ajanikow@users.noreply.github.com> Date: Thu, 29 Feb 2024 12:43:10 +0000 Subject: [PATCH] Iter --- docs/api/ArangoDeployment.V1.md | 56 +++++++++++++++++++++++++++++++++ docs/api/ArangoMember.V1.md | 2 ++ internal/docs_test.go | 2 ++ 3 files changed, 60 insertions(+) diff --git a/docs/api/ArangoDeployment.V1.md b/docs/api/ArangoDeployment.V1.md index c9c85e861..a2b7c01a0 100644 --- a/docs/api/ArangoDeployment.V1.md +++ b/docs/api/ArangoDeployment.V1.md @@ -446,6 +446,8 @@ Default Value: `2` Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256) > [!WARNING] +> ***DEPRECATED*** +> > **This field is deprecated, kept only for backward compatibility.** OldReadinessProbeDisabled if true readinessProbes are disabled @@ -632,6 +634,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -795,6 +799,8 @@ Links: Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93) > [!WARNING] +> ***DEPRECATED*** +> > **Use VolumeClaimTemplate instead.** StorageClassName specifies the classname for storage of the servers. @@ -830,6 +836,8 @@ Links: Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176) > [!WARNING] +> ***DEPRECATED*** +> > **VolumeAllowShrink allows shrink the volume** VolumeAllowShrink allows shrinking of the volume @@ -1504,6 +1512,8 @@ Default Value: `2` Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256) > [!WARNING] +> ***DEPRECATED*** +> > **This field is deprecated, kept only for backward compatibility.** OldReadinessProbeDisabled if true readinessProbes are disabled @@ -1690,6 +1700,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -1853,6 +1865,8 @@ Links: Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93) > [!WARNING] +> ***DEPRECATED*** +> > **Use VolumeClaimTemplate instead.** StorageClassName specifies the classname for storage of the servers. @@ -1888,6 +1902,8 @@ Links: Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176) > [!WARNING] +> ***DEPRECATED*** +> > **VolumeAllowShrink allows shrink the volume** VolumeAllowShrink allows shrinking of the volume @@ -2430,6 +2446,8 @@ Default Value: `2` Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256) > [!WARNING] +> ***DEPRECATED*** +> > **This field is deprecated, kept only for backward compatibility.** OldReadinessProbeDisabled if true readinessProbes are disabled @@ -2616,6 +2634,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -2779,6 +2799,8 @@ Links: Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93) > [!WARNING] +> ***DEPRECATED*** +> > **Use VolumeClaimTemplate instead.** StorageClassName specifies the classname for storage of the servers. @@ -2814,6 +2836,8 @@ Links: Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176) > [!WARNING] +> ***DEPRECATED*** +> > **VolumeAllowShrink allows shrink the volume** VolumeAllowShrink allows shrinking of the volume @@ -3118,6 +3142,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -3384,6 +3410,8 @@ Default Value: `false` Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/deployment_metrics_spec.go#L86) > [!WARNING] +> ***DEPRECATED*** +> > **Image is now extracted from Operator Pod** Image used for the Metrics Sidecar @@ -3395,6 +3423,8 @@ Image used for the Metrics Sidecar Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/deployment_metrics_spec.go#L97) > [!WARNING] +> ***DEPRECATED*** +> > **Not used anymore** Mode define metrics exported mode @@ -3494,6 +3524,8 @@ Type: `integer` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1. Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/rebalancer_spec.go#L63) > [!WARNING] +> ***DEPRECATED*** +> > **does not work in Rebalancer V2** Count Enable Shard Count machanism @@ -3980,6 +4012,8 @@ Default Value: `2` Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256) > [!WARNING] +> ***DEPRECATED*** +> > **This field is deprecated, kept only for backward compatibility.** OldReadinessProbeDisabled if true readinessProbes are disabled @@ -4166,6 +4200,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -4329,6 +4365,8 @@ Links: Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93) > [!WARNING] +> ***DEPRECATED*** +> > **Use VolumeClaimTemplate instead.** StorageClassName specifies the classname for storage of the servers. @@ -4364,6 +4402,8 @@ Links: Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176) > [!WARNING] +> ***DEPRECATED*** +> > **VolumeAllowShrink allows shrink the volume** VolumeAllowShrink allows shrinking of the volume @@ -5107,6 +5147,8 @@ Default Value: `2` Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256) > [!WARNING] +> ***DEPRECATED*** +> > **This field is deprecated, kept only for backward compatibility.** OldReadinessProbeDisabled if true readinessProbes are disabled @@ -5293,6 +5335,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -5456,6 +5500,8 @@ Links: Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93) > [!WARNING] +> ***DEPRECATED*** +> > **Use VolumeClaimTemplate instead.** StorageClassName specifies the classname for storage of the servers. @@ -5491,6 +5537,8 @@ Links: Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176) > [!WARNING] +> ***DEPRECATED*** +> > **VolumeAllowShrink allows shrink the volume** VolumeAllowShrink allows shrinking of the volume @@ -6025,6 +6073,8 @@ Default Value: `2` Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L256) > [!WARNING] +> ***DEPRECATED*** +> > **This field is deprecated, kept only for backward compatibility.** OldReadinessProbeDisabled if true readinessProbes are disabled @@ -6211,6 +6261,8 @@ AllowPrivilegeEscalation Controls whether a process can gain more privileges tha Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_security_context_spec.go#L38) > [!WARNING] +> ***DEPRECATED*** +> > **This field is added for backward compatibility. Will be removed in 1.1.0.** DropAllCapabilities specifies if capabilities should be dropped for this pod containers @@ -6374,6 +6426,8 @@ Links: Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L93) > [!WARNING] +> ***DEPRECATED*** +> > **Use VolumeClaimTemplate instead.** StorageClassName specifies the classname for storage of the servers. @@ -6409,6 +6463,8 @@ Links: Type: `boolean` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/server_group_spec.go#L176) > [!WARNING] +> ***DEPRECATED*** +> > **VolumeAllowShrink allows shrink the volume** VolumeAllowShrink allows shrinking of the volume diff --git a/docs/api/ArangoMember.V1.md b/docs/api/ArangoMember.V1.md index f5e80e34e..fccbb3ef9 100644 --- a/docs/api/ArangoMember.V1.md +++ b/docs/api/ArangoMember.V1.md @@ -75,6 +75,8 @@ Checksum keep the Pod Spec Checksum (with ignored fields). Type: `string` [\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.38/pkg/apis/deployment/v1/arango_member_pod_template.go#L63) > [!WARNING] +> ***DEPRECATED*** +> > **Endpoint is not saved into the template** *** diff --git a/internal/docs_test.go b/internal/docs_test.go index 536b4f94c..37e0bc93c 100644 --- a/internal/docs_test.go +++ b/internal/docs_test.go @@ -63,6 +63,8 @@ func (d DocDefinitions) RenderMarkdown(t *testing.T, repositoryPath string) []by if d := el.Deprecated; len(d) > 0 { write(t, out, "> [!WARNING]\n") + write(t, out, "> ***DEPRECATED***\n") + write(t, out, "> \n") for _, line := range d { write(t, out, "> **%s**\n", line) }