CodeReady Workspace quick guide

[j-c-berger]

For issue #2407-Support for CodeReady Workspaces

@AndyRWatson, tagging you since you opened the issue. @micgibso, tagging you for your awareness as well.

I'm not sure if these instructions for developing a microservice are applicable for CodeReady Workspaces (I took these instructions from our other quick guides), but I thought it at least gives us a starting point.

Note, I took a lot of this content for Knowledge Center's Installing CodeReady Workspaces. I worked on this content a couple months ago.

[j-c-berger]

@johnmcollier, new commit is up. If it looks good, I can get SVT to run through and test it.

[johnmcollier]

Left some review comments. Rest looks good.

I'll also get some screenshots for the CRW install step, as I think they will help things.

[j-c-berger]

@johnmcollier, thanks, I addressed your comments and made a new commit. I reordered some content, per your comments. I'll include the screenshots once you get them to me.

@naveenkaratekid, I think it's ready for you to test it since we're only waiting on screenshots now. Thanks!

[j-c-berger]

@johnmcollier and @naveenkaratekid, new commit with images included is up, thanks!

[j-c-berger]

@johnmcollier and @naveenkaratekid, new commit is up which includes the new instructions and yaml file John provided.

Should we include instructions or a link to setting up an OpenShift cluster? The first step for Installing CodeReady Workspaces requires users to log into their OpenShift clusters, and I wonder if some users won't have an OpenShift cluster already.

I have the same thought when we say in the Prerequisites to apply the Codewind cluster role with oc apply -f. I thought I could provide more context to users. Are they applying the oc apply -f command in the command line?

I think my images are showing up as broken links because they don't exist in the images folder. They only exist on this PR. So let me know if you have any questions about the order of the screenshots.

Thanks!

[j-c-berger]

@johnmcollier, please see new commit and let me know if the instructions are accurate and what you intended. Same goes for placement of screenshots.

@naveenkaratekid, if you could test it today with these new instructions, that'd be great!

[johnmcollier]

@j-c-berger I think we just need to make an OpenShift cluster a prerequisite for the quick guide.

And yes, the oc apply commands are done on the command line.

[j-c-berger]

@johnmcollier, thank for the review! New commit is up, reflecting the changes.

For the prerequisites, I know we want to add installing an OpenShift cluster. I know we talk about clusters some in our installing Eclipse Che doc. I didn't know if you wanted to adapt some of the instructions there.

[naveenkaratekid]

@johnmcollier Step 6 in the guide is not very clear

CodeReady Workspaces now installs and you can access the CodeReady Workspaces URL and Red Hat SSO Admin Console URL

I assumed that I would need to click on this link codeready-default.apps.cretic.os.fyre.ibm.com , but when I did that, it took me to this page.

The guide didn't state how we are supposed to log in

[johnmcollier]

@naveenkaratekid You'll need to click register to create an account.

@j-c-berger Can you add that to the post-install instructions? Basically before we log in to CodeReady Workspaces to create a codewind workspace

[AndyRWatson]

I just tried following the guide, using the updates. When running prerequisite steps, I setup a OCP on IBM cloud, then I assumed I should login from the command line (need to state this step) and the performed

oc apply -f

and got the response

error: error reading ".": open .Trash: operation not permitted

I assume more is required to apply a codewind cluster or there maybe a missing step(s) here ?

[AndyRWatson]

For the step

1. Log in to your OpenShift cluster.

is this still command line or webui ? I assume this is the Openshift web console ?

[AndyRWatson]

    If you did not set up an auth provider, set openShiftoAuth to false.
    To enable HTTPS, set tlsSupport to true.
    If you use a self-signed certificate, set selfSignedCert to true.

For a guide I think we should let people know how to do this, I think some people may drop out here unless we are prerequing users must be skilled at OpenShift setup and configuration ?

It would be useful for the guide to also explain why these are relevant and why you have/may consider making these changes

[AndyRWatson]

when installing the codeready operator, is the recomendation step 4 or step 5 ? I could update my tls in the editor in 4 and then overwrite that change via c+p in step 5 ?

As a guide i'd like to understand what I am changing and why those pieces matter to me as a user of codewind.

[AndyRWatson]

    To manually install Codewind with CodeReady Workspaces, save this yaml to a disk and run oc apply -f <yaml>.
    If you did not set up an auth provider, set openShiftoAuth to false.
    To enable HTTPS, set tlsSupport to true.
    If you use a self-signed certificate, set selfSignedCert to true.

how do I save the yaml to a disk ? And if we're now going back to the command line window maybe we should clarify the switch For the next steps do we set auth/https/certs via the command line, in the yaml or by going back to the openshift console ?

[AndyRWatson]

6. CodeReady Workspaces now installs and you can access the CodeReady Workspaces URL and Red Hat SSO Admin Console URL:

How do I discover the URLs ?

[johnmcollier]

@AndyRWatson For the configuration:

    If you did not set up an auth provider, set openShiftoAuth to false.
    To enable HTTPS, set tlsSupport to true.
    If you use a self-signed certificate, set selfSignedCert to true.

I'd rather we almost leave them out, as it's outside of the scope of this quick guide. The only one applicable would be set selfSignedCert to true if on IBM Public Cloud.

[j-c-berger]

@AndyRWatson and @johnmcollier, great review and feedback! I put the new commit up. Let me know what the two of you think. Hopefully, Andy, these new instructions make the development process easier and clearer.

[j-c-berger]

@johnmcollier, please see new commit, and let me know if the content looks look. Per the issues with Appsody on Kube, the guide focuses solely on installing CodeReady Workspaces and Codewind and setting up a Codewind workspace.

@micgibso, as you'll see, I made the metadata changes. However, this is what I see when I render the guide locally:

I believe it's because my branch was made off master before James made these changes to guides' metadata. I think once this PR is merged, the objectives and icon will display properly because the branch will then be in sync with the newest master. I wanted to confirm with you though before anything is merged. Thanks!

[johnmcollier]

Looks good apart from one nit

[j-c-berger]

@micgibso, PR is ready to merge. @johnmcollier reviewed it and had one change to the prerequisite. See the new commit for those changes.

Also, please note my earlier comment about the metadata and this branch being made off an old form of master. I don't think that will be an issue after merging this PR but thought you should know. Thanks!

[micgibso]

Lgtm

Resolved