feat(schema): basic storage settings #1455

joseivanlopez · 2024-07-11T16:01:48Z

Extend JSON schema to partially support the new storage config described in this document: https://github.com/openSUSE/agama/blob/master/doc/auto_storage.md.

This PR only extends the schema for the most basic settings (i.e., boot, drives and partitions). Settings for advanced searches, delete devices, creeate RAIDs, etc are not considered yet.

Notes:

The search section added in this PR is based on the following proposal: https://gist.github.com/joseivanlopez/4f2381eb1f6c3aca562aadc2ad920a72?permalink_comment_id=5121860#gistcomment-5121860. This will be revisited later.
The guided schema added by feat(schema): guided and AutoYaST storage proposals #1263 is not going to be offered (e.g., $ agama config load will not understand it). The storage config will cover all the use cases and features provided by the guided config.
The guided config will be used only by clients (e.g., web UI) to easily configure a subset of the use cases supported by the storage config.

rust/agama-lib/share/examples/storage-guided.json

jreidinger · 2024-07-16T16:04:25Z

rust/agama-lib/share/examples/storage-guided.json

+ "snapshots": true
+ }
+ },
+ "size": [1024, "5 Gib"],


can json have comments? This will really deserve comment what this array size means. Is 1024 minimal size or block lenght? Or something else. Examples should be crystal clear.

JSON does not allow comments. The schema defines what it means: [min, max].

@joseivanlopez true, but the schema also allows a {"min": min, "max": max } alternative. In light of @jreidinger 's comment, maybe we should remove the pair alternative, or discourage it.
https://github.com/openSUSE/agama/pull/1455/files#diff-e7dcc0a7344de41b0cc7ca87ba9624848c4160406f9d618a2ae025751f6c7bf7R601-R627

doc/auto_storage.md

mvidner · 2024-08-02T09:40:49Z

rust/agama-lib/share/examples/storage-guided.json

+ "filesystem": "xfs",
+ "size": {
+ "min": "5 GiB",
+ "max": "20 GiB"


... which is illustrated here

rust/agama-lib/share/profile.schema.json

coveralls · 2024-08-19T15:24:49Z

coverage: 71.557%. remained the same
when pulling 9ddaa37 on joseivanlopez:storage-schema-basic
into 46f89e2 on openSUSE:master.

- Adapt to new agreed format.

rust/agama-lib/share/profile.schema.json

ancorgs

LGTM

A JSON schema for the storage config is defined by #1455. This PR adds support to the D-Bus API to allow setting a JSON config following that new JSON schema: ~~~ org.opensuse.Agama.Storage1 #SetConfig s #GetConfig s ~~~ ## `#SetConfig` For now, the `#SetConfig` D-Bus method admits 3 different JSON formats for the given JSON config: * Guided config ~~~ { "storage": { "guided": ... } } ~~~ * New storage config ~~~ { "storage": { ... } } ~~~ * Legacy AutoYaST config ~~~ { "legacyAutoyastStorage": [ ... ] } ~~~ The plan is to make `#SetConfig` and `#GetConfig` only to work with a *storage config* or a *legacy AutoYaST config*. The *guided config* is still accepted by `#SetConfig` because the new *storage config* does not offer all the options offered by *guided config* yet. In the future, the *guided config* will be neither accepted nor reported by `#SetConfig` and `#GetConfig` respectively. Nevertheless, a D-Bus method accepting the *guided config* will still be offered as a simplification of the *storage settings* to make easier to work with the use cases supported by the web UI. ## `#GetConfig` Currently, `#GetConfig` reports different config formats depending on how the proposal was calculated: * For the initial proposal: reports the *guided config*. * If `#SetConfig` was called with *guided config*: reports *guided config* (extended with mandatory volumes, etc). * If `#SetConfig` was called with *storage config*: reports exactly the given *storage config*. * If `#SetConfig` was called with *legacy AutoYaST config*: reports exactly the given *legacy AutoYaST config*. * If `Storage1.Proposal#Calculate` was called: reports the *guided config* (extended with mandatory volumes, etc). In the future, `#GetConfig` will only report either the *storage config* or the *legacy AutoYaST config*.

Prepare for releasing Agama 10· * #1263 * #1330 * #1407 * #1408 * #1410 * #1411 * #1412 * #1416 * #1417 * #1419 * #1420 * #1421 * #1422 * #1423 * #1424 * #1425 * #1428 * #1429 * #1430 * #1431 * #1432 * #1433 * #1436 * #1437 * #1438 * #1439 * #1440 * #1441 * #1443 * #1444 * #1445 * #1449 * #1450 * #1451 * #1452 * #1453 * #1454 * #1455 * #1456 * #1457 * #1459 * #1460 * #1462 * #1464 * #1465 * #1466 * #1467 * #1468 * #1469 * #1470 * #1471 * #1472 * #1473 * #1475 * #1476 * #1477 * #1478 * #1479 * #1480 * #1481 * #1482 * #1483 * #1484 * #1485 * #1486 * #1487 * #1488 * #1489 * #1491 * #1492 * #1493 * #1494 * #1496 * #1497 * #1498 * #1499 * #1500 * #1501 * #1502 * #1503 * #1504 * #1505 * #1506 * #1507 * #1508 * #1510 * #1511 * #1512 * #1513 * #1514 * #1515 * #1516 * #1517 * #1518 * #1519 * #1520 * #1522 * #1523 * #1524 * #1525 * #1526 * #1527 * #1528 * #1529 * #1530 * #1531 * #1532 * #1533 * #1534 * #1535 * #1536 * #1537 * #1540 * #1541 * #1543 * #1544 * #1545 * #1546 * #1547 * #1548 * #1549 * #1550 * #1552 * #1553 * #1554 * #1555 * #1556 * #1557 * #1558 * #1559 * #1560 * #1562 * #1563 * #1565 * #1566 * #1567 * #1568 * #1569 * #1570 * #1571 * #1572 * #1573 * #1574 * #1575 * #1576 * #1577 * #1578 * #1579 * #1580 * #1581 * #1583 * #1584 * #1585 * #1586 * #1587 * #1588 * #1589 * #1590 * #1591 * #1592 * #1593 * #1596 * #1597 * #1598 * #1600 * #1602 * #1605 * #1606 * #1607 * #1608 * #1610 * #1611 * #1612 * #1613 * #1614 * #1619 * #1620 * #1621

joseivanlopez force-pushed the storage-schema-basic branch 2 times, most recently from 57e5499 to ef24d7f Compare July 16, 2024 13:31

joseivanlopez marked this pull request as ready for review July 16, 2024 13:53

jreidinger reviewed Jul 16, 2024

View reviewed changes

rust/agama-lib/share/examples/storage-guided.json Show resolved Hide resolved

jreidinger reviewed Jul 16, 2024

View reviewed changes

joseivanlopez mentioned this pull request Jul 17, 2024

feat(storage): API support for storage settings #1471

Merged

This comment was marked as resolved.

Sign in to view

ancorgs reviewed Jul 25, 2024

View reviewed changes

doc/auto_storage.md Outdated Show resolved Hide resolved

joseivanlopez commented Jul 25, 2024

View reviewed changes

doc/auto_storage.md Outdated Show resolved Hide resolved

mvidner reviewed Aug 2, 2024

View reviewed changes

ancorgs reviewed Aug 7, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Outdated Show resolved Hide resolved

ancorgs reviewed Aug 7, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Outdated Show resolved Hide resolved

ancorgs reviewed Aug 7, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Outdated Show resolved Hide resolved

joseivanlopez force-pushed the storage-schema-basic branch from 2655680 to c027e96 Compare August 19, 2024 15:13

joseivanlopez force-pushed the storage-schema-basic branch from 0f23dd2 to 505dfdd Compare August 20, 2024 08:30

ancorgs mentioned this pull request Aug 22, 2024

Document the approach for resizing and deleting devices joseivanlopez/agama#1

Merged

joseivanlopez and others added 13 commits August 27, 2024 14:21

schema: extend with basic storage settings

eb89811

schema: add/update examples

2607aaa

rust: changelog

cc36264

schema: add missing size

47d9350

JSON Schema: remove partition type

d3da3aa

Doc: update information on the settings for storage

e754dbb

schema: declarative version

2b4665b

- Adapt to new agreed format.

schema: allow all possible encryption methods

f5b9f92

schema: update examples

d437c38

schema: restore btrfs schema

a9819bc

schema: improve titles and descriptions

24c0adf

doc: update auto storage

0c4f1f3

Document the approach for resizing and deleting devices

9ec7394

schema: add mountBy

5246166

joseivanlopez force-pushed the storage-schema-basic branch from b6618b2 to 5246166 Compare August 27, 2024 13:23

ancorgs reviewed Aug 27, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Show resolved Hide resolved

ancorgs reviewed Aug 27, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Outdated Show resolved Hide resolved

ancorgs reviewed Aug 27, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Outdated Show resolved Hide resolved

ancorgs reviewed Aug 27, 2024

View reviewed changes

rust/agama-lib/share/profile.schema.json Outdated Show resolved Hide resolved

schema: several fixes from review

9ddaa37

ancorgs approved these changes Aug 27, 2024

View reviewed changes

joseivanlopez merged commit 10093da into agama-project:master Aug 27, 2024
1 check passed

imobachgs mentioned this pull request Sep 20, 2024

Update to release 10 #1622

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(schema): basic storage settings #1455

feat(schema): basic storage settings #1455

joseivanlopez commented Jul 11, 2024 •

edited

Loading

jreidinger Jul 16, 2024

joseivanlopez Jul 17, 2024 •

edited

Loading

mvidner Aug 2, 2024

This comment was marked as resolved.

mvidner Aug 2, 2024

coveralls commented Aug 19, 2024 •

edited

Loading

ancorgs left a comment

feat(schema): basic storage settings #1455

feat(schema): basic storage settings #1455

Conversation

joseivanlopez commented Jul 11, 2024 • edited Loading

jreidinger Jul 16, 2024

Choose a reason for hiding this comment

joseivanlopez Jul 17, 2024 • edited Loading

Choose a reason for hiding this comment

mvidner Aug 2, 2024

Choose a reason for hiding this comment

This comment was marked as resolved.

mvidner Aug 2, 2024

Choose a reason for hiding this comment

coveralls commented Aug 19, 2024 • edited Loading

ancorgs left a comment

Choose a reason for hiding this comment

joseivanlopez commented Jul 11, 2024 •

edited

Loading

joseivanlopez Jul 17, 2024 •

edited

Loading

coveralls commented Aug 19, 2024 •

edited

Loading