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.

Sign up for GitHub

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

Jump to bottom

Clarify behaviour of chectl/crwctl 's default installer mode in inline docs #17165

Closed
nickboldt opened this issue Jun 16, 2020 · 4 comments
Closed

Clarify behaviour of chectl/crwctl 's default installer mode in inline docs #17165

nickboldt opened this issue Jun 16, 2020 · 4 comments
Assignees
@davidfestal @tolusha @mmorhun
Labels
area/chectl Issues related to chectl, the CLI of Che area/install Issues related to installation, including offline/air gap and initial setup kind/enhancement A feature request - must adhere to the feature request template. severity/P1 Has a major impact to usage or development of the system.
Milestone
7.17

Comments

@nickboldt
Copy link
Contributor

I've heard that when using chectl/crwctl to install, different behaviours are the default.

  • OCP 3.11 :: -a operator
  • OCP 4.x :: -a olm

Yet in the inline help:

$➔ crwctl server:start --help
start CodeReady Workspaces server

USAGE
  $ crwctl server:start

OPTIONS
  -a, --installer=operator|olm
      [default: operator] Installer type

There is no mention of this platform-specific default behaviour.

Furthermore, what happens if you're installing on OCP 3.11 BUT you have OLM installed on that cluster? Will OLM mode be the default? Or will it still be operator?

Is this behaviour driven by detection of OLM, or by OCP version? (IMHO it should be driven by the presence of OLM in the target cluster, so we can use OLM installer mode on OCP 3 if OLM is present.)

Also, since we do not want to support the old operator method on OCP 4, what happens if a user EXPLICITLY asks for -a operator on OCP 4.4? I would expect this:

  • an error is thrown preventing install because operator is not supported on OCP 4, or
  • a warning is thrown, telling the user that operator method is not supported and we've automatically switched them to olm mode

Personally, I would prefer an error since it forces the user to fix their mistake, but UX team might feel that an approach of "we know you asked for operator but we know you really want olm so that's what you're getting instead" might be acceptable too.

cc: @RickJWagner
@nickboldt nickboldt added the kind/enhancement A feature request - must adhere to the feature request template. label Jun 16, 2020
@nickboldt nickboldt changed the title Clarify behaviour of chectl/crwctl in inline docs Clarify behaviour of chectl/crwctl 's default installer mode in inline docs Jun 16, 2020
@che-bot che-bot added the status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. label Jun 16, 2020
@nickboldt
Copy link
Contributor Author

Related to:

@nickboldt nickboldt added this to the 7.15 milestone Jun 16, 2020
@RomanNikitenko RomanNikitenko added area/chectl Issues related to chectl, the CLI of Che severity/P1 Has a major impact to usage or development of the system. area/install Issues related to installation, including offline/air gap and initial setup and removed status/need-triage An issue that needs to be prioritized by the curator responsible for the triage. See https://github. labels Jun 16, 2020
@nickboldt nickboldt modified the milestones: 7.15, 7.16 Jun 25, 2020
@tolusha tolusha modified the milestones: 7.16, Backlog - Deploy Jul 9, 2020
@tolusha tolusha mentioned this issue Jul 13, 2020
Closed
10 tasks
@tolusha tolusha modified the milestones: Backlog - Deploy, 7.16 Jul 14, 2020
@tolusha
Copy link
Contributor

tolusha commented Jul 20, 2020

  1. platform-specific default behaviour.

In general case the default installer type depends on chectl flags.
We just can mention, that olm is used for openshift 4.x
https://github.com/che-incubator/chectl/blob/master/src/commands/server/start.ts#L431-L446

  1. Furthermore, what happens if you're installing on OCP 3.11 BUT you have OLM installed on that cluster? Will OLM mode be the default? Or will it still be operator?

operator will be used

  1. Also, since we do not want to support the old operator method on OCP 4, what happens if a user EXPLICITLY asks for -a operator on OCP 4.4? I would expect this.

operator will be used.
In case not supporting something, that an issue for downstream project. And only there we should have restrict using operator for OCP4.x

@tolusha
Copy link
Contributor

tolusha commented Jul 20, 2020

Currently:

  1. the default value for operator flag is empty
  2. autodetection is used for installer type https://github.com/che-incubator/chectl/blob/master/src/commands/server/start.ts#L431-L446
  3. the installer type is printed in the log
    › Installer type is set to: <...>

/cc @nickboldt

@tolusha tolusha mentioned this issue Jul 21, 2020
Merged
@tolusha
Copy link
Contributor

tolusha commented Jul 21, 2020

Fixed che-incubator/chectl@b7719da

@tolusha tolusha closed this as completed Jul 21, 2020
@tolusha tolusha modified the milestones: 7.16, 7.17 Jul 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@davidfestal davidfestal

@tolusha tolusha

@mmorhun mmorhun

Labels
area/chectl Issues related to chectl, the CLI of Che area/install Issues related to installation, including offline/air gap and initial setup kind/enhancement A feature request - must adhere to the feature request template. severity/P1 Has a major impact to usage or development of the system.
Projects
None yet
Milestone
7.17
Development

No branches or pull requests
6 participants
@nickboldt @davidfestal @tolusha @RomanNikitenko @mmorhun @che-bot