[#774] docs: Fix the metadata.annotations: Too long in install.md

[cchung100m]

What changes were proposed in this pull request?

Fix the metadata.annotations: Too long in install.md

Why are the changes needed?

Solve the error message encountered below when using kubectl apply -f

The CustomResourceDefinition "remoteshuffleservices.uniffle.apache.org" is invalid: metadata.annotations: Too long: must have at most 262144 bytes

Fix: #774

Does this PR introduce any user-facing change?

No.

How was this patch tested?

No.

[cchung100m]

Hi @xianjingfeng

Following issue #774, I would appreciate that if you can help to review this PR, thank you.

[codecov-commenter]

Codecov Report

Merging #853 (8388709) into master (6bd8d13) will increase coverage by 2.15%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##             master     #853      +/-   ##
============================================
+ Coverage     56.58%   58.73%   +2.15%     
- Complexity     2174     2175       +1     
============================================
  Files           327      307      -20     
  Lines         15977    13617    -2360     
  Branches       1262     1262              
============================================
- Hits           9040     7998    -1042     
+ Misses         6429     5184    -1245     
+ Partials        508      435      -73     

see 22 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[jerqi]

It seems better that we use create when we need to create operator and we use apply when we need to update. https://blog.csdn.net/daiqinge/article/details/103249260
@advancedxy @wangao1236 WDYT?

[xianjingfeng]

LGTM

[advancedxy]

Thanks for your contribution. I noticed similar error.

However, I believe a better solution would be,

# create, cannot use apply here, see https://github.com/apache/incubator-uniffle/issues/774
kubectl create -f ${crd-yaml-file}

# update, make sure the crd-yaml-file is a complete CRD file.
kubectl replace -f ${crd-yaml-file}

kubect replace would replaces the CRD, which doesn't throw an exception if the CRD is already installed.

Refs:

1. https://medium.com/pareture/kubectl-install-crd-failed-annotations-too-long-2ebc91b40c7d
2. https://www.pcbaecker.com/posts/kubernetes-crd-annotation-too-long-fix/

[advancedxy]

See previous comment

[advancedxy]

It seems better that we use create when we need to create operator and we use apply when we need to update. https://blog.csdn.net/daiqinge/article/details/103249260 @advancedxy @wangao1236 WDYT?

We cannot apply with the whole CRD file even if we are just updating as the CRD file is too large. See my previous comments for solutions.

[cchung100m]

Thanks for your contribution. I noticed similar error.

However, I believe a better solution would be,

# create, cannot use apply here, see https://github.com/apache/incubator-uniffle/issues/774
kubectl create -f ${crd-yaml-file}

# update, make sure the crd-yaml-file is a complete CRD file.
kubectl replace -f ${crd-yaml-file}

kubect replace would replaces the CRD, which doesn't throw an exception if the CRD is already installed.

Refs:

1. https://medium.com/pareture/kubectl-install-crd-failed-annotations-too-long-2ebc91b40c7d
2. https://www.pcbaecker.com/posts/kubernetes-crd-annotation-too-long-fix/

Hi @advancedxy Thank you for the prompt reply and the detailed suggestions.

[smallzhongfeng]

LGTM.

[jerqi]

Merged to master. Thanks all.