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

kubectl explain doesn't work as expected #14161

Closed
3 of 4 tasks
sleungcy opened this issue Feb 7, 2025 · 1 comment
Closed
3 of 4 tasks

kubectl explain doesn't work as expected #14161

sleungcy opened this issue Feb 7, 2025 · 1 comment
Labels

Comments

@sleungcy
Copy link

sleungcy commented Feb 7, 2025

Pre-requisites

  • I have double-checked my configuration
  • I have tested with the :latest image tag (i.e. quay.io/argoproj/workflow-controller:latest) and can confirm the issue still exists on :latest. If not, I have explained why, in detail, in my description below.
  • I have searched existing issues and could not find a match for this bug
  • I'd like to contribute the fix myself (see contributing guide)

What happened? What did you expect to happen?

The problem is that kubectl explain doesn't work as expected on either of the controllers.

  • Argo Events version: 1.9.4
  • Argo Workflows version: 3.5.14

Describe the bug
When I run k explain on the resources of either Argo Events or Argo Workflows, I get no description as shown above.

$ k explain sensor.spec
GROUP:      argoproj.io
KIND:       Sensor
VERSION:    v1alpha1

FIELD: spec <Object>

DESCRIPTION:
    <empty>

To Reproduce
Steps to reproduce the behavior:

  1. install argo-events 1.9.4+
  2. run k explain workflow.spec

Expected behavior
The expected behavior is that the kubectl explain command would print out the documentation specific to the version of Argo Events/Argo Workflows I have.

Environment (please complete the following information):

  • Argo Events: v1.9.4

Message from the maintainers:

If you wish to see this enhancement implemented please add a 👍 reaction to this issue! We often sort issues this way to know what to prioritize.

Version(s)

3.5.14

Paste a minimal workflow that reproduces the issue. We must be able to run the workflow; don't enter a workflow that uses private images.

run k explain workflow.spec

Logs from the workflow controller

$ k explain sensor.spec
GROUP:      argoproj.io
KIND:       Sensor
VERSION:    v1alpha1

FIELD: spec <Object>

DESCRIPTION:
    <empty>

Logs from in your workflow's wait container

kubectl logs -n argo -c wait -l workflows.argoproj.io/workflow=${workflow},workflow.argoproj.io/phase!=Succeeded
@MasonM
Copy link
Member

MasonM commented Feb 9, 2025

Thanks for the report! This is happening because the default CRDs are minimized, and it wasn't possible to install the full CRDs until I fixed them up in #14044. That hasn't been released yet, but once it is, follow the instructions at https://argo-workflows.readthedocs.io/en/latest/installation/#full-crds and you'll see all the fields when running kubectl explain workflow.spec:

 $ kubectl explain workflow.spec
GROUP:      argoproj.io
KIND:       Workflow
VERSION:    v1alpha1

FIELD: spec <Object>

DESCRIPTION:
    <empty>
FIELDS:
  activeDeadlineSeconds <integer>
    <no description>

  affinity      <Object>
    <no description>

  archiveLogs   <boolean>
    <no description>

  arguments     <Object>
    <no description>

  artifactGC    <Object>
    <no description>
<SNIP>

The field descriptions are missing, which is being tracked in #8190

@MasonM MasonM closed this as completed Feb 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants