Skip to content

Commit bd724c5

Browse files
cdragecdrage
committed
Make Devfile the default deployment mechanism for odo
**What type of PR is this?** > Uncomment only one ` /kind` line, and delete the rest. > For example, `> /kind bug` would simply become: `/kind bug` /kind feature **What does does this PR do / why we need it**: Makes Devfile the default deployment mechanism, removing S2I in favour of Devfile deployment. **Which issue(s) this PR fixes**: Closes redhat-developer#3550 **How to test changes / Special notes to the reviewer**: Run: ```sh odo preference set experimental false odo create --starter nodejs odo push ```
1 parent a872c28 commit bd724c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+699
-754
lines changed

‎pkg/component/component.go

+11-12
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ import (
2525
parsercommon "github.com/openshift/odo/pkg/devfile/parser/data/common"
2626
"github.com/openshift/odo/pkg/log"
2727
"github.com/openshift/odo/pkg/occlient"
28-
"github.com/openshift/odo/pkg/odo/util/experimental"
2928
"github.com/openshift/odo/pkg/odo/util/validation"
3029
"github.com/openshift/odo/pkg/preference"
3130
"github.com/openshift/odo/pkg/storage"
@@ -565,10 +564,10 @@ func ensureAndLogProperResourceUsage(resourceMin, resourceMax *string, resourceN
565564
// envSpecificInfo: Component environment specific information, available if uses devfile
566565
// cmpExist: true if components exists in the cluster
567566
// endpointMap: value is devfile endpoint entry, key is the TargetPort for each enpoint entry
567+
// isS2I: Legacy option. Set as true if you want to use the old S2I method as it differentiates slightly.
568568
// Returns:
569569
// err: Errors if any else nil
570-
func ApplyConfig(client *occlient.Client, kClient *kclient.Client, componentConfig config.LocalConfigInfo, envSpecificInfo envinfo.EnvSpecificInfo, stdout io.Writer, cmpExist bool, endpointMap map[int32]parsercommon.Endpoint) (err error) {
571-
isExperimentalModeEnabled := experimental.IsExperimentalModeEnabled()
570+
func ApplyConfig(client *occlient.Client, kClient *kclient.Client, componentConfig config.LocalConfigInfo, envSpecificInfo envinfo.EnvSpecificInfo, stdout io.Writer, cmpExist bool, endpointMap map[int32]parsercommon.Endpoint, isS2I bool) (err error) {
572571

573572
if client == nil {
574573
var err error
@@ -580,7 +579,7 @@ func ApplyConfig(client *occlient.Client, kClient *kclient.Client, componentConf
580579
client.Namespace = kClient.Namespace
581580
}
582581

583-
if !isExperimentalModeEnabled {
582+
if isS2I {
584583
// if component exist then only call the update function
585584
if cmpExist {
586585
if err = Update(client, componentConfig, componentConfig.GetSourceLocation(), stdout); err != nil {
@@ -591,7 +590,7 @@ func ApplyConfig(client *occlient.Client, kClient *kclient.Client, componentConf
591590

592591
var componentName string
593592
var applicationName string
594-
if !isExperimentalModeEnabled || kClient == nil {
593+
if isS2I || kClient == nil {
595594
componentName = componentConfig.GetName()
596595
applicationName = componentConfig.GetApplication()
597596
} else {
@@ -605,13 +604,13 @@ func ApplyConfig(client *occlient.Client, kClient *kclient.Client, componentConf
605604
}
606605

607606
return urlpkg.Push(client, kClient, urlpkg.PushParameters{
608-
ComponentName: componentName,
609-
ApplicationName: applicationName,
610-
ConfigURLs: componentConfig.GetURL(),
611-
EnvURLS: envSpecificInfo.GetURL(),
612-
IsRouteSupported: isRouteSupported,
613-
IsExperimentalModeEnabled: isExperimentalModeEnabled,
614-
EndpointMap: endpointMap,
607+
ComponentName: componentName,
608+
ApplicationName: applicationName,
609+
ConfigURLs: componentConfig.GetURL(),
610+
EnvURLS: envSpecificInfo.GetURL(),
611+
IsRouteSupported: isRouteSupported,
612+
EndpointMap: endpointMap,
613+
IsS2I: isS2I,
615614
})
616615
}
617616

‎pkg/component/component_full_description.go

+12-13
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ import (
88
"github.com/openshift/odo/pkg/config"
99
"github.com/openshift/odo/pkg/log"
1010
"github.com/openshift/odo/pkg/occlient"
11-
"github.com/openshift/odo/pkg/odo/util/experimental"
1211
"github.com/openshift/odo/pkg/storage"
1312
urlpkg "github.com/openshift/odo/pkg/url"
1413
corev1 "k8s.io/api/core/v1"
@@ -192,22 +191,22 @@ func (cfd *ComponentFullDescription) Print(client *occlient.Client) error {
192191
if len(cfd.Spec.URL.Items) > 0 {
193192
var output string
194193

195-
if !experimental.IsExperimentalModeEnabled() {
196-
// if the component is not pushed
197-
for i, componentURL := range cfd.Spec.URL.Items {
198-
if componentURL.Status.State == urlpkg.StateTypePushed {
199-
output += fmt.Sprintf(" · %v exposed via %v\n", urlpkg.GetURLString(componentURL.Spec.Protocol, componentURL.Spec.Host, "", experimental.IsExperimentalModeEnabled()), componentURL.Spec.Port)
194+
// For S2I Only..
195+
// This MUST be changed before merging (this will automatically show URL routes for S2I despite Devfile being default)
196+
for i, componentURL := range cfd.Spec.URL.Items {
197+
if componentURL.Status.State == urlpkg.StateTypePushed {
198+
output += fmt.Sprintf(" · %v exposed via %v\n", urlpkg.GetURLString(componentURL.Spec.Protocol, componentURL.Spec.Host, "", true), componentURL.Spec.Port)
199+
} else {
200+
var p string
201+
if i >= len(cfd.Spec.Ports) {
202+
p = cfd.Spec.Ports[len(cfd.Spec.Ports)-1]
200203
} else {
201-
var p string
202-
if i >= len(cfd.Spec.Ports) {
203-
p = cfd.Spec.Ports[len(cfd.Spec.Ports)-1]
204-
} else {
205-
p = cfd.Spec.Ports[i]
206-
}
207-
output += fmt.Sprintf(" · URL named %s will be exposed via %v\n", componentURL.Name, p)
204+
p = cfd.Spec.Ports[i]
208205
}
206+
output += fmt.Sprintf(" · URL named %s will be exposed via %v\n", componentURL.Name, p)
209207
}
210208
}
209+
211210
// Cut off the last newline and output
212211
if len(output) > 0 {
213212
output = output[:len(output)-1]

‎pkg/debug/portforward.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ func NewDefaultPortForwarder(componentName, appName string, projectName string,
4141
// portPair is a pair of port in format "localPort:RemotePort" that is to be forwarded
4242
// stop Chan is used to stop port forwarding
4343
// ready Chan is used to signal failure to the channel receiver
44-
func (f *DefaultPortForwarder) ForwardPorts(portPair string, stopChan, readyChan chan struct{}, isExperimental bool) error {
44+
func (f *DefaultPortForwarder) ForwardPorts(portPair string, stopChan, readyChan chan struct{}, isDevfile bool) error {
4545
var pod *corev1.Pod
4646
var conf *rest.Config
4747
var err error
4848

49-
if f.kClient != nil && isExperimental {
49+
if f.kClient != nil && isDevfile {
5050
conf, err = f.kClient.KubeConfig.ClientConfig()
5151
if err != nil {
5252
return err
@@ -78,7 +78,7 @@ func (f *DefaultPortForwarder) ForwardPorts(portPair string, stopChan, readyChan
7878
}
7979

8080
var req *rest.Request
81-
if f.kClient != nil && isExperimental {
81+
if f.kClient != nil && isDevfile {
8282
req = f.kClient.GeneratePortForwardReq(pod.Name)
8383
} else {
8484
req = f.client.BuildPortForwardReq(pod.Name)

‎pkg/devfile/adapters/kubernetes/component/adapter.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ func (a Adapter) Push(parameters common.PushParameters) (err error) {
157157
return errors.Wrapf(err, "unable to get pod for component %s", a.ComponentName)
158158
}
159159

160-
err = component.ApplyConfig(nil, &a.Client, config.LocalConfigInfo{}, parameters.EnvSpecificInfo, color.Output, componentExists, endpointsMap)
160+
err = component.ApplyConfig(nil, &a.Client, config.LocalConfigInfo{}, parameters.EnvSpecificInfo, color.Output, componentExists, endpointsMap, false)
161161
if err != nil {
162162
odoutil.LogErrorAndExit(err, "Failed to update config to component deployed.")
163163
}

‎pkg/devfile/validate/components_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ func TestValidateComponents(t *testing.T) {
126126
got := validateComponents(components)
127127
want := "size randomgarbage for volume component myvol is invalid"
128128

129-
if !strings.Contains(got.Error(), want) {
129+
if got != nil && !strings.Contains(got.Error(), want) {
130130
t.Errorf("TestValidateComponents error - got: '%v', want substring: '%v'", got.Error(), want)
131131
}
132132
})

‎pkg/occlient/occlient.go

-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ import (
2222
"github.com/openshift/odo/pkg/config"
2323
"github.com/openshift/odo/pkg/devfile/adapters/common"
2424
"github.com/openshift/odo/pkg/log"
25-
"github.com/openshift/odo/pkg/odo/util/experimental"
2625
"github.com/openshift/odo/pkg/preference"
2726
"github.com/openshift/odo/pkg/util"
2827

@@ -719,10 +718,6 @@ func (c *Client) GetImageStream(imageNS string, imageName string, imageTag strin
719718
}
720719
}
721720
if e != nil && err != nil {
722-
// Imagestream not found in openshift and current namespaces
723-
if experimental.IsExperimentalModeEnabled() {
724-
return nil, fmt.Errorf("component type %q not found", imageName)
725-
}
726721
return nil, err
727722
}
728723

‎pkg/odo/cli/catalog/describe/component.go

+48-58
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,11 @@ import (
1313
"github.com/openshift/odo/pkg/log"
1414
"github.com/openshift/odo/pkg/machineoutput"
1515
"github.com/openshift/odo/pkg/odo/genericclioptions"
16-
"github.com/openshift/odo/pkg/odo/util/experimental"
1716
"github.com/openshift/odo/pkg/odo/util/pushtarget"
1817
"github.com/openshift/odo/pkg/util"
1918
"github.com/pkg/errors"
2019
"github.com/spf13/cobra"
2120
"gopkg.in/yaml.v2"
22-
"k8s.io/klog"
2321
ktemplates "k8s.io/kubectl/pkg/util/templates"
2422
)
2523

@@ -62,11 +60,7 @@ func (o *DescribeComponentOptions) Complete(name string, cmd *cobra.Command, arg
6260
tasks.Add(util.ConcurrentTask{ToRun: func(errChannel chan error) {
6361
catalogList, err := catalog.ListComponents(o.Client)
6462
if err != nil {
65-
if experimental.IsExperimentalModeEnabled() {
66-
klog.V(4).Info("Please log in to an OpenShift cluster to list OpenShift/s2i components")
67-
} else {
68-
errChannel <- err
69-
}
63+
errChannel <- err
7064
}
7165
for _, image := range catalogList.Items {
7266
if image.Name == o.componentName {
@@ -76,18 +70,16 @@ func (o *DescribeComponentOptions) Complete(name string, cmd *cobra.Command, arg
7670
}})
7771
}
7872

79-
if experimental.IsExperimentalModeEnabled() {
80-
tasks.Add(util.ConcurrentTask{ToRun: func(errChannel chan error) {
81-
catalogDevfileList, err := catalog.ListDevfileComponents("")
82-
if catalogDevfileList.DevfileRegistries == nil {
83-
log.Warning("Please run 'odo registry add <registry name> <registry URL>' to add registry for listing devfile components\n")
84-
}
85-
if err != nil {
86-
errChannel <- err
87-
}
88-
o.GetDevfileComponentsByName(catalogDevfileList)
89-
}})
90-
}
73+
tasks.Add(util.ConcurrentTask{ToRun: func(errChannel chan error) {
74+
catalogDevfileList, err := catalog.ListDevfileComponents("")
75+
if catalogDevfileList.DevfileRegistries == nil {
76+
log.Warning("Please run 'odo registry add <registry name> <registry URL>' to add registry for listing devfile components\n")
77+
}
78+
if err != nil {
79+
errChannel <- err
80+
}
81+
o.GetDevfileComponentsByName(catalogDevfileList)
82+
}})
9183

9284
return tasks.Run()
9385
}
@@ -103,50 +95,48 @@ func (o *DescribeComponentOptions) Validate() (err error) {
10395

10496
// Run contains the logic for the command associated with DescribeComponentOptions
10597
func (o *DescribeComponentOptions) Run() (err error) {
106-
if experimental.IsExperimentalModeEnabled() {
107-
w := tabwriter.NewWriter(os.Stdout, 5, 2, 3, ' ', tabwriter.TabIndent)
108-
if log.IsJSON() {
109-
if len(o.devfileComponents) > 0 {
110-
for _, devfileComponent := range o.devfileComponents {
111-
devObj, err := GetDevfile(devfileComponent)
112-
if err != nil {
113-
return err
114-
}
115-
116-
machineoutput.OutputSuccess(devObj)
98+
w := tabwriter.NewWriter(os.Stdout, 5, 2, 3, ' ', tabwriter.TabIndent)
99+
if log.IsJSON() {
100+
if len(o.devfileComponents) > 0 {
101+
for _, devfileComponent := range o.devfileComponents {
102+
devObj, err := GetDevfile(devfileComponent)
103+
if err != nil {
104+
return err
117105
}
106+
107+
machineoutput.OutputSuccess(devObj)
118108
}
119-
} else {
120-
if len(o.devfileComponents) > 1 {
121-
log.Warningf("There are multiple components named \"%s\" in different multiple devfile registries.\n", o.componentName)
122-
}
123-
if len(o.devfileComponents) > 0 {
124-
fmt.Fprintln(w, "Devfile Component(s):")
125-
126-
for _, devfileComponent := range o.devfileComponents {
127-
fmt.Fprintln(w, "\n* Registry: "+devfileComponent.Registry.Name)
128-
129-
devObj, err := GetDevfile(devfileComponent)
130-
if err != nil {
131-
return err
132-
}
133-
134-
projects := devObj.Data.GetStarterProjects()
135-
// only print project info if there is at least one project in the devfile
136-
err = o.PrintDevfileStarterProjects(w, projects, devObj)
137-
if err != nil {
138-
return err
139-
}
109+
}
110+
} else {
111+
if len(o.devfileComponents) > 1 {
112+
log.Warningf("There are multiple components named \"%s\" in different multiple devfile registries.\n", o.componentName)
113+
}
114+
if len(o.devfileComponents) > 0 {
115+
fmt.Fprintln(w, "Devfile Component(s):")
116+
117+
for _, devfileComponent := range o.devfileComponents {
118+
fmt.Fprintln(w, "\n* Registry: "+devfileComponent.Registry.Name)
119+
120+
devObj, err := GetDevfile(devfileComponent)
121+
if err != nil {
122+
return err
123+
}
124+
125+
projects := devObj.Data.GetStarterProjects()
126+
// only print project info if there is at least one project in the devfile
127+
err = o.PrintDevfileStarterProjects(w, projects, devObj)
128+
if err != nil {
129+
return err
140130
}
141-
} else {
142-
fmt.Fprintln(w, "There are no Odo devfile components with the name \""+o.componentName+"\"")
143-
}
144-
if o.component != "" {
145-
fmt.Fprintln(w, "\nS2I Based Components:")
146-
fmt.Fprintln(w, "-"+o.component)
147131
}
148-
fmt.Fprintln(w)
132+
} else {
133+
fmt.Fprintln(w, "There are no Odo devfile components with the name \""+o.componentName+"\"")
134+
}
135+
if o.component != "" {
136+
fmt.Fprintln(w, "\nS2I Based Components:")
137+
fmt.Fprintln(w, "-"+o.component)
149138
}
139+
fmt.Fprintln(w)
150140
}
151141

152142
return nil

‎pkg/odo/cli/cli.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -204,12 +204,12 @@ func odoRootCmd(name, fullName string) *cobra.Command {
204204
config.NewCmdConfiguration(config.RecommendedCommandName, util.GetFullName(fullName, config.RecommendedCommandName)),
205205
preference.NewCmdPreference(preference.RecommendedCommandName, util.GetFullName(fullName, preference.RecommendedCommandName)),
206206
debug.NewCmdDebug(debug.RecommendedCommandName, util.GetFullName(fullName, debug.RecommendedCommandName)),
207+
registry.NewCmdRegistry(registry.RecommendedCommandName, util.GetFullName(fullName, registry.RecommendedCommandName)),
208+
component.NewCmdTest(component.TestRecommendedCommandName, util.GetFullName(fullName, component.TestRecommendedCommandName)),
207209
)
208210

209211
if experimental.IsExperimentalModeEnabled() {
210212
rootCmd.AddCommand(
211-
registry.NewCmdRegistry(registry.RecommendedCommandName, util.GetFullName(fullName, registry.RecommendedCommandName)),
212-
component.NewCmdTest(component.TestRecommendedCommandName, util.GetFullName(fullName, component.TestRecommendedCommandName)),
213213
env.NewCmdEnv(env.RecommendedCommandName, util.GetFullName(fullName, env.RecommendedCommandName)),
214214
)
215215
}

‎pkg/odo/cli/component/common_link.go

+7-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import (
1212
"github.com/openshift/odo/pkg/log"
1313
"github.com/openshift/odo/pkg/occlient"
1414
"github.com/openshift/odo/pkg/odo/genericclioptions"
15-
"github.com/openshift/odo/pkg/odo/util/experimental"
1615
"github.com/openshift/odo/pkg/secret"
1716
svc "github.com/openshift/odo/pkg/service"
1817
"github.com/openshift/odo/pkg/util"
@@ -38,6 +37,8 @@ type commonLinkOptions struct {
3837
secretName string
3938
isTargetAService bool
4039

40+
devfilePath string
41+
4142
suppliedName string
4243
operation func(secretName, componentName, applicationName string) error
4344
operationName string
@@ -55,12 +56,13 @@ func newCommonLinkOptions() *commonLinkOptions {
5556

5657
// Complete completes LinkOptions after they've been created
5758
func (o *commonLinkOptions) complete(name string, cmd *cobra.Command, args []string) (err error) {
59+
5860
o.operationName = name
5961

6062
suppliedName := args[0]
6163
o.suppliedName = suppliedName
6264

63-
if experimental.IsExperimentalModeEnabled() {
65+
if util.CheckPathExists(o.devfilePath) {
6466
o.Context = genericclioptions.NewDevfileContext(cmd)
6567

6668
oclient, err := occlient.New()
@@ -161,7 +163,7 @@ func (o *commonLinkOptions) complete(name string, cmd *cobra.Command, args []str
161163

162164
func (o *commonLinkOptions) validate(wait bool) (err error) {
163165

164-
if experimental.IsExperimentalModeEnabled() {
166+
if util.CheckPathExists(o.devfilePath) {
165167
// let's validate if the service exists
166168
svcFullName := strings.Join([]string{o.serviceType, o.serviceName}, "/")
167169
svcExists, err := svc.OperatorSvcExists(o.KClient, svcFullName)
@@ -227,7 +229,8 @@ func (o *commonLinkOptions) validate(wait bool) (err error) {
227229
}
228230

229231
func (o *commonLinkOptions) run() (err error) {
230-
if experimental.IsExperimentalModeEnabled() {
232+
233+
if util.CheckPathExists(o.devfilePath) {
231234
// convert service binding request into a ma[string]interface{} type so
232235
// as to use it with dynamic client
233236
sbrMap := make(map[string]interface{})

‎pkg/odo/cli/component/common_push.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ func (cpo *CommonPushOptions) createCmpIfNotExistsAndApplyCmpConfig(stdout io.Wr
128128
}
129129
}
130130
// Apply config
131-
err := component.ApplyConfig(cpo.Context.Client, nil, *cpo.LocalConfigInfo, envinfo.EnvSpecificInfo{}, stdout, cpo.doesComponentExist, map[int32]parsercommon.Endpoint{})
131+
err := component.ApplyConfig(cpo.Context.Client, nil, *cpo.LocalConfigInfo, envinfo.EnvSpecificInfo{}, stdout, cpo.doesComponentExist, map[int32]parsercommon.Endpoint{}, true)
132132
if err != nil {
133133
odoutil.LogErrorAndExit(err, "Failed to update config to component deployed.")
134134
}

‎pkg/odo/cli/component/component.go

+2
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,8 @@ func NewCmdComponent(name, fullName string) *cobra.Command {
7373
componentCmd.Flags().AddFlagSet(componentGetCmd.Flags())
7474

7575
componentCmd.AddCommand(componentGetCmd, createCmd, deleteCmd, describeCmd, linkCmd, unlinkCmd, listCmd, logCmd, pushCmd, updateCmd, watchCmd, execCmd)
76+
77+
// Experimental feature to be added, "odo test" command.
7678
if experimental.IsExperimentalModeEnabled() {
7779
componentCmd.AddCommand(testCmd)
7880
}

0 commit comments

Comments
 (0)