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.

Sign up for GitHub

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

Jump to bottom

The PackageInstall CRD documentation is not up to date #1275

Open
joaopapereira opened this issue Jul 21, 2023 · 2 comments
Open

The PackageInstall CRD documentation is not up to date #1275

joaopapereira opened this issue Jul 21, 2023 · 2 comments
Labels
carvel-accepted This issue should be considered for future work and that the triage process has been completed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@joaopapereira
Copy link
Member

The documentation in the Package Install Custom Resource has a TODO already done.
This particular instance is

kapp-controller/pkg/apis/packaging/v1alpha1/package_install.go

Lines 102 to 104 in 6eb91df

// TODO this is desired resolved version (not actually deployed)
// +optional
Version string `json:"version,omitempty"`
.
But we should make sure that we go through the CRDs to see if there is another instance where we have TODOs that are no longer valid.
@joaopapereira joaopapereira added the carvel-triage This issue has not yet been reviewed for validity label Jul 21, 2023
@rajathagasthya
Copy link

The PackageInstall CRD documentation also says status.packageRef exists, but no such type exists in the API.

# Populated by the controller
status:
  packageRef:
    # Kubernetes resource name of the package chosen against the constraints
    name: fluent-bit.tkg.vmware.com.v1.5.3

@joaopapereira
Copy link
Member Author

In this story, we want to make sure that we address both the code comments in the Package Install CRD and update the CRD spec that we manually created to be displayed on the website.

@joaopapereira joaopapereira added carvel-accepted This issue should be considered for future work and that the triage process has been completed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. and removed carvel-triage This issue has not yet been reviewed for validity labels Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
carvel-accepted This issue should be considered for future work and that the triage process has been completed priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
Carvel
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joaopapereira @rajathagasthya