Skip to content

Commit

Permalink
Merge pull request #710 from imobachgs/docs-cleanup
Browse files Browse the repository at this point in the history
Remove references to the deprecated YaST:Head:Agama project
  • Loading branch information
imobachgs authored Aug 22, 2023
2 parents 9db052e + 59091ff commit 55a84ba
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 57 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci-integration-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ jobs:
run: mkdir -p /tmp/log/YaST2

- name: Start container
run: podman run --privileged --detach --name agama --ipc=host -e CI -e GITHUB_ACTIONS -v /dev:/dev -v .:/checkout -v /tmp/log/YaST2:/var/log/YaST2 registry.opensuse.org/yast/head/containers/containers_tumbleweed/opensuse/agama-testing:latest
run: podman run --privileged --detach --name agama --ipc=host -e CI -e GITHUB_ACTIONS -v /dev:/dev -v .:/checkout -v /tmp/log/YaST2:/var/log/YaST2 registry.opensuse.org/systemsmanagement/agama/staging/containers/opensuse/agama-testing:latest

- name: Environment
run: podman exec agama bash -c "env | sort"
Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,13 @@ The easiest way to give Agama a try is to grab a live ISO image and boot it in a
machine. This is also the recommended way if you only want to play and see it in action. If you want
to have a closer look, then clone and configure the project as explained in the next section.

* [multi-product](https://build.opensuse.org/package/binaries/YaST:Head:Agama/agama-live:default/images):
it can be used to install different products, like *openSUSE Tumbleweed*, *Leap*, *Leap Micro* or
an experimental version of the *SUSE ALP ContainerHost OS*.
* [ALP only](https://build.opensuse.org/package/binaries/YaST:Head:Agama/agama-live:ALP/images):
it only contains the definition for the experimental *SUSE ALP ContainerHost OS*, although
the rest of the content is pretty much the same than the multi-product version.
There are two flavors of live ISO images:

* openSUSE: it can be used to install different *openSUSE* distributions, like *Tumbleweed* or *Leap*.
* ALP: it allows to install the development version of *SUSE ALP Dolomite*.

You can download them from the [openSUSE Build
Service](https://download.opensuse.org/repositories/systemsmanagement:/Agama:/Devel/images/iso/).

### Manual Configuration

Expand All @@ -145,7 +146,7 @@ web/README.md#using-a-development-server).

Another alternative is to run source checkout inside container so system is not
affected by doing testing run beside real actions really done by installer.
See more details [in the documentation][doc/testing_using_container.md].
See more details [in the documentation](doc/testing_using_container.md).

* Start the services:
* beware that Agama must run as root (like YaST does) to do
Expand Down
20 changes: 0 additions & 20 deletions deploy.sh

This file was deleted.

6 changes: 3 additions & 3 deletions doc/testing_using_container.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
## Testing Using Container

To test complex change that affects multiple parts of agama it is possible to
To test complex change that affects multiple parts of Agama it is possible to
run from sources using container that is used to run CI.

Below is shell script that start container, provides web UI on port 9090 and
also gives root access to container for more testing.

```sh
# https://build.opensuse.org/package/show/YaST:Head:Containers/agama-testing
CIMAGE=registry.opensuse.org/yast/head/containers/containers_tumbleweed/opensuse/agama-testing:latest
# https://build.opensuse.org/package/show/systemsmanagement:Agama:Staging/agama-testing
CIMAGE=registry.opensuse.org/systemsmanagement/agama/staging/containers/opensuse/agama-testing:latest
# rename this if you test multiple things
CNAME=agama
# the '?' here will report a shell error
Expand Down
8 changes: 4 additions & 4 deletions playwright/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ npm install --no-save @playwright/test
This will install the NPM packages into the `node_modules` subdirectory.

Alternatively you can install it as an RPM package from the
[YaST:Head:Agama](https://build.opensuse.org/project/show/YaST:Head:Agama)
[systemsmanagement:Agama:Staging](https://build.opensuse.org/project/show/systemsmanagement:Agama:Staging)
OBS project.

## Files
Expand Down Expand Up @@ -57,8 +57,8 @@ See the `playwright.config.ts` file for the list of configured projects.

### Running Tests Directly from the Live ISO

You can download the `default-Playwright` image type from the [YaST:Head:Agama](
https://download.opensuse.org/repositories/YaST:/Head:/Agama/images/iso/) repository.
You can download the `default-Playwright` image type from the [systemsmanagement:Agama:Staging](
https://download.opensuse.org/repositories/systemsmanagement:/Agama:/Staging/images/iso/) repository.

This ISO additionally includes the Playwright tool, Chromium browser and the
Agama integration tests.
Expand Down Expand Up @@ -229,5 +229,5 @@ Additional help can be the `y2log` file in the artifacts (see above).

### Missing Package/Wrong Container

Packages lives in container at https://build.opensuse.org/package/show/YaST:Head:Containers/agama-testing .
Packages lives in container at https://build.opensuse.org/package/show/systemsmanagement:Agama:Staging/agama-testing.
Feel free to modify it as the only purpose of this container is CI testing.
17 changes: 2 additions & 15 deletions rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Agama D-Bus API is also a work in progress, but it is already used by Agama.

## Installation

You can grab the [RPM package](https://build.opensuse.org/package/show/YaST:Head:Agama/agama-cli) from
the [YaST:Head:Agama](https://build.opensuse.org/project/show/YaST:Head:Agama) project.
You can grab the [RPM package](https://build.opensuse.org/package/show/systemsmanagement:Agama:Devel/agama-cli) from
the [systemsmanagement:Agama:Devel](https://build.opensuse.org/project/show/systemsmanagement:Agama:Devel) project.

If you prefer, you can install it from sources with [Cargo](https://doc.rust-lang.org/cargo/):

Expand Down Expand Up @@ -112,17 +112,4 @@ frontend](./agama-cli/doc/backend-for-testing.md)*.

* If no product is selected, the `probe` command fails.

## Packaging

Packaging files live in the `package' directory. Agama follows the
[Rust packaging guidelines](https://en.opensuse.org/openSUSE:Packaging_Rust_Software).
To test changes to the spec file, use a simple `osc branch YaST:Head:Agama agama-cli`.
and copy the modified spec file to that branch.
If it also needs specific code from a git branch, then modify `_service' file and
put the git branch name in the `<revision>` tag. Then run `osc service runall`.

Note: for openSUSE Leap, `cargo_audit` [does not work][c_a_bug] with older Python, so comment out that
service section for the test build.
For the test build, use the usual `osc build' on modified sources.

[c_a_bug]: https://github.com/openSUSE/obs-service-cargo_audit/pull/6
12 changes: 5 additions & 7 deletions rust/agama-cli/doc/backend-for-testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,16 @@ My first plan had a different finale, 4. Make the D-Bus service visible
ouside the container, but I hit an issue with D-Bus authentication, hopefully
solvable. (Update: `xdg-dbus-proxy` seems to work, ask mvidner about it)

Josef wanted to test against a different container ([d-installer-backend][]) but that one was a
Josef wanted to test against a different container (`d-installer-backend`) but that one was a
bit old and the D-Bus API was mismatched between frontend and backend.

[d-installer-backend]: https://build.opensuse.org/package/show/YaST:Head:Containers/d-installer-backend

## Details

The container used is built in
[OBS YaST:Head:Containers/agama-testing][agama-testing] and
[OBS systemsmanagement:Agama:Staging/agama-testing][agama-testing] and
downloaded from registry.o.o specified below.

[agama-testing]: https://build.opensuse.org/package/show/YaST:Head:Containers/agama-testing
[agama-testing]: https://build.opensuse.org/package/show/systemsmanagement:Agama:Staging/agama-testing

I basically picked the useful bits from the `integration-tests` part
of [.github/workflows/ci.yml][ci.yml].
Expand All @@ -37,8 +35,8 @@ of [.github/workflows/ci.yml][ci.yml].


```sh
# https://build.opensuse.org/package/show/YaST:Head:Containers/agama-testing
CIMAGE=registry.opensuse.org/yast/head/containers/containers_tumbleweed/opensuse/agama-testing:latest
# https://build.opensuse.org/package/show/systemsmanagement:Agama:Staging/agama-testing
CIMAGE=registry.opensuse.org/systemsmanagement/agama/staging/containers/opensuse/agama-testing:latest
# rename this if you test multiple things
CNAME=agama
# the '?' here will report a shell error
Expand Down

0 comments on commit 55a84ba

Please sign in to comment.