plugins/modules/snap: improve documentation #8972

locnnil · 2024-10-03T02:23:37Z

SUMMARY

Improve snap module documentation.

ISSUE TYPE

Docs Pull Request

COMPONENT NAME

module: community.general.snap

Signed-off-by: Lincoln Wallace <[email protected]>

ansibullbot · 2024-10-03T02:25:30Z

cc @angristan @vcarceler
click here for bot help

farshidtz

Thanks, please see my inline comment.
Also please keep in mind that this is the documentation of the Ansible module and not a snap documentation. I'd keep the original tone which starts by explaining the action, e.g. "Set [snap] options with pattern ..." instead of "Snap options are a way to do ...".

plugins/modules/snap.py

farshidtz · 2024-10-03T08:27:57Z

plugins/modules/snap.py

+            - Snap options are a way to configure snaps by using the C(key=value) syntax or C(snap:key=value).
+              If a snap name is given, the option will be applied to that snap only.
+              If the snap name is omitted, the options will be applied to all snaps listed in O(name).
+              Options will only be applied to active snaps.
+              Since snap applications run in a sandboxed environment, this is the method used to
+              pass information to snapped applications regarding the desired configurations.
+              These configurations can be applied either at the startup of the application, within the snap (via a configure hook)
+              or during its execution if the application is designed to communicate with the snap API at runtime.
+            - See U(https://snapcraft.io/docs/configuration-in-snaps) for more details about snap options and how to configure snaps.
+            - See U(https://snapcraft.io/docs/supported-snap-hooks) for more details about configure hooks.


Most added explanations are useful for snap developers rather than snap users. I'd keep https://snapcraft.io/docs/configuration-in-snaps as a doc reference for configuring snaps but drop everything else.

What is missing is an explanation of when the options are set. Is that after installation? In that case, snaps that have an enabled service which starts after installation may not receive the configuration until a restart. Some snap do restart their services once configuration is applied, but that is rare. Some other snaps may continue restarting until the expected config is set.

What does "Options will only be applied to active snaps." mean?

I second that.

What is missing is an explanation of when the options are set. Is that after installation?

Is there a situation where it's possible to set snap options before installing the snap, other than through the install hook (which in this case is irrelevant)? If I try, I get an error: snap "<snap-name>" not found.

The install hook is irrelevant in this scenario because it's defined within the snap and doesn't depend on the user.

But anyway, the options are indeed set after the installation, as shown in the source code.

What does "Options will only be applied to active snaps." mean?

Looking at the source code, it seems that the intention of this is to say that these options will only be applied to snaps in which the state field is present.

Please see my suggestion here: #8972 (comment)

farshidtz · 2024-10-03T08:38:16Z

plugins/modules/snap.py

+            - Confinement policy: This level of confinement is permissive, granting full system access,
+              similar to that of traditionally packaged applications, such as Debian packages (those managed via the C(apt) command-line tool).
+              This option corresponds to the C(--classic) argument of the C(snap install) command.
+              It can only be specified when the task involves a single snap.


The explanation sounds like this option allows changing of the confinement. The flag is actually used to install snaps that use the classic confinement.

Suggested change

- Confinement policy: This level of confinement is permissive, granting full system access,

similar to that of traditionally packaged applications, such as Debian packages (those managed via the C(apt) command-line tool).

This option corresponds to the C(--classic) argument of the C(snap install) command.

It can only be specified when the task involves a single snap.

- Install a snap that has classic confinement.

- This level of confinement is permissive, granting full system access,

similar to that of traditionally packaged applications, such as Debian packages (those managed via the C(apt) command-line tool).

This option corresponds to the C(--classic) argument of the C(snap install) command.

- This option can only be specified when the task involves a single snap.

I would prefer us not to mention a specific OS as example. snap can be used in RHEL, OpenSUSE and other distros as well. I think it is better to keep the wording neutral.

This explanation essentially mirrors the wording used in the snapcraft.io documentation: https://snapcraft.io/docs/classic-confinement.
I just wanted to clarify what it means to install using classic confinement, but I will expand on it by mentioning that this option installs a snap with classic confinement AND leave the sentence explaining what this entails.

@russoz, I will revise the wording to "traditionally packaged applications that don't use sandboxing mechanisms" and remove the part about Debian packages. Would that work for you?

This explanation essentially mirrors the wording used in the snapcraft.io documentation: snapcraft.io/docs/classic-confinement. I just wanted to clarify what it means to install using classic confinement, but I will expand on it by mentioning that this option installs a snap with classic confinement AND leave the sentence explaining what this entails.

hi @locnnil , while I appreciate your intention, I think we must be aware that the purpose of this documentation is NOT to explain how snap-command works, but rather how to use the snap-ansible-module. Someone who does not know how to use snap is unlikely going to use this documentation to learn it. So, it is more than OK to add references and links to more documentation about the snap command, but too much info here might not make things better.

(Just occurred me a couple of minutes later: Copying the text adds an implicit task to us maintainers to check the source doc for updates and keeping the module docs synchronized. It's so much easier to just tell the user: read it over there!)

@russoz, I will revise the wording to "traditionally packaged applications that don't use sandboxing mechanisms" and remove the part about Debian packages. Would that work for you?

I use a couple snaps locally, I am far from being an expert on it. Although I can infer the meaning of this, based on experience, and of course we can google it (but I don't want to spend my time on that), I reckon

plugins/modules/snap.py

russoz · 2024-10-03T11:34:37Z

plugins/modules/snap.py

+            - Confinement policy: This level of confinement is permissive, granting full system access,
+              similar to that of traditionally packaged applications, such as Debian packages (those managed via the C(apt) command-line tool).
+              This option corresponds to the C(--classic) argument of the C(snap install) command.
+              It can only be specified when the task involves a single snap.


I would prefer us not to mention a specific OS as example. snap can be used in RHEL, OpenSUSE and other distros as well. I think it is better to keep the wording neutral.

russoz · 2024-10-03T11:35:54Z

plugins/modules/snap.py

+            - Snap options are a way to configure snaps by using the C(key=value) syntax or C(snap:key=value).
+              If a snap name is given, the option will be applied to that snap only.
+              If the snap name is omitted, the options will be applied to all snaps listed in O(name).
+              Options will only be applied to active snaps.
+              Since snap applications run in a sandboxed environment, this is the method used to
+              pass information to snapped applications regarding the desired configurations.
+              These configurations can be applied either at the startup of the application, within the snap (via a configure hook)
+              or during its execution if the application is designed to communicate with the snap API at runtime.
+            - See U(https://snapcraft.io/docs/configuration-in-snaps) for more details about snap options and how to configure snaps.
+            - See U(https://snapcraft.io/docs/supported-snap-hooks) for more details about configure hooks.


I second that.

plugins/modules/snap.py

Co-authored-by: Farshid Tavakolizadeh <[email protected]>

plugins/modules/snap.py

Signed-off-by: Lincoln Wallace <[email protected]>

russoz · 2024-10-04T09:12:46Z

@locnnil I jumped the gun a little bit, the PR is sill in draft. I should not be bothering you yet ;-)

plugins/modules/snap.py

Signed-off-by: Lincoln Wallace <[email protected]>

Co-authored-by: Farshid Tavakolizadeh <[email protected]>

Co-authored-by: Alexei Znamensky <[email protected]>

locnnil · 2024-10-05T00:31:27Z

@locnnil I jumped the gun a little bit, the PR is sill in draft. I should not be bothering you yet ;-)

No problem at all, I appreciate your feedback, thank you!

Signed-off-by: Lincoln Wallace <[email protected]>

ansibullbot · 2024-10-05T01:22:26Z

The test botmeta failed with 4 errors:

plugins/modules/snap.py:0:0: Cannot load DOCUMENTATION: mapping values are not allowed here
  in "<unicode string>", line 84, column 43::0:
     ... an be achieved by using V(become: true) in the module.:0:
                                         ^:0:0:

The test extra-docs failed with 5 errors:

plugins/modules/snap.py:0:0: Did not return correct DOCUMENTATION
plugins/modules/snap.py:0:0: Missing documentation or could not parse documentation: community.general.snap did not contain a DOCUMENTATION attribute (/tmp/antsibull-docs-17p2i9ji/ansible_collections/community/general/plugins/modules/snap.py). Unable to parse documentation in python file '/tmp/antsibull-docs-17p2i9ji/ansible_collections/community/general/plugins/modules/snap.py': mapping values are not allowed in this context
                               in "<unicode string>", line 84, column 43. mapping values are not allowed in this context:0:0:
                               in "<unicode string>", line 84, column 43:0:0:
plugins/modules/snap_alias.py:0:0: DOCUMENTATION -> seealso[1]: there is no module community.general.snap

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/snap.py:76:60: W291: trailing whitespace

The test ansible-test sanity --test yamllint [explain] failed with 2 errors:

plugins/modules/snap.py:99:43: error: DOCUMENTATION: syntax error: mapping values are not allowed here (syntax)
plugins/modules/snap.py:99:43: unparsable-with-libyaml: None - mapping values are not allowed in this context

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/snap.py:76:60: W291: trailing whitespace

The test ansible-test sanity --test yamllint [explain] failed with 2 errors:

plugins/modules/snap.py:99:43: error: DOCUMENTATION: syntax error: mapping values are not allowed here (syntax)
plugins/modules/snap.py:99:43: unparsable-with-libyaml: DOCUMENTATION: None - mapping values are not allowed in this context

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/snap.py:76:60: W291: trailing whitespace

The test ansible-test sanity --test yamllint [explain] failed with 2 errors:

plugins/modules/snap.py:99:43: error: DOCUMENTATION: syntax error: mapping values are not allowed here (syntax)
plugins/modules/snap.py:99:43: unparsable-with-libyaml: DOCUMENTATION: None - mapping values are not allowed in this context

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

plugins/modules/snap.py:76:60: W291: trailing whitespace

The test ansible-test sanity --test yamllint [explain] failed with 2 errors:

plugins/modules/snap.py:99:43: error: DOCUMENTATION: syntax error: mapping values are not allowed here (syntax)
plugins/modules/snap.py:99:43: unparsable-with-libyaml: DOCUMENTATION: None - mapping values are not allowed in this context

The test ansible-test sanity --test ansible-doc [explain] failed with the error:

Command "ansible-doc -t module community.general.snap" returned exit status 1.
>>> Standard Error
ERROR! module community.general.snap missing documentation (or could not parse documentation): community.general.snap did not contain a DOCUMENTATION attribute (/root/ansible_collections/community/general/plugins/modules/snap.py). Unable to parse documentation in python file '/root/ansible_collections/community/general/plugins/modules/snap.py': mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43. mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43

The test ansible-test sanity --test validate-modules [explain] failed with 16 errors:

plugins/modules/snap.py:0:0: deprecation-mismatch: "meta/runtime.yml" and DOCUMENTATION.deprecation do not agree.
plugins/modules/snap.py:0:0: doc-choices-do-not-match-spec: Argument 'state' in argument_spec defines choices as (['absent', 'present', 'enabled', 'disabled']) but documentation defines choices as ([])
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'classic' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'dangerous' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'name' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'options' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-required-mismatch: Argument 'name' in argument_spec is required, but is not documented as being required
plugins/modules/snap.py:0:0: missing-documentation: No DOCUMENTATION provided
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'channel' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'classic' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'dangerous' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'options' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'state' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:99:43: documentation-syntax-error: DOCUMENTATION is not valid YAML

The test ansible-test sanity --test ansible-doc [explain] failed with the error:

Command "ansible-doc -t module community.general.snap" returned exit status 1.
>>> Standard Error
ERROR! module community.general.snap missing documentation (or could not parse documentation): community.general.snap did not contain a DOCUMENTATION attribute (/root/ansible_collections/community/general/plugins/modules/snap.py). Unable to parse documentation in python file '/root/ansible_collections/community/general/plugins/modules/snap.py': mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43. mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43

The test ansible-test sanity --test validate-modules [explain] failed with 16 errors:

plugins/modules/snap.py:0:0: deprecation-mismatch: "meta/runtime.yml" and DOCUMENTATION.deprecation do not agree.
plugins/modules/snap.py:0:0: doc-choices-do-not-match-spec: Argument 'state' in argument_spec defines choices as (['absent', 'present', 'enabled', 'disabled']) but documentation defines choices as ([])
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'classic' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'dangerous' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'name' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'options' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-required-mismatch: Argument 'name' in argument_spec is required, but is not documented as being required
plugins/modules/snap.py:0:0: missing-documentation: No DOCUMENTATION provided
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'channel' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'classic' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'dangerous' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'options' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'state' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:99:43: documentation-syntax-error: DOCUMENTATION is not valid YAML

The test ansible-test sanity --test ansible-doc [explain] failed with the error:

Command "ansible-doc -t module community.general.snap" returned exit status 1.
>>> Standard Error
ERROR! module community.general.snap missing documentation (or could not parse documentation): community.general.snap did not contain a DOCUMENTATION attribute (/root/ansible_collections/community/general/plugins/modules/snap.py). Unable to parse documentation in python file '/root/ansible_collections/community/general/plugins/modules/snap.py': mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43. mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43

The test ansible-test sanity --test validate-modules [explain] failed with 16 errors:

plugins/modules/snap.py:0:0: deprecation-mismatch: "meta/runtime.yml" and DOCUMENTATION.deprecation do not agree.
plugins/modules/snap.py:0:0: doc-choices-do-not-match-spec: Argument 'state' in argument_spec defines choices as (['absent', 'present', 'enabled', 'disabled']) but documentation defines choices as ([])
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'classic' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'dangerous' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'name' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'options' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-required-mismatch: Argument 'name' in argument_spec is required, but is not documented as being required
plugins/modules/snap.py:0:0: missing-documentation: No DOCUMENTATION provided
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'channel' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'classic' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'dangerous' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'options' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'state' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:99:43: documentation-syntax-error: DOCUMENTATION is not valid YAML

The test ansible-test sanity --test ansible-doc [explain] failed with the error:

Command "ansible-doc -t module community.general.snap" returned exit status 1.
>>> Standard Error
ERROR! module community.general.snap missing documentation (or could not parse documentation): community.general.snap did not contain a DOCUMENTATION attribute (/root/ansible_collections/community/general/plugins/modules/snap.py). Unable to parse documentation in python file '/root/ansible_collections/community/general/plugins/modules/snap.py': mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43. mapping values are not allowed in this context
  in "<unicode string>", line 84, column 43

The test ansible-test sanity --test validate-modules [explain] failed with 16 errors:

plugins/modules/snap.py:0:0: deprecation-mismatch: "meta/runtime.yml" and DOCUMENTATION.deprecation do not agree.
plugins/modules/snap.py:0:0: doc-choices-do-not-match-spec: Argument 'state' in argument_spec defines choices as (['absent', 'present', 'enabled', 'disabled']) but documentation defines choices as ([])
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'classic' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'dangerous' in argument_spec defines default as (False) but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-default-does-not-match-spec: Argument 'state' in argument_spec defines default as ('present') but documentation defines default as (None)
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'name' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-elements-mismatch: Argument 'options' in argument_spec specifies elements as str,but elements is not documented
plugins/modules/snap.py:0:0: doc-required-mismatch: Argument 'name' in argument_spec is required, but is not documented as being required
plugins/modules/snap.py:0:0: missing-documentation: No DOCUMENTATION provided
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'channel' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'classic' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'dangerous' in argument_spec defines type as 'bool' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'name' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'options' in argument_spec defines type as 'list' but documentation doesn't define type
plugins/modules/snap.py:0:0: parameter-type-not-in-doc: Argument 'state' in argument_spec defines type as 'str' but documentation doesn't define type
plugins/modules/snap.py:99:43: documentation-syntax-error: DOCUMENTATION is not valid YAML

click here for bot help

farshidtz · 2024-10-05T11:53:57Z

plugins/modules/snap.py

@@ -29,10 +30,9 @@
    name:
        description:
            - Name of the snaps to be installed.
-            - Any named snap accepted by the C(snap) command is valid.
+            - - Any named snap accepted by the C(snap) command is valid.


Suggested change

- - Any named snap accepted by the C(snap) command is valid.

- Any named snap accepted by the C(snap) command is valid.

farshidtz · 2024-10-05T13:07:15Z

plugins/modules/snap.py

+notes:
+  - When performing privileged operations, such as installing snap packages or setting snap options,
+    it is necessary to escalate privileges by executing these operations as root.
+    This can be achieved by using V(become: true) in the module.
+  - For more details on privilege escalation in playbooks,
+    refer to U(https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html).


A couple of things:

Privilege escalation is only relevant if the user is non-root.

For a non-privileged user, it is needed only when the user hasn't logged in to the snap store (snap login). For example, the user is always logged in when using a pre-built Ubuntu Core image that uses Console Conf. This can be checked with snap whoami.

become: true is a task parameter, not module.

I combined the bullets because this is all a single note.

Suggested change

notes:

- When performing privileged operations, such as installing snap packages or setting snap options,

it is necessary to escalate privileges by executing these operations as root.

This can be achieved by using V(become: true) in the module.

- For more details on privilege escalation in playbooks,

refer to U(https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html).

notes:

- Privileged operations, such as installing and configuring snaps, require root priviledges.

This is only the case if the user hasn't logged in to the Snap Store.

The privilege can be escalated by setting V(become: true) in the task.

For more details on privilege escalation in playbooks,

refer to U(https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html).

Instead of U(https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_privilege_escalation.html), please use R(the documentation on playbook privilege escalation, playbooks_privilege_escalation). That will generate links to the documentation of the correct Ansible version in the HTML docs.

(Probably better reformulate the whole sentence.)

plugins/modules/snap: improve documentation

835f0a7

Signed-off-by: Lincoln Wallace <[email protected]>

ansibullbot added WIP Work in progress docs module module new_contributor Help guide this first time contributor plugins plugin (any type) labels Oct 3, 2024

This comment was marked as outdated.

Sign in to view

farshidtz suggested changes Oct 3, 2024

View reviewed changes

russoz reviewed Oct 3, 2024

View reviewed changes

felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-8 Automatically create a backport for the stable-8 branch backport-9 Automatically create a backport for the stable-9 branch labels Oct 3, 2024

felixfontein reviewed Oct 3, 2024

View reviewed changes

plugins/modules/snap.py Outdated Show resolved Hide resolved

plugins/modules/snap.py Outdated Show resolved Hide resolved

undo helper setence about finding avaible snaps.

b1383f6

Co-authored-by: Farshid Tavakolizadeh <[email protected]>

felixfontein reviewed Oct 3, 2024

View reviewed changes

plugins/modules/snap.py Outdated Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

wip: adress reviews

a569685

Signed-off-by: Lincoln Wallace <[email protected]>

locnnil requested review from farshidtz, felixfontein and russoz October 4, 2024 02:57

farshidtz suggested changes Oct 4, 2024

View reviewed changes

plugins/modules/snap.py Outdated Show resolved Hide resolved

plugins/modules/snap.py Outdated Show resolved Hide resolved

fix: revert sentence

fd7623e

Signed-off-by: Lincoln Wallace <[email protected]>

This comment was marked as outdated.

Sign in to view

locnnil and others added 2 commits October 4, 2024 10:19

feat: improve explanation on snap options

efed600

Co-authored-by: Farshid Tavakolizadeh <[email protected]>

clean: remove duplicated and leave reference

b56a412

Co-authored-by: Alexei Znamensky <[email protected]>

This comment was marked as outdated.

Sign in to view

feat: add note about priviledge scalation and switch sentence position

f2be203

Signed-off-by: Lincoln Wallace <[email protected]>

locnnil requested a review from farshidtz October 5, 2024 00:51

locnnil marked this pull request as ready for review October 5, 2024 00:51

ansibullbot removed the WIP Work in progress label Oct 5, 2024

ansibullbot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR label Oct 5, 2024

farshidtz suggested changes Oct 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

plugins/modules/snap: improve documentation #8972

plugins/modules/snap: improve documentation #8972

locnnil commented Oct 3, 2024

ansibullbot commented Oct 3, 2024

This comment was marked as outdated.

farshidtz left a comment

farshidtz Oct 3, 2024

russoz Oct 3, 2024

locnnil Oct 3, 2024

farshidtz Oct 4, 2024

farshidtz Oct 3, 2024

russoz Oct 3, 2024

locnnil Oct 3, 2024

russoz Oct 4, 2024 •

edited

Loading

russoz Oct 3, 2024

russoz Oct 3, 2024

This comment was marked as outdated.

russoz commented Oct 4, 2024

This comment was marked as outdated.

This comment was marked as outdated.

locnnil commented Oct 5, 2024

ansibullbot commented Oct 5, 2024

farshidtz Oct 5, 2024

farshidtz Oct 5, 2024

felixfontein Oct 5, 2024

	- - Any named snap accepted by the C(snap) command is valid.
	- Any named snap accepted by the C(snap) command is valid.

plugins/modules/snap: improve documentation #8972

Are you sure you want to change the base?

plugins/modules/snap: improve documentation #8972

Conversation

locnnil commented Oct 3, 2024

SUMMARY

ISSUE TYPE

COMPONENT NAME

ansibullbot commented Oct 3, 2024

This comment was marked as outdated.

farshidtz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

russoz Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

This comment was marked as outdated.

russoz commented Oct 4, 2024

This comment was marked as outdated.

This comment was marked as outdated.

locnnil commented Oct 5, 2024

ansibullbot commented Oct 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

russoz Oct 4, 2024 •

edited

Loading