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

[chectl] Be more specific in the help about the --domain option #14404

Closed
themr0c opened this issue Sep 2, 2019 · 5 comments
Closed

[chectl] Be more specific in the help about the --domain option #14404

themr0c opened this issue Sep 2, 2019 · 5 comments
Labels
area/chectl Issues related to chectl, the CLI of Che 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

Comments

@themr0c
Copy link
Contributor

themr0c commented Sep 2, 2019

Context:

After the installation of Code-Ready containers, the user has knowledge of these two URLs:

crc start
...
INFO To access the cluster using 'oc', run 'eval $(crc oc-env) && oc login -u kubeadmin -p XXXXX-XXXXX-XXXXX-XXXXX https://api.crc.testing:6443' 
INFO Access the OpenShift web-console here: https://console-openshift-console.apps-crc.testing 

Then he needs to fill in a domain option to start a Che server.
The current documentation of the --domain option when using chectl --help is not specific enough to help the user choose the right domain.

chectl --help
...
--domain=domain                          Domain of the Kubernetes/OpenShift cluster (e.g. 
                                               starter-us-east-2.openshiftapps.com or <local-ip>.nip.io)

For a crc, instance, correct value would be --domain=.apps-crc.testing.

In other usecases, the user should be helped to decide which domain would be the right one.

Thanks @benoitf fot all the hints.

@themr0c themr0c added the kind/enhancement A feature request - must adhere to the feature request template. label Sep 2, 2019
@benoitf benoitf added the area/chectl Issues related to chectl, the CLI of Che label Sep 2, 2019
@benoitf benoitf added this to the 7.2.0 milestone Sep 2, 2019
@benoitf benoitf self-assigned this Sep 2, 2019
@ibuziuk ibuziuk added the severity/P2 Has a minor but important impact to the usage or development of the system. label Sep 2, 2019
@sleshchenko
Copy link
Member

The latest info about --domain parameter is the following:

 -b, --domain=domain: 
  Domain of the Kubernetes cluster (e.g. example.k8s-cluster.com or <local-ip>.nip.io)

Actually, you do not have to specify a domain for OpenShift installation since it's totally ignored.

But I think it makes sense to keep this issue and maybe UX even better and make it clear that it's unneeded for OpenShift.

cc @benoitf

@themr0c
Copy link
Contributor Author

themr0c commented Sep 3, 2019

In the stable release, the domain option is mandatory: my first run failed because I had not specified the --domain parameter.

Is there a way to install latest (unreleased) version of che-incubator/chectl to install the released versions of eclipse/che?

The README.md for chectl is not absolutely clear: "Next is updated after each commit/Pull Request being merged in master branch." Could it be specified if it is the master branch of eclipse/che or of che-incubator/chectl?

@benoitf
Copy link
Contributor

benoitf commented Sep 4, 2019

@themr0c domain is mandatory for k8s/openshift but it's not for minikube/minishift.
I think we can make it optional for crc as well (computing it)

Is there a way to install latest (unreleased) version of che-incubator/chectl to install the released versions of eclipse/che?

By default, unreleased version of chectl are deploying nightlies of che
but by providing some flag you can give the che-server image that you want (and use there latest/7.0.0/7.1.0 tags)

The README.md for chectl is not absolutely clear: "Next is updated after each commit/Pull Request being merged in master branch." Could it be specified if it is the master branch of eclipse/che or of che-incubator/chectl?

thx for reporting. It's updated after each commit inside chectl. Do you want to propose a PR to improve it ?

@gazarenkov gazarenkov removed this from the 7.2.0 milestone Oct 2, 2019
@tolusha tolusha added severity/P1 Has a major impact to usage or development of the system. and removed severity/P2 Has a minor but important impact to the usage or development of the system. labels Feb 27, 2020
@tolusha tolusha added this to the Backlog - Deploy milestone Feb 27, 2020
@tolusha
Copy link
Contributor

tolusha commented Feb 27, 2020

#16121

@mmorhun
Copy link
Contributor

mmorhun commented Apr 3, 2020

Added extended description into chectl help and readme.

@mmorhun mmorhun closed this as completed Apr 3, 2020
@tolusha tolusha modified the milestones: Backlog - Deploy, 7.11 Apr 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/chectl Issues related to chectl, the CLI of Che 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
Development

No branches or pull requests

7 participants