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

[ModuleCatalog] Add .spec.resources to ModuleTemplate #1842

Closed
2 tasks done
c-pius opened this issue Sep 6, 2024 · 2 comments · Fixed by #1910
Closed
2 tasks done

[ModuleCatalog] Add .spec.resources to ModuleTemplate #1842

c-pius opened this issue Sep 6, 2024 · 2 comments · Fixed by #1910
Assignees
Labels
API Denotes that an issue is tied to the potential change of the API kind/feature Categorizes issue or PR as related to a new feature.

Comments

@c-pius
Copy link
Contributor

c-pius commented Sep 6, 2024

Description

In #1681 it has been decided to add resources to ModuleTemplates. We need to update the ModuleTemplate to include this information.

The information shall look as follows:

spec:
  resources:
  - name: <string>
    link: <link>

spec.resources is OPTIONAL (for compatibility reasons). The items in a resources entry are REQUIRED.

Reasons

Enables CLI and dashboard to support in the manual installation of a module by downloading the needed resources and applying them to the cluster.

Acceptance Criteria

  • .spec.resources added to ModuleTemplate
  • Added an entry to Modularization API Upgrade #776 that .spec.resources must be added as required in a future major API version

Feature Testing

No response

Testing approach

No response

Attachments

No response

@c-pius c-pius added kind/feature Categorizes issue or PR as related to a new feature. API Denotes that an issue is tied to the potential change of the API labels Sep 6, 2024
@janmedrek
Copy link
Contributor

@c-pius wouldn't something like .spec.rawManifest make it more transparent what that section really stands for?

I am just questioning the naming, I would make sure it is self-explanatory when looking at the resource without the use of Busola.

@c-pius c-pius self-assigned this Oct 1, 2024
@c-pius
Copy link
Contributor Author

c-pius commented Oct 1, 2024

@janmedrek sorry, your comment slipped through while I was on vacation. Actually, .spec.resources is a list of named items with a download link. Indeed, it is intended that this list contains the entry rawManifest. We chose to go for this "list container" instead of a direct .spec.rawManifest field so that we can add further resources in the future without doing additional API changes.

So it would look like:

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Denotes that an issue is tied to the potential change of the API kind/feature Categorizes issue or PR as related to a new feature.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants