Adding a devfile registry index

[makandre]

Signed-off-by: Andrew Mak makandre@ca.ibm.com

As discuss recently on the Codewind/Appsody interlock call, we would like to submit a devfile registry index.json to be hosted in the stacks repo, so that it can be consumed by Codewind.

The contents of the index.json reflects directly what's currently in index.yaml; generating index.json from the index.yaml can be done at a later time.

(Codewind will be adding ability to process tar.gz file via eclipse-archived/codewind#62)

CC: @neeraj-laad @seabaylea

Checklist:

• Read the Code of Conduct and Contributing Guidelines.

• Followed the commit message guidelines.

• Stack adheres to Appsody stack structure.

Modifying an existing stack:

• Updated the stack version in stack.yaml

Contributing a new stack:

• Describe how application dependencies are managed:

• Explain how Appsody file watcher is utilized:

• Describe other Appsody environment variables defined by the stack image:

• Describe any limitations and known issues:

Related Issues:

[CLAassistant]

All committers have signed the CLA.

[neeraj-laad]

@makandre It might be best to generate this file and publish as a release asset along with index.yaml. However I have a few questions regarding the contents fo the file itself, which I'll pu in my review.

Also, I'd want to generate an index for all stacks vs adding special intelligence in the build process to do any filtering. Please let me know if what you think?

[makandre]

Yes I think ultimately we want this file to be generated whenever index.yaml is updated. This PR is just to have something hosted initially for us to work with, while the auto-gen gets worked out.

I'm not sure what you mean by publish as a release asset; it's fine as long the file will be accessible to Codewind at some url. But we also need to keep in mind the relative link to the devfile works (whenever we get to adding that) because that is something that Che uses

And lastly the intent of the file is to list everything; so yes, no filtering.

[neeraj-laad]

I meant publishing the assets here: https://github.com/appsody/stacks/releases. You should be able to access the latest indexes here using the latest tag.

I ma not sure what you mean by adding devfiles to relative path. I do not believe we want to add any devfiles to our repo? Did I miss anything?

Also, does CodeWind support multiple repos? We intend to have separate indexes for stable/incubator/expreimental repos.

[neeraj-laad]

• We do not have a "language" field in out stack.yaml today. Can this be set to a default value or "", How is it used by CodeWind?

[makandre]

Codewind uses the language for 1) display purposes 2) determine the style of debugging (e.g. node vs java)

But in the larger context of Codewind extensions, we may want to allow an extension to use the language value to dictate some aspect of the way it behaves.

[neeraj-laad]

What are the links referring to? Is this mandatory? If yes how can we generate this for all stacks?

[makandre]

The links point to devfiles that Eclipse Che uses to create a workspace. At the moment, since appsody does not run on Kube and Che support is not there yet, we don't need the devfiles for now.

[makandre]

@neeraj-laad Codewind does have support for multiple repos. We are also proposing for Eclipse Che to support multiple repos via eclipse-che/che#13961

With regards to devfiles, I've been told that eventually we'd want an appsody repo to also function as an Eclipse Che devfile registry repo, so then whatever repo we point the CLI to for stacks, we can also point Codewind (or Codewind on Eclipse Che) to it so they are all able to get the same information.

[neeraj-laad]

@seabaylea would like your inputs on this.

[neeraj-laad]

closing this PR. This will be replaced by #163