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

Document AKSClusterConfig API type #238

Closed
1 task done
richardcase opened this issue Jul 11, 2023 · 6 comments
Closed
1 task done

Document AKSClusterConfig API type #238

richardcase opened this issue Jul 11, 2023 · 6 comments
Assignees
Labels
area/api JIRA Must shout kind/enhancement New feature or request
Milestone

Comments

@richardcase
Copy link
Contributor

richardcase commented Jul 11, 2023

SURE-5202

We need to document the AKSClusterConfig API type including all child file and structs with:

  • documentation comments
  • kubebuilder validation annotations

PR's:

@kkaempf kkaempf added kind/enhancement New feature or request JIRA Must shout area/api labels Jul 11, 2023
@kkaempf kkaempf modified the milestones: 2023-Q3-v2.7x, 2023-Q4-v2.8x Jul 11, 2023
@mjura mjura self-assigned this Aug 7, 2023
mjura added a commit to mjura/aks-operator that referenced this issue Aug 10, 2023
@richardcase
Copy link
Contributor Author

mjura added a commit to mjura/aks-operator that referenced this issue Aug 24, 2023
@mjura
Copy link
Contributor

mjura commented Sep 6, 2023

fixed

@mjura mjura closed this as completed Sep 6, 2023
@cpinjani cpinjani self-assigned this Sep 11, 2023
@cpinjani
Copy link

cpinjani commented Sep 13, 2023

Validated on nightly chart build:
image

Documentation not providing expected information, @mjura Can you please have a look or let me if I am missing something here ?

Edit:
Same result on belows builds as well:

v2.8-8f41b4b054fc5804299dbcac3fa73c69cc17303d-head
aks-operator:v1.2.0-rc3
$ kubectl explain aksclusterconfigs.aks.cattle.io.spec.tags
GROUP:      aks.cattle.io
KIND:       AKSClusterConfig
VERSION:    v1

FIELD: tags <map[string]string>

DESCRIPTION:
    <empty>

@cpinjani cpinjani reopened this Sep 13, 2023
@richardcase
Copy link
Contributor Author

@cpinjani - we've only documented the structs/fields that are directly imported by Rancher. The aksclusterconfigs.aks.cattle.io kind is not designed to be directly used by end users so we didn't document it fully.

@cpinjani
Copy link

@richardcase Thanks for the clarification. Can this be closed as Done ?

@cpinjani
Copy link

Closing issue as discussed in standup, as current scope is met.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/api JIRA Must shout kind/enhancement New feature or request
Development

No branches or pull requests

4 participants