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.

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

Add --description flag to create type CLI commands #1498

Merged
merged 3 commits into from
Dec 17, 2024

Conversation

luissimas
Copy link
Contributor

Adds a --description CLI flag to the following commands:

  • config trust add-certificate
  • cluster group create
  • create
  • image alias create
  • launch
  • network create
  • network acl create
  • network acl rule add
  • network forward create
  • network forward port add
  • network load-balancer create
  • network load-balancer backend add
  • network load-balancer port add
  • network peer create
  • network zone create
  • network zone record add
  • profile create
  • project create
  • storage create
  • storage bucket create
  • storage bucket key create
  • storage volume create
  • storage volume snapshot create
  • snapshot create

The flag allow users to set a description on the resources when they create them, instead of having to update the description after the creation.

For the snapshot create and storage volume snapshot create commands, some changes were made to the API and the incusd daemon, since the description field was not supported on the server side. Additionally, the new description field is shown in the output of incus storage volume snapshot list, incus snapshot list and incus info.

Closes #1485

@luissimas luissimas requested a review from stgraber as a code owner December 12, 2024 11:14
@github-actions github-actions bot added the API Changes to the REST API label Dec 12, 2024
@luissimas luissimas marked this pull request as draft December 12, 2024 11:17
@luissimas
Copy link
Contributor Author

@stgraber opening as a draft because I still want to add some test cases for the commands. Is the test/suites/*.sh the intended place for such tests?

I did some manual tests to validate most of the changes, but I was a bit limited by my local setup to test the network commands. Also, I'm not sure about the changes for snapshots, specially the default description values for the scheduled/automatic snapshots.

@luissimas luissimas changed the title Description flag Add --description flag to create type CLI commands Dec 12, 2024
@stgraber
Copy link
Member

@stgraber opening as a draft because I still want to add some test cases for the commands. Is the test/suites/*.sh the intended place for such tests?

Yeah, you can have a few of the commands in there start passing --description for testing.

@luissimas luissimas marked this pull request as ready for review December 13, 2024 10:46
@stgraber
Copy link
Member

Looks good overall. I'll have to take a closer look at the snapshot description stuff as I now have a nagging feeling that we have those fields read-only as we want the snapshot to capture and restore the instance or volume's own description.

If that's indeed the case, we'll then want to just remove the ability to set a description on snapshots at creation time which will also make this PR a bit simpler.

@github-actions github-actions bot removed the API Changes to the REST API label Dec 17, 2024
@stgraber stgraber enabled auto-merge December 17, 2024 05:13
@stgraber stgraber force-pushed the description-flag branch 3 times, most recently from 541f9f5 to b89d02e Compare December 17, 2024 06:20
luissimas and others added 3 commits December 17, 2024 02:23
Adds a --description flag to various commands that create resources.

Signed-off-by: Luís Simas <luissimas@protonmail.com>
Signed-off-by: Stéphane Graber <stgraber@stgraber.org>
Signed-off-by: Luís Simas <luissimas@protonmail.com>
@stgraber stgraber merged commit d9bab5b into lxc:main Dec 17, 2024
30 checks passed
tmeijn pushed a commit to tmeijn/dotfiles that referenced this pull request Jan 28, 2025
This MR contains the following updates:

| Package | Update | Change |
|---|---|---|
| [lxc/incus](https://github.com/lxc/incus) | minor | `v6.8.0` -> `v6.9.0` |

MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot).

**Proposed changes to behavior should be submitted there as MRs.**

---

### Release Notes

<details>
<summary>lxc/incus (lxc/incus)</summary>

### [`v6.9.0`](https://github.com/lxc/incus/releases/tag/v6.9.0): Incus 6.9

[Compare Source](lxc/incus@v6.8.0...v6.9.0)

#### What's Changed

-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1506
-   Refactor scriptlet loader and improve checks by [@&#8203;bensmrs](https://github.com/bensmrs) in lxc/incus#1507
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1511
-   incusd/storage/drivers: Force blkdiscard and ignore errors by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1513
-   incusd/auth: fix FGA online data race by [@&#8203;breml](https://github.com/breml) in lxc/incus#1515
-   incusd/storage/drivers: Log on blkdiscard failure by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1517
-   Fix issue with live-migration between storage pools by [@&#8203;presztak](https://github.com/presztak) in lxc/incus#1518
-   Add uplink addresses for OVN network by [@&#8203;winiciusallan](https://github.com/winiciusallan) in lxc/incus#1512
-   Add `--description` flag to create type CLI commands by [@&#8203;luissimas](https://github.com/luissimas) in lxc/incus#1498
-   client: Propagate HTTP TLS dialer to websocket by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1519
-   Fix QEMU scriptlet parameter name by [@&#8203;bensmrs](https://github.com/bensmrs) in lxc/incus#1524
-   Add shell.nix by [@&#8203;MadnessASAP](https://github.com/MadnessASAP) in lxc/incus#1526
-   client: add proxy host to skopoe inspect by [@&#8203;winiciusallan](https://github.com/winiciusallan) in lxc/incus#1525
-   incusd/cluster: Add missing error handling by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1528
-   incusd/instance/qemu: Fix QMP arguments typing by [@&#8203;bensmrs](https://github.com/bensmrs) in lxc/incus#1531
-   Encode mc alias for storage buckets to match allowed characters by [@&#8203;monkz](https://github.com/monkz) in lxc/incus#1535
-   doc: Contributing section restructuring by [@&#8203;bensmrs](https://github.com/bensmrs) in lxc/incus#1534
-   internal/server: allow creation of OVN network with no uplink by [@&#8203;winiciusallan](https://github.com/winiciusallan) in lxc/incus#1533
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1540
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1541
-   lxd-to-incus: Clear volatile.uuid from instances by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1546
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1548
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1550
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1551
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1553
-   Tweak Github Actions and add arm64 tests by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1555
-   Translations update from Hosted Weblate by [@&#8203;weblate](https://github.com/weblate) in lxc/incus#1556
-   incusd/networks: Tweak dnsmasq startup condition by [@&#8203;alex14641](https://github.com/alex14641) in lxc/incus#1544
-   Tweak namespace attach logic in forkproxy and forkfile by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1557
-   Expand block reset logic by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1560
-   Discard blocks on LVM resize by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1561
-   incusd/storage/lvm: Run ClearBlock on all new thick block volumes by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1565
-   Improve format flag by [@&#8203;breml](https://github.com/breml) in lxc/incus#1564
-   devcontainer: initial version by [@&#8203;breml](https://github.com/breml) in lxc/incus#1566
-   incusd/network/ovn: Skip remote peers when iterating peer networks by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1568
-   Fix discard logic on LVM resize and optimize image unpacking by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1569
-   incusd/main_cluster: Tweak to have help refer to correct command name by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1576
-   Docs: Fixed link to point to correct manpage. by [@&#8203;foxtrotcz](https://github.com/foxtrotcz) in lxc/incus#1581
-   incusd/device/disk: Better handle partitions by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1578
-   incusd/storage/drivers: Handle 4k sector sizes by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1585
-   lxd-to-incus: Be more lenient on database changes by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1582
-   incusd/dnsmasq: Don't put the project name in the DNS record by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1586
-   Remove virtfs-proxy-helper dependency by [@&#8203;bensmrs](https://github.com/bensmrs) in lxc/incus#1547
-   Add new `config` hook by [@&#8203;bensmrs](https://github.com/bensmrs) in lxc/incus#1577
-   github: Switch to Github's hosted arm64 runners by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1589
-   Support for ACLs for bridge NIC device when using nftables driver by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1587
-   doc: typo by [@&#8203;eebssk1](https://github.com/eebssk1) in lxc/incus#1591
-   Added unit for minimum ZFS blocksize by [@&#8203;Spitfireap](https://github.com/Spitfireap) in lxc/incus#1593
-   incus/file/pull: Port to SFTP by [@&#8203;HassanAlsamahi](https://github.com/HassanAlsamahi) in lxc/incus#1592
-   incusd/device/disk: Update correct mount options by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1594
-   doc: Force white background for swagger API by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1599
-   Implement a VM memory dump API by [@&#8203;SpiffyEight77](https://github.com/SpiffyEight77) in lxc/incus#1596
-   gomod: Update dependencies by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1600
-   incus/init: Add support for storage volumes in preseed init by [@&#8203;megheaiulian](https://github.com/megheaiulian) in lxc/incus#1595
-   incusd/instance/qemu: Fix device_id warning on 9.2.x by [@&#8203;stgraber](https://github.com/stgraber) in lxc/incus#1601
-   incus: Fix example description for debug dump-memory command by [@&#8203;SpiffyEight77](https://github.com/SpiffyEight77) in lxc/incus#1602

#### New Contributors

-   [@&#8203;winiciusallan](https://github.com/winiciusallan) made their first contribution in lxc/incus#1512
-   [@&#8203;luissimas](https://github.com/luissimas) made their first contribution in lxc/incus#1498
-   [@&#8203;MadnessASAP](https://github.com/MadnessASAP) made their first contribution in lxc/incus#1526
-   [@&#8203;monkz](https://github.com/monkz) made their first contribution in lxc/incus#1535
-   [@&#8203;alex14641](https://github.com/alex14641) made their first contribution in lxc/incus#1544
-   [@&#8203;foxtrotcz](https://github.com/foxtrotcz) made their first contribution in lxc/incus#1581
-   [@&#8203;eebssk1](https://github.com/eebssk1) made their first contribution in lxc/incus#1591
-   [@&#8203;Spitfireap](https://github.com/Spitfireap) made their first contribution in lxc/incus#1593
-   [@&#8203;megheaiulian](https://github.com/megheaiulian) made their first contribution in lxc/incus#1595

**Full Changelog**: lxc/incus@v6.8.0...v6.9.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied.

♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this MR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzOS4xMzcuMiIsInVwZGF0ZWRJblZlciI6IjM5LjEzNy4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJSZW5vdmF0ZSBCb3QiXX0=-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

Add --description flag to create type CLI commands
2 participants