[UI, websocket] Include the machine note in the WS

[Anthony Dillon]

The design team would like to display and edit the note data on the machine object. We will need that to be passed through the web socket to the UI and added to the edit machine endpoint.

[Blake Rouse (blake-rouse)]

Been looking into this at the moment we do not have a note field on the Node object. That is very easy to add, but I am trying to determine what is the lifecycle of the note.

At the moment I see 3 possible note types on a node.

1. A global public note (only editable by the administrator, never goes away, viewable by all users).
2. A global private note (only editable by the administrator, never goes away, viewable only to other adminstrators).
3. A user note (editable by the owner, goes away on release, viewable by the owner or administrator.)

What level is needed for this work in the UI?

[Andres Rodriguez (andreserl)]

Hi Blake,

It is true we don't have a note, but we do have this:

    :ivar error_description: A human-readable description of why a node is
        marked broken. Only meaningful when the node is in the state
'BROKEN'.

The error_description was only used when setting machines to broken, but
the machine note serves the same purpose because it was just meant to be a
general comment. I wonder if we should just re-use that.

On Tue, Feb 26, 2019 at 11:00 PM Blake Rouse <email address hidden>
wrote:

> Been looking into this at the moment we do not have a note field on the
> Node object. That is very easy to add, but I am trying to determine what
> is the lifecycle of the note.
>
> At the moment I see 3 possible note types on a node.
>
> 1. A global public note (only editable by the administrator, never goes
> away, viewable by all users).
> 2. A global private note (only editable by the administrator, never goes
> away, viewable only to other adminstrators).
> 3. A user note (editable by the owner, goes away on release, viewable by
> the owner or administrator.)
>
> What level is needed for this work in the UI?
>
> --
> You received this bug notification because you are subscribed to MAAS.
> https://bugs.launchpad.net/bugs/1812355
>
> Title:
> [UI, websocket] Include the machine note in the WS
>
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/maas/+bug/1812355/+subscriptions
>
> Launchpad-Notification-Type: bug
> Launchpad-Bug: product=maas; milestone=2.6.0; status=Triaged;
> importance=High; <email address hidden>;
> Launchpad-Bug-Tags: ui-backend
> Launchpad-Bug-Information-Type: Public
> Launchpad-Bug-Private: no
> Launchpad-Bug-Security-Vulnerability: no
> Launchpad-Bug-Commenters: blake-rouse ya-bo-ng
> Launchpad-Bug-Reporter: Anthony Dillon (ya-bo-ng)
> Launchpad-Bug-Modifier: Blake Rouse (blake-rouse)
> Launchpad-Message-Rationale: Subscriber (MAAS)
> Launchpad-Message-For: andreserl
>

--
Andres Rodriguez (RoAkSoAx)
Ubuntu Server Developer
MSc. Telecom & Networking
Systems Engineer

[Blake Rouse (blake-rouse)]

Yes we do have that field, but it has a completely different meaning and not what is being asked to implement.

[Martin Storey (cassiocassio)]

The note item was inspired by seeing the mixture of excel spreadsheets, inventory systems, yellow stickies and masking tape that was written on with sharpies in data-centres.

There are lots of interesting wrinkles and edge cases, but I propose we keep it simple to start with, and then iterate later.

1. Anyone can create a note
2. Any user can edit or delete a note.
3. Notes persist through the entire lifecycle.
4. Notes don't affect the behaviour of MAAS. They are for reading by humans. Tags serve this purpose.
5. Notes will be read-writable through the API too - hopefully some user will do some interesting integration.
6. We shuold set a sane maximum length for notes - and truncate (...) in the browser at narrow widths
7. Notes should allow emoji, but not style or links

=== possibilities for later>>>

a. notes could be readable by users, and writeable by admins. (you can deploy a new OS but not change the note?)
b. notes could be cleared on (re)comissioning, or on being released to the pool (so a note about a problematic cable you want to fix would be lost?)

[Martin Storey (cassiocassio)]

I forgot the first point:

0. All users can see all notes