Skip to content

Commit

Permalink
Add documentation for codespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
perlpunk committed Jun 4, 2024
1 parent 700f26c commit 57c005f
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,12 @@ link:docs/UsersGuide.asciidoc[Users Guide].
If you are interested in writing tests using openQA read the
link:docs/WritingTests.asciidoc[Tests Developer Guide].

Try out running tests without installing openQA in
Try out running tests with openQA in a browser in
https://codespaces.new/os-autoinst/openQA?quickstart=1[our Codespace].
See also: https://docs.github.com/en/codespaces[GitHub Codespaces documentation]

For troubleshooting look into `/var/log/openqa-bootstrap.log`.
See https://open.qa/docs/#_openqa_in_a_browser[openQA in a browser] for
documentation on how to use it.

== Contributing
[id="getting_involved"]
Expand Down
35 changes: 35 additions & 0 deletions docs/Installing.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,41 @@ with optional, overridden parameters. More information about
`openqa-clone-job` can be found in
<<UsersGuide.asciidoc#_cloning_existing_jobs_openqa_clone_job,Cloning existing jobs - openqa-clone-job>>.

You can also run `openqa-bootstrap` repeatedly. For example when you stop a
container and the openQA daemons and database are stopped, calling
`openqa-bootstrap start` will start necessary daemons again.

=== openQA in a browser

You can try out `openqa-bootstrap` in a container environment environment like
https://docs.github.com/en/codespaces[GitHub Codespaces].

On https://github.com/os-autoinst/openQA[GitHub openQA], click on the "Code"
button and select "Codespaces". Just click on the plus sign to create a new
Codespace. Or use https://codespaces.new/os-autoinst/openQA?quickstart=1[this
link] as a quickstart to resume existing instances or create new ones.

It will run `openqa-bootstrap` in the background. If the codespace
environment is ready, open a new VSCode terminal and type

----
tail -f /var/log/openqa-bootstrap.log
----

The Web UI instance can be opened as soon as you get a popup that there is a
webserver available on port 80.

You can now use `openqa-clone-job` to run jobs in this instance.

After stopping and resuming a codespace instance, run
----
/usr/share/openqa/script/openqa-bootstrap start
----
to start the openQA daemons again.

Be sure to delete codespace instances if you don't use them anymore, as even
stopped instances will consume storage of your monthly limit.

=== openQA in a container

You can also setup a systemd-nspawn container with openQA with the following
Expand Down

0 comments on commit 57c005f

Please sign in to comment.