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

Add "supported Types" Section to OCM Specification #3

Closed
1 task done
In-Ko opened this issue Aug 8, 2022 · 8 comments · Fixed by #28
Closed
1 task done

Add "supported Types" Section to OCM Specification #3

In-Ko opened this issue Aug 8, 2022 · 8 comments · Fixed by #28

Comments

@In-Ko
Copy link
Member

In-Ko commented Aug 8, 2022

Description
The OCM Specification already supportes some specific types, like "ociImage" or "helm.io/chart" for resources and "git" for sources. These types are partially described here: https://github.com/gardener/ocm-spec/blob/main/doc/proposal/app01-external-references.md#artifacts-stored-in-oci-registries.

We need a separate chapter/section in the OCM Specification structure, where all currently supported types are fully specified, including examples for how to use them.

Done Criteria

  • All currently supported types are fully specified in a dedicated chapter/section/page within the OCM specification repository.
@In-Ko
Copy link
Member Author

In-Ko commented Aug 15, 2022

Work on this has been started in PR open-component-model/ocm#58, in a folder "names". This must be integrated into the OCM spec. I would like to have everything spec-related in the ocm-spec repo, and not distributed across several documentations in various repos.

@In-Ko
Copy link
Member Author

In-Ko commented Aug 15, 2022

PR: open-component-model/ocm#58

@Skarlso
Copy link
Contributor

Skarlso commented Aug 25, 2022

Is anything else left with this issue after the said pr has been closed or can this be moved to closed?

@In-Ko
Copy link
Member Author

In-Ko commented Aug 26, 2022

Nope, this is not yet done, as the types stuff from here needs to move into the ocm-spec repo, as "APPENDIX C". Also the content from the former proposal (https://github.com/gardener/ocm-spec/blob/main/doc/proposal/app01-external-references.md#artifacts-stored-in-oci-registries) should be integrated into the APPENDIX C of the ocm-spec repo. So a bit of moving and copy/paste and proof-reading is still required here.

@Skarlso
Copy link
Contributor

Skarlso commented Aug 26, 2022

Ah okay, thanks.

@In-Ko
Copy link
Member Author

In-Ko commented Aug 29, 2022

I see that there is a types section already in the new spec: https://github.com/gardener/ocm-spec/blob/main/doc/appendix/E/README.md (APPENDIX E).
So what is left here now is:

If all currently known supported types are integrated into https://github.com/gardener/ocm-spec/blob/main/doc/appendix/E/README.md, this issue is done.

@jensh007
Copy link
Contributor

jensh007 commented Sep 7, 2022

What is the type file-system?
Remove toi-package and toi-executor from the spec

@phoban01
Copy link
Contributor

phoban01 commented Sep 16, 2022

I have reviewed Appendix E and it looks good. I've done some reformatting and cleanup in open-component-mode/ocm-spec#28. This can be closed.

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 a pull request may close this issue.

5 participants