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

[docs] Managing workspaces via kubectl #21808

Closed
7 tasks
Tracked by #21925 ...
ibuziuk opened this issue Nov 8, 2022 · 10 comments
Closed
7 tasks
Tracked by #21925 ...

[docs] Managing workspaces via kubectl #21808

ibuziuk opened this issue Nov 8, 2022 · 10 comments
Assignees
Labels
area/doc Issues related to documentation severity/P1 Has a major impact to usage or development of the system. sprint/current

Comments

@ibuziuk
Copy link
Member

ibuziuk commented Nov 8, 2022

List of the functionality that is expected to be documented as part of new section Managing workspaces via kubectl - https://www.eclipse.org/che/docs/stable/end-user-guide/integrating-with-kubernetes/

  • Managing users' workspaces with OpenShift APIs* (and/or Kubernetes API server)

  • Listing workspaces*

  • Creating workspaces*

  • Restarting workspaces*

  • Stopping workspaces*

  • Starting stopped workspaces*

  • Removing workspaces

Downstream issue - https://issues.redhat.com/browse/CRW-2160

@ibuziuk ibuziuk added sprint/next severity/P1 Has a major impact to usage or development of the system. area/doc Issues related to documentation labels Nov 8, 2022
@max-cx
Copy link

max-cx commented Nov 8, 2022

I got as far as testing $ chectl/oc get devworkspace --all-namespaces (TIP: --watch), but the rest of the commands don't have a clearcut presence in the kubectl/oc docs, so I'd better rely on the assigned developer to come up with approaches and commands that customers/users can confidently use in production.

Advice for the assignee developer: please first read the downstream issue (linked above) and then add your content to eclipse-che/che-docs#2487. (I just need the technical info from you, and I'll take care of writing the final PR text with your engineering reviews.)

@tolusha
Copy link
Contributor

tolusha commented Nov 9, 2022

Here is some examples
#20671 (comment)

I think we can ask either QE team @dmytro-ndp if they have those commands in some internal docs

@dmytro-ndp
Copy link
Contributor

dmytro-ndp commented Nov 9, 2022

@tolusha : that was correct assumption.

There are test scripts developed by @artaleks9 :

An example of create, start, stop, delete commands for NodeJsExpressWebApplication sample workspace with VS Code Editor: https://main-jenkins-csb-crwqe.apps.ocp-c1.prod.psi.redhat.com/job/Testing/job/e2e/job/basic/job/api-tests/672/consoleFull

@ibuziuk ibuziuk mentioned this issue Nov 22, 2022
68 tasks
@themr0c
Copy link
Contributor

themr0c commented Nov 22, 2022

Reference in Jira: https://issues.redhat.com/browse/RHDEVDOCS-3216

@dkwon17
Copy link
Contributor

dkwon17 commented Nov 22, 2022

Hello @max-cx @tolusha @dmytro-ndp, if no one has done so already, I am interested in working on this issue (adding content to eclipse-che/che-docs#2487 based on examples from #21808 (comment) and #21808 (comment))

@tolusha
Copy link
Contributor

tolusha commented Nov 23, 2022

@dkwon17
That would be nice!

@max-cx max-cx assigned dkwon17 and unassigned max-cx Nov 23, 2022
@max-cx
Copy link

max-cx commented Nov 23, 2022

@dkwon17 , thank you. I'm very much looking forward to working with you on this. I've assigned this issue to you now (my handle was just a placeholder). FYI, there's also the downstream issue (I've made you the assignee there too just for clarity): https://issues.redhat.com/browse/CRW-2160.

@nickboldt nickboldt removed the team/doc label Dec 9, 2022
@ibuziuk
Copy link
Member Author

ibuziuk commented Dec 13, 2022

@max-cx PR has been opened and waiting for review - eclipse-che/che-docs#2510

@ibuziuk ibuziuk mentioned this issue Dec 13, 2022
82 tasks
@max-cx
Copy link

max-cx commented Dec 14, 2022

@ibuziuk, thank you for the reminder. I am well aware of eclipse-che/che-docs#2510. I currently have no bandwidth to work on it before the holidays. This will be my priority when I'm back in January. I'm very much looking forward to working on the content that David has drafted and doing my review, testing, and editing.

@ibuziuk
Copy link
Member Author

ibuziuk commented Feb 3, 2023

thank you. Closing

@ibuziuk ibuziuk closed this as completed Feb 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/doc Issues related to documentation severity/P1 Has a major impact to usage or development of the system. sprint/current
Projects
None yet
Development

No branches or pull requests

7 participants