Remove visible todos from lsm doc #7201

FloLey · 2024-02-15T16:14:50Z

Description

add docs/ remove todos
follow-up ticket:

closes #7134

Self Check:

Strike through any lines that are not applicable (~~line~~) then check the box

Attached issue to pull request
Changelog entry
Type annotations are present
Code is clear and sufficiently documented
No (preventable) type errors (check using make mypy or make mypy-diff)
Sufficient test cases (reproduces the bug/tests the requested feature)
Correct, in line with design
End user documentation is included or an issue is created for end-user documentation (add ref to issue here: )
If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see test-fixes for more info)

arnaudsjs

I see there are still some TODO's left in the following places:
- https://docs.inmanta.com/inmanta-service-orchestrator/7/reference/modules/std.html#std.resources.DirectoryHandler
- https://docs.inmanta.com/inmanta-service-orchestrator/7/reference/modules/apt.html#apt.AptPackage
Regarding the follow up ticket: We should make sure to include a reference in that ticket to this PR. That way it's easier to determine what the different bullets in the ticket mean.

arnaudsjs · 2024-02-16T07:24:34Z

docs/lsm/allocation/allocation.rst

@@ -10,8 +10,6 @@ In the network, this virtual wire is implemented as a VXlan tunnel, tied to both
 Each such tunnel requires a "VXLAN Network Identifier (VNI)" that uniquely identifies the tunnel.
 In the allocation phase, the orchestrator selects a VNI and ensures no other customer is assigned the same VNI.

-.. todo: add picture of service


This TODO is not mentioned in the follow-up ticket that was created.

docs/lsm/index.rst

arnaudsjs · 2024-02-16T07:55:39Z

docs/lsm/index.rst

-    TODO: Three set of attributes
+    Each service instance defines 3 sets of its attributes that are used in different situations:
+
+    - ``candidate_attributes``: The set of attributes used when the service instance model state is candidate or designed.


I don't think we should explain this in term of the model state. The model state is a purely internal state of the orchestrator. You cannot see this state on the web-console for example. I think we should explain this more from the end-user perspective. This attribute set is mainly used to validate a change before activating (deploying) it.

arnaudsjs · 2024-02-16T08:07:16Z

docs/lsm/index.rst

+    Each service instance defines 3 sets of its attributes that are used in different situations:
+
+    - ``candidate_attributes``: The set of attributes used when the service instance model state is candidate or designed.
+    - ``active_attributes``: The set of attributes when the model is evaluated with only active instances.


This is not True. These attributes are also used when a validation compile is done for another service instance for example.

arnaudsjs · 2024-02-16T08:08:03Z

docs/lsm/index.rst

+    - ``rollback_attributes``: The set of attributes that can be used to rollback active attributes that result in an error
+                                state.
+


Suggested change

- ``rollback_attributes``: The set of attributes that can be used to rollback active attributes that result in an error

state.

- ``rollback_attributes``: The set of attributes that can be used to rollback active attributes that result in an error state.

arnaudsjs · 2024-02-16T08:37:26Z

docs/lsm/index.rst

+        entity InterfaceIPAssignment extends lsm::ServiceEntity:
+            """
+                Interface details.

-    Updating service entities
-    =========================
+                :attr router_ip: The IP address of the SR linux router that should be configured.
+                :attr router_name: The name of the SR linux router that should be configured.
+                :attr interface_name: The name of the interface of the router that should be configured.
+                :attr address: The IP-address to assign to the given interface.
+            """
+
+            std::ipv_any_address router_ip
+            string router_name
+            string interface_name
+
+            std::ipv_any_interface address
+            lsm::attribute_modifier address__modifier="rw+"
+        end
+
+        implement InterfaceIPAssignment using parents


When we include a model in the docs, we usually add the model to a separate file. Then we can use that file to add a test case that verifies whether the model actually compiles and we can use the same file to include the model (or part of it) in the docs. We should do the same here. Otherwise the code included in the docs might no longer compile due to future changes to the lsm module or compiler.

Co-authored-by: arnaudsjs <2684622+arnaudsjs@users.noreply.github.com>

…a-core into issue/7134-lsm-docs-todos

inmantaci · 2024-02-19T15:36:07Z

Processing this pull request

# Description add docs/ remove todos follow-up ticket: 1. https://app.zenhub.com/workspaces/core-5a7c152b04a1652024289b7b/issues/gh/inmanta/inmanta-core/7202 2. https://app.zenhub.com/workspaces/core-5a7c152b04a1652024289b7b/issues/gh/inmanta/std/504 3. https://app.zenhub.com/workspaces/core-5a7c152b04a1652024289b7b/issues/gh/inmanta/apt/281 closes #7134 # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [x] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [x] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)

inmantaci · 2024-02-19T15:36:17Z

Merged into branches master in 8e189d3

# Description add docs/ remove todos follow-up ticket: 1. https://app.zenhub.com/workspaces/core-5a7c152b04a1652024289b7b/issues/gh/inmanta/inmanta-core/7202 2. https://app.zenhub.com/workspaces/core-5a7c152b04a1652024289b7b/issues/gh/inmanta/std/504 3. https://app.zenhub.com/workspaces/core-5a7c152b04a1652024289b7b/issues/gh/inmanta/apt/281 closes #7134 # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [x] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [x] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) - [ ] If this PR fixes a race condition in the test suite, also push the fix to the relevant stable branche(s) (see [test-fixes](https://internal.inmanta.com/development/core/tasks/build-master.html#test-fixes) for more info)

inmantaci · 2024-02-19T15:57:06Z

Processing #7219.

Pull request opened by the merge tool on behalf of #7201

inmantaci · 2024-02-19T15:58:06Z

Processing #7218.

Pull request opened by the merge tool on behalf of #7201

FloLey added 3 commits February 15, 2024 09:57

update

84de1ac

update

a134fbb

update

521759b

FloLey changed the title ~~update~~ Remove visible todos from lsm doc. Feb 15, 2024

FloLey changed the title ~~Remove visible todos from lsm doc.~~ Remove visible todos from lsm doc Feb 15, 2024

FloLey requested a review from arnaudsjs February 15, 2024 16:29

FloLey added 3 commits February 15, 2024 17:30

update

fffbe41

update

ae846a2

Merge branch 'master' into issue/7134-lsm-docs-todos

937b5df

arnaudsjs requested changes Feb 16, 2024

View reviewed changes

Update docs/lsm/index.rst

a4d8414

Co-authored-by: arnaudsjs <2684622+arnaudsjs@users.noreply.github.com>

FloLey mentioned this pull request Feb 19, 2024

handle commented todos in lsm docs #7202

Open

FloLey added 7 commits February 19, 2024 09:33

Merge branch 'issue/7134-lsm-docs-todos' of github.com:inmanta/inmant…

053882f

…a-core into issue/7134-lsm-docs-todos

update

2ac6e33

Merge branch 'master' into issue/7134-lsm-docs-todos

0d0d482

Merge branch 'master' into issue/7134-lsm-docs-todos

0ccf879

update

b0406ff

update

4835d20

update

bb72db5

FloLey requested a review from arnaudsjs February 19, 2024 14:09

arnaudsjs approved these changes Feb 19, 2024

View reviewed changes

FloLey added the merge-tool-ready This ticket is ready to be merged in label Feb 19, 2024

inmantaci mentioned this pull request Feb 19, 2024

Remove visible todos from lsm doc (#7201) #7218

Closed

inmantaci mentioned this pull request Feb 19, 2024

Remove visible todos from lsm doc (#7201) #7219

Closed

inmantaci closed this Feb 19, 2024

inmantaci deleted the issue/7134-lsm-docs-todos branch February 19, 2024 15:36

inmantaci pushed a commit that referenced this pull request Feb 19, 2024

Remove the visible todos from the lsm docs. (PR #7201)

9561354

Pull request opened by the merge tool on behalf of #7201

inmantaci pushed a commit that referenced this pull request Feb 19, 2024

Remove the visible todos from the lsm docs. (PR #7201)

3d03715

Pull request opened by the merge tool on behalf of #7201

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove visible todos from lsm doc #7201

Remove visible todos from lsm doc #7201

FloLey commented Feb 15, 2024 •

edited

Loading

arnaudsjs left a comment

arnaudsjs Feb 16, 2024

arnaudsjs Feb 16, 2024

arnaudsjs Feb 16, 2024

arnaudsjs Feb 16, 2024

arnaudsjs Feb 16, 2024

inmantaci commented Feb 19, 2024

inmantaci commented Feb 19, 2024

inmantaci commented Feb 19, 2024

inmantaci commented Feb 19, 2024

		- ``rollback_attributes``: The set of attributes that can be used to rollback active attributes that result in an error
		state.

Remove visible todos from lsm doc #7201

Remove visible todos from lsm doc #7201

Conversation

FloLey commented Feb 15, 2024 • edited Loading

Description

Self Check:

arnaudsjs left a comment

Choose a reason for hiding this comment

arnaudsjs Feb 16, 2024

Choose a reason for hiding this comment

arnaudsjs Feb 16, 2024

Choose a reason for hiding this comment

arnaudsjs Feb 16, 2024

Choose a reason for hiding this comment

arnaudsjs Feb 16, 2024

Choose a reason for hiding this comment

arnaudsjs Feb 16, 2024

Choose a reason for hiding this comment

inmantaci commented Feb 19, 2024

inmantaci commented Feb 19, 2024

inmantaci commented Feb 19, 2024

inmantaci commented Feb 19, 2024

FloLey commented Feb 15, 2024 •

edited

Loading