use Devfiles for s2i components

[kadel]

Use devfile.yml for s2i components instead of LocalConfig.yaml

Motivation

Odo has two types of components, Devfile and s2i. Currently, each component type has its own separate code path. This means that each command needs to understand how to do the action for Devfile and also for s2i. Technically it is possible to create a Devfile that will mimic what odo is doing with s2i. We already have this in odo utils convert. Odo should leverage that logic and start treating s2i components as regular Devfile. This will reduce the odo code base and will make code maintenance a lot simpler.

odo create --s2i

odo create --s2i command would no longer generate LocalConfig (./odo/config.yml). Instead, it should just generate devfile.yml, and optionally ./odo/env.yml) depending on what will be required.

all other commands

The rest of the commands (like odo storage, odo url, etc..) should not need to know anything about s2i. For them, it will be just another Devfile component.

Acceptance Criteria

• odo create --s2i should use the s2i to devfile tool to build the devfile on the fly and follow devfile flow in the future.
• if user has existing LocalConfig s2i component it still needs to work
• We're going to need to make changes to odo create -h as well.
• Finally, we're going to need to update docs that end on odo.dev site as well.

[dharmit]

@girishramnani you might want to consider #4201 while working on this. Basically, odo create --s2i with --env should not break if we were to keep compatibility with odo create from v1.

[dharmit]

• Also consider odo link with Service Catalog breaking since this works only between s2i component & SC backed service.
• Conversion tool (s2i to devfile) itself has issues as observed by @mik-dass. We should fix/address those as a part of this issue.

[dharmit]

Need #4369 to go in first, right @girishramnani ?

[girishramnani]

Just so its documented - I dont think --now flag works for devfile so I am not gonna worry about it for now

[girishramnani]

Also this issue will break all s2i components - no existing s2i components would work.

[kadel]

Also this issue will break all s2i components - no existing s2i components would work.

I forgot to mention that in the issue :-(. This can't break existing s2i components without any warning.
We either have to find a way to convert existing s2i components or keep the s2i code there for some time and display a depreciation warning and then after a few releases remove it.

[girishramnani]

we can do a Y stream release to signify such a huge breaking change @kadel

[girishramnani]

We can deprecate s2i components using an early PR that goes in the week’s release and then this PR can be released in later version

[kadel]

we can do a Y stream release to signify such a huge breaking change @kadel

Y stream should not break backward compatibility.

We can deprecate s2i components using an early PR that goes in the week’s release and then this PR can be released in later version

that is too quick.

BTW the original idea for this PR was to just make sure that new components will be all based on Devfile.
But the existing components, even old s2i based on LocalConfig should work as they currently do.

Removal of LocalConfig components would happen later only after we are sure that almost no one is using it.

I have updated Acceptance Criteria to include this

[kadel]

Are we going to have odo create --s2i --port get converted into a devfile with #4518? Or is that scoped for other time?

it should be part of the initial work. Some components won't work without --port support

[girishramnani]

its supported now @dharmit

[girishramnani]

Breaking change

Currently a converted s2i component would already have a url defined even if the original s2i component didn't have one, this was done to keep the behavior consistent between s2i and devfile cmps, as a new devfile component creates the url without a user doing "odo url create"

[girishramnani]

removing all duplicate tests that are present in devfile and s2i both - Criteria of removal is to exactly match the title of the test and instructions in the tests

Current situation - 10 integration tests failing, 12 e2e tests failing.
Fixed 5 today, more underway.

[girishramnani]

Currently I cannot debug e2e tests because they are timing out on prow.

[girishramnani]

Fixed all the tests but gingko is timing out, I tried to reproduce this timeout but it didn’t happen so thinking about other ways to fix this

[girishramnani]

Some questions asked so far
#4518 (comment)

[girishramnani]

Need to add help and update docs

[girishramnani]

But I went through the odo.dev docs, there are 20 pages of doc and nearly no mention of —s2i.

We need 2-3 paragraphs explaining —git, —binary and other 2 issues.

And the demo video needs to change.
Will share more of my findings

[girishramnani]

Current plan -
I am writing a page in odo.dev titled “breaking changes in odo 2.2”
Explaining my —s2i change. I wasn’t sure where to document this so this seemed like the best option

[girishramnani]

Docs #4683