Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated help docs #1661

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Updated help docs #1661

merged 4 commits into from
Dec 16, 2024

Conversation

pavangudiwada
Copy link
Contributor

No description provided.

@pavangudiwada pavangudiwada requested a review from aantn December 13, 2024 12:00
@pavangudiwada pavangudiwada changed the title Add to help docs Updated help docs Dec 13, 2024
docs/help.rst Outdated

.. details:: CustomResourceDefinition.apiextensions.k8s.io "prometheuses.monitoring.coreos.com" is invalid: metadata.annotations: Too long

This is often a CRD issue which can be fixed with :ref:`these instructions <Manual Upgrade>` To verify this, open the ArgoCD error logs and look for more details.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pavangudiwada this is the wrong fix. You don't fix by applying a manual upgrade, you fix by checking off the "server-side apply" option

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(The image below is right, the text above is not.)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed it

@@ -120,8 +120,9 @@ Finally, run ``robusta logs`` from your cli and make sure there is no error.

On some Robusta versions, the sync might fail with ``CustomResourceDefinition.apiextensions.k8s.io “prometheuses.monitoring.coreos.com” is invalid: metadata.annotations: Too long: must have at most 262144 bytes``.

To solve it, use the workaround proposed `here <https://github.com/prometheus-community/helm-charts/issues/1500#issuecomment-1132907207>`_
To solve it, use the workaround proposed :ref:`here <CRD Issues>`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong fix. This is the server-side apply one.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed at the reference

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link it directly from here to save the user another click?

@pavangudiwada pavangudiwada requested a review from aantn December 16, 2024 06:11
aantn
aantn previously approved these changes Dec 16, 2024
Copy link
Collaborator

@aantn aantn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

2 minor comments. Please fix then merge

docs/help.rst Outdated

.. details:: CustomResourceDefinition.apiextensions.k8s.io "prometheuses.monitoring.coreos.com" is invalid: metadata.annotations: Too long

This is often a CRD issue which can be fixed by enabling service-side apply option as shown below. Check out `this blog <https://blog.ediri.io/kube-prometheus-stack-and-argocd-25-server-side-apply-to-the-rescue>`_ to learn more.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Server-side not service-side

@@ -120,8 +120,9 @@ Finally, run ``robusta logs`` from your cli and make sure there is no error.

On some Robusta versions, the sync might fail with ``CustomResourceDefinition.apiextensions.k8s.io “prometheuses.monitoring.coreos.com” is invalid: metadata.annotations: Too long: must have at most 262144 bytes``.

To solve it, use the workaround proposed `here <https://github.com/prometheus-community/helm-charts/issues/1500#issuecomment-1132907207>`_
To solve it, use the workaround proposed :ref:`here <CRD Issues>`.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you link it directly from here to save the user another click?

@pavangudiwada pavangudiwada merged commit 727ccad into master Dec 16, 2024
7 checks passed
@pavangudiwada pavangudiwada deleted the add-to-help-docs branch December 16, 2024 08:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants