Uploaded image for project: 'Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces) '
  1. Red Hat OpenShift Dev Spaces (formerly CodeReady Workspaces)
  2. CRW-2160

Propose procedures to list, create, start, stop, and remove one or more workspaces by using APIs

XMLWordPrintable

      Collaborate with the assigned technical writer and propose (rough draft dump) the following procedures to be documented by the technical writer:

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

      = Listing workspaces

      = Creating workspaces

      = Restarting workspaces

      = Stopping workspaces

      = Starting stopped workspaces

      = Removing workspaces

      See Mario's comment below: https://issues.redhat.com/browse/CRW-2160?focusedCommentId=19388794&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-19388794

       

      Require following functionality in CRW( that is currently not available) 

      • superadmin to be able to list all the workspaces for all user (instead of just the workspaces belonging to whoever is using the CLI) 
      • superadmin to be able to manage all users(create,remove) and workspaces(create,start,stop,delete) 

      Customers initially asked for API use, but that was before the switch to the DevWorkspace Operator. So we'll probably need to explore both an API implementation in the context of OpenShift and if any other OpenShift-related methods may be offered as alternatives to API use, like Mario mentioned the `oc` command.

      We need to enable Dev Spaces admins to do the following:

      • manage (create/onboard, remove/delete) all/any users
      • manage (create, start, stop, remove/delete) all/any users' specific workspaces (all workspaces in one particular cluster)
      • list workspaces of all users (in addition to listing the workspaces of any specific user(s))
      • modify workspaces
      • delete workspaces of users based on some criteria
      • display statistics/info of running workspaces
      • automate administration of CRW in previous points

      Quoting the customers who opened support cases:

      • "Is codeready provide any API by using which we can automate the provisioning of workspace i.e. we can onboard the user, create workspace. So that we can automate it or integrate it with CI/CD. If yes, please provide the documentation to achieve the same."
      • "Hi, as an administrator I'd like to delete workspaces of users based on some criteria. Does CRW have an api for admins to manage crw resources and execute admin related tasks such as deleting/modifying user workspace and displaying statistics/info of running workspaces?"

              rhn-support-mleonov Max Leonov
              rhn-support-sbhavsar Sayali Bhavsar
              Max Leonov Max Leonov
              Votes:
              1 Vote for this issue
              Watchers:
              7 Start watching this issue

                Created:
                Updated:
                Resolved: