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

procedures: List, create, start, stop, and remove one or more workspaces by using APIs #2487

Closed
wants to merge 6 commits into from
Closed

procedures: List, create, start, stop, and remove one or more workspaces by using APIs #2487

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
00ce7bb
edits
max-cx Nov 7, 2022
c63ddac
Merge branch 'eclipse-che:main' into apiissues
max-cx Nov 7, 2022
95e1091
move the page from admin to user guide
max-cx Nov 8, 2022
f3a5c36
Merge branch 'main' into apiissues
themr0c Nov 9, 2022
4dc2c09
Update modules/end-user-guide/pages/managing-workspaces-with-apis.adoc
nickboldt Jan 17, 2023
aeda44f
Update modules/end-user-guide/pages/managing-workspaces-with-apis.adoc
nickboldt Jan 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/end-user-guide/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
** xref:mounting-configmaps.adoc[]
* xref:requesting-persistent-storage-for-workspaces.adoc[]
* xref:integrating-with-kubernetes.adoc[]
** xref:managing-workspaces-with-apis.adoc[]
** xref:automatic-token-injection.adoc[]
** xref:navigating-che-from-openshift-developer-perspective.adoc[]
** xref:navigating-openshift-web-console-from-che.adoc[]
Expand Down
24 changes: 24 additions & 0 deletions modules/end-user-guide/pages/managing-workspaces-with-apis.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:_content-type: ASSEMBLY
:navtitle: Managing workspaces with OpenShift APIs
:description: Managing workspaces with OpenShift APIs
:keywords: api, list workspaces, create workspace, restart workspace, stop workspace, start workspace, remove workspace
// :page-aliases:

[id="managing-workspaces-with-apis"]
= Managing workspaces with OpenShift APIs

...

Consider writing this entire page as a reference. (If so, then rename all the files in `/partials/` and in the `include::` statements below from `proc_` to `ref_`.)
nickboldt marked this conversation as resolved.
Show resolved Hide resolved

include::partial$proc_listing-workspaces.adoc[leveloffset=+1]

include::partial$proc_creating-workspaces.adoc[leveloffset=+1]

include::partial$proc_restarting-workspaces.adoc[leveloffset=+1]

include::partial$proc_stopping-workspaces.adoc[leveloffset=+1]

include::partial$proc_starting-stopped-workspaces.adoc[leveloffset=+1]

include::partial$proc_removing-workspaces.adoc[leveloffset=+1]
5 changes: 5 additions & 0 deletions modules/end-user-guide/partials/proc_creating-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

[id="creating-workspaces"]
= Creating workspaces

Rough technical info to be dumped here by the assigned SME.
15 changes: 15 additions & 0 deletions modules/end-user-guide/partials/proc_listing-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

[id="listing-workspaces"]
= Listing workspaces

Explain why `--all-namespaces`.

[source,subs="+attributes"]
----
$ {orch-cli} get devworkspace --all-namespaces
----

TIP: You can add the `--watch` flag.

To be confirmed by the assigned SME.

5 changes: 5 additions & 0 deletions modules/end-user-guide/partials/proc_removing-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

[id="removing-workspaces"]
= Removing workspaces

Rough technical info to be dumped here by the assigned SME.
5 changes: 5 additions & 0 deletions modules/end-user-guide/partials/proc_restarting-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

[id="restarting-workspaces"]
= Restarting workspaces

Rough technical info to be dumped here by the assigned SME.
5 changes: 5 additions & 0 deletions modules/end-user-guide/partials/proc_starting-stopped-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

[id="starting-stopped-workspaces"]
= Starting stopped workspaces

Rough technical info to be dumped here by the assigned SME.
5 changes: 5 additions & 0 deletions modules/end-user-guide/partials/proc_stopping-workspaces.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@

[id="stopping-workspaces"]
= Stopping workspaces

Rough technical info to be dumped here by the assigned SME.