[DOCS] Ansiblegate Documentation incorrect and lacking
Open
Nobody has claimed this yet.
ansible guide
doc-correction
doc-ex-missing
doc-request
documentation
help-wanted
severity-medium
time-estimate-sprint
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description
The ansiblegate documentation is both lacking, and flatout misleading.
The example state uses a method that doesn't even work.
Click to expand
some_set_of_tasks:
ansible:
- system.ping
- packaging.os.zypper
- name: emacs
- state: installed
ubuntu@saltma:~$ cat /srv/salt/test/ansiblegate.sls && sudo salt-call state.apply test.ansiblegate
some_set_of_tasks:
ansible:
- system.ping
- packaging.os.zypper
- name: emacs
- state: installed
[CRITICAL] Rendering SLS 'base:test.ansiblegate' failed: mapping values are not allowed in this context
local:
Data failed to compile:
----------
Rendering SLS 'base:test.ansiblegate' failed: mapping values are not allowed in this context
The example state is missing a colon on both ansible module calls, causing the above mapping values error.
But even looking past that, the state module should be ansible.call instead of ansible, because just calling ansible will fail to run.
Click to expand
cat /srv/salt/test/ansiblegate.sls && sudo salt-call state.apply test.ansiblegate
some_set_of_tasks:
ansible:
- packaging.os.zypper:
- name: emacs
- state: installed
local:
Data failed to compile:
----------
No function declared in state 'ansible' in SLS 'test.ansiblegate'
----------
cat /srv/salt/test/ansiblegate.sls && sudo salt-call state.apply test.ansiblegate
some_set_of_tasks:
ansible.call:
- packaging.os.zypper:
- name: emacs
- state: installed
[ERROR ] {'packaging.os.zypper': 'Module "packaging.os.zypper" failed. Error message: (KeyError) \'ansible.packaging.os.zypper\''}
local:
----------
ID: some_set_of_tasks
Function: ansible.call
Result: False
Comment:
Started: 22:15:54.019077
Duration: 1668.124 ms
Changes:
----------
packaging.os.zypper:
Module "packaging.os.zypper" failed. Error message: (KeyError) 'ansible.packaging.os.zypper'
Summary for local
------------
Succeeded: 0 (changed=1)
Failed: 1
------------
Total states run: 1
Total run time: 1.668 s
Suggested Fix
The documentation should replace the misleading class of salt.states.ansiblegate.AnsibleState and salt.states.ansiblegate.playbooks with values that match their actual usage, being salt.states.ansible.call and salt.states.ansible.playbooks.
There should also be some level of documentation that shows how to properly translate playbook markdown into salt state markdown.
The example documentation is incredibly terse for such a powerful state module, and is actively unhelpful with trying to help figure out the correct syntax.
Even something like translating like this basic apt package from their documentation
- name: Update the repository cache and update package "nginx" to latest version using default release squeeze-backport
apt:
name: nginx
state: latest
update_cache: yes
Fails when trying to convert it not knowing what to look for:
Click to expand
cat /srv/salt/test/ansibledocs.sls && sudo salt-call state.apply test.ansibledocs
install-based-on-ansible-docs:
ansible.call:
apt:
name: nginx
state: latest
update_cache: yes
local:
Data failed to compile:
----------
State 'install-based-on-ansible-docs' in SLS 'test.ansibledocs' is not formed as a list
or
cat /srv/salt/test/ansibledocs.sls && sudo salt-call state.apply test.ansibledocs
install-based-on-ansible-docs:
ansible.call:
apt:
- name: nginx
- state: latest
- update_cache: yes
local:
Data failed to compile:
----------
State 'install-based-on-ansible-docs' in SLS 'test.ansibledocs' is not formed as a list
Not realizing that everything needs to be structured like a dashed list, which is not how the ansible example documentation presents it.
install-based-on-ansible-docs:
ansible.call:
- apt:
name: nginx
state: latest
update_cache: yes
local:
----------
ID: install-based-on-ansible-docs
Function: ansible.call
Result: True
Comment:
Started: 22:26:38.078216
Duration: 2855.376 ms
Changes:
----------
apt:
----------
cache_update_time:
1648695970
cache_updated:
False
Summary for local
------------
Succeeded: 1 (changed=1)
Failed: 0
------------
Total states run: 1
Total run time: 2.855 s
This runs, but doesn't actually do whats wanted, because it needs to be formatted like a list all the way down before it actually works.
cat /srv/salt/test/ansibledocs.sls && sudo salt-call state.apply test.ansibledocs
install-based-on-ansible-docs:
ansible.call:
- apt:
- name: nginx
- state: latest
- update_cache: yes
local:
----------
ID: install-based-on-ansible-docs
Function: ansible.call
Result: True
Comment:
Started: 22:27:08.632520
Duration: 14241.471 ms
Changes:
----------
apt:
----------
cache_update_time:
1648697231
cache_updated:
True
stderr:
stderr_lines:
stdout:
Reading package lists...
Building dependency tree...
Reading state information...
The following packages were automatically installed and are no longer required:
libfwupdplugin1 linux-headers-5.4.0-100 linux-headers-5.4.0-100-generic
linux-image-5.4.0-100-generic linux-modules-5.4.0-100-generic
Use 'sudo apt autoremove' to remove them.
The following additional packages will be installed:
fontconfig-config fonts-dejavu-core libfontconfig1 libgd3 libjbig0
libjpeg-turbo8 libjpeg8 libnginx-mod-http-image-filter
libnginx-mod-http-xslt-filter libnginx-mod-mail libnginx-mod-stream libtiff5
libwebp6 libxpm4 nginx-common nginx-core
Suggested packages:
libgd-tools fcgiwrap nginx-doc ssl-cert
The following NEW packages will be installed:
fontconfig-config fonts-dejavu-core libfontconfig1 libgd3 libjbig0
libjpeg-turbo8 libjpeg8 libnginx-mod-http-image-filter
libnginx-mod-http-xslt-filter libnginx-mod-mail libnginx-mod-stream libtiff5
libwebp6 libxpm4 nginx nginx-common nginx-core
0 upgraded, 17 newly installed, 0 to remove and 0 not upgraded.
Need to get 2432 kB of archives.
After this operation, 7891 kB of additional disk space will be used.
Get:1 http://archive.ubuntu.com/ubuntu focal/main amd64 fonts-dejavu-core all 2.37-1 [1041 kB]
Get:2 http://archive.ubuntu.com/ubuntu focal/main amd64 fontconfig-config all 2.13.1-2ubuntu3 [28.8 kB]
Get:3 http://archive.ubuntu.com/ubuntu focal/main amd64 libfontconfig1 amd64 2.13.1-2ubuntu3 [114 kB]
Get:4 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libjpeg-turbo8 amd64 2.0.3-0ubuntu1.20.04.1 [117 kB]
Get:5 http://archive.ubuntu.com/ubuntu focal/main amd64 libjpeg8 amd64 8c-2ubuntu8 [2194 B]
Get:6 http://archive.ubuntu.com/ubuntu focal/main amd64 libjbig0 amd64 2.1-3.1build1 [26.7 kB]
Get:7 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libwebp6 amd64 0.6.1-2ubuntu0.20.04.1 [185 kB]
Get:8 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libtiff5 amd64 4.1.0+git191117-2ubuntu0.20.04.2 [162 kB]
Get:9 http://archive.ubuntu.com/ubuntu focal/main amd64 libxpm4 amd64 1:3.5.12-1 [34.0 kB]
Get:10 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libgd3 amd64 2.2.5-5.2ubuntu2.1 [118 kB]
Get:11 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 nginx-common all 1.18.0-0ubuntu1.2 [37.5 kB]
Get:12 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-http-image-filter amd64 1.18.0-0ubuntu1.2 [14.4 kB]
Get:13 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-http-xslt-filter amd64 1.18.0-0ubuntu1.2 [12.7 kB]
Get:14 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-mail amd64 1.18.0-0ubuntu1.2 [42.5 kB]
Get:15 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-stream amd64 1.18.0-0ubuntu1.2 [67.3 kB]
Get:16 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 nginx-core amd64 1.18.0-0ubuntu1.2 [425 kB]
Get:17 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 nginx all 1.18.0-0ubuntu1.2 [3620 B]
Preconfiguring packages ...
Fetched 2432 kB in 1s (2055 kB/s)
Selecting previously unselected package fonts-dejavu-core.
(Reading database ...
(Reading database ... 5%
(Reading database ... 10%
(Reading database ... 15%
(Reading database ... 20%
(Reading database ... 25%
(Reading database ... 30%
(Reading database ... 35%
(Reading database ... 40%
(Reading database ... 45%
(Reading database ... 50%
(Reading database ... 55%
(Reading database ... 60%
(Reading database ... 65%
(Reading database ... 70%
(Reading database ... 75%
(Reading database ... 80%
(Reading database ... 85%
(Reading database ... 90%
(Reading database ... 95%
(Reading database ... 100%
(Reading database ... 169378 files and directories currently installed.)
Preparing to unpack .../00-fonts-dejavu-core_2.37-1_all.deb ...
Unpacking fonts-dejavu-core (2.37-1) ...
Selecting previously unselected package fontconfig-config.
Preparing to unpack .../01-fontconfig-config_2.13.1-2ubuntu3_all.deb ...
Unpacking fontconfig-config (2.13.1-2ubuntu3) ...
Selecting previously unselected package libfontconfig1:amd64.
Preparing to unpack .../02-libfontconfig1_2.13.1-2ubuntu3_amd64.deb ...
Unpacking libfontconfig1:amd64 (2.13.1-2ubuntu3) ...
Selecting previously unselected package libjpeg-turbo8:amd64.
Preparing to unpack .../03-libjpeg-turbo8_2.0.3-0ubuntu1.20.04.1_amd64.deb ...
Unpacking libjpeg-turbo8:amd64 (2.0.3-0ubuntu1.20.04.1) ...
Selecting previously unselected package libjpeg8:amd64.
Preparing to unpack .../04-libjpeg8_8c-2ubuntu8_amd64.deb ...
Unpacking libjpeg8:amd64 (8c-2ubuntu8) ...
Selecting previously unselected package libjbig0:amd64.
Preparing to unpack .../05-libjbig0_2.1-3.1build1_amd64.deb ...
Unpacking libjbig0:amd64 (2.1-3.1build1) ...
Selecting previously unselected package libwebp6:amd64.
Preparing to unpack .../06-libwebp6_0.6.1-2ubuntu0.20.04.1_amd64.deb ...
Unpacking libwebp6:amd64 (0.6.1-2ubuntu0.20.04.1) ...
Selecting previously unselected package libtiff5:amd64.
Preparing to unpack .../07-libtiff5_4.1.0+git191117-2ubuntu0.20.04.2_amd64.deb ...
Unpacking libtiff5:amd64 (4.1.0+git191117-2ubuntu0.20.04.2) ...
Selecting previously unselected package libxpm4:amd64.
Preparing to unpack .../08-libxpm4_1%3a3.5.12-1_amd64.deb ...
Unpacking libxpm4:amd64 (1:3.5.12-1) ...
Selecting previously unselected package libgd3:amd64.
Preparing to unpack .../09-libgd3_2.2.5-5.2ubuntu2.1_amd64.deb ...
Unpacking libgd3:amd64 (2.2.5-5.2ubuntu2.1) ...
Selecting previously unselected package nginx-common.
Preparing to unpack .../10-nginx-common_1.18.0-0ubuntu1.2_all.deb ...
Unpacking nginx-common (1.18.0-0ubuntu1.2) ...
Selecting previously unselected package libnginx-mod-http-image-filter.
Preparing to unpack .../11-libnginx-mod-http-image-filter_1.18.0-0ubuntu1.2_amd64.deb ...
Unpacking libnginx-mod-http-image-filter (1.18.0-0ubuntu1.2) ...
Selecting previously unselected package libnginx-mod-http-xslt-filter.
Preparing to unpack .../12-libnginx-mod-http-xslt-filter_1.18.0-0ubuntu1.2_amd64.deb ...
Unpacking libnginx-mod-http-xslt-filter (1.18.0-0ubuntu1.2) ...
Selecting previously unselected package libnginx-mod-mail.
Preparing to unpack .../13-libnginx-mod-mail_1.18.0-0ubuntu1.2_amd64.deb ...
Unpacking libnginx-mod-mail (1.18.0-0ubuntu1.2) ...
Selecting previously unselected package libnginx-mod-stream.
Preparing to unpack .../14-libnginx-mod-stream_1.18.0-0ubuntu1.2_amd64.deb ...
Unpacking libnginx-mod-stream (1.18.0-0ubuntu1.2) ...
Selecting previously unselected package nginx-core.
Preparing to unpack .../15-nginx-core_1.18.0-0ubuntu1.2_amd64.deb ...
Unpacking nginx-core (1.18.0-0ubuntu1.2) ...
Selecting previously unselected package nginx.
Preparing to unpack .../16-nginx_1.18.0-0ubuntu1.2_all.deb ...
Unpacking nginx (1.18.0-0ubuntu1.2) ...
Setting up libxpm4:amd64 (1:3.5.12-1) ...
Setting up nginx-common (1.18.0-0ubuntu1.2) ...
Created symlink /etc/systemd/system/multi-user.target.wants/nginx.service -> /lib/systemd/system/nginx.service.
Setting up libjbig0:amd64 (2.1-3.1build1) ...
Setting up libnginx-mod-http-xslt-filter (1.18.0-0ubuntu1.2) ...
Setting up libwebp6:amd64 (0.6.1-2ubuntu0.20.04.1) ...
Setting up fonts-dejavu-core (2.37-1) ...
Setting up libjpeg-turbo8:amd64 (2.0.3-0ubuntu1.20.04.1) ...
Setting up libjpeg8:amd64 (8c-2ubuntu8) ...
Setting up libnginx-mod-mail (1.18.0-0ubuntu1.2) ...
Setting up fontconfig-config (2.13.1-2ubuntu3) ...
Setting up libnginx-mod-stream (1.18.0-0ubuntu1.2) ...
Setting up libtiff5:amd64 (4.1.0+git191117-2ubuntu0.20.04.2) ...
Setting up libfontconfig1:amd64 (2.13.1-2ubuntu3) ...
Setting up libgd3:amd64 (2.2.5-5.2ubuntu2.1) ...
Setting up libnginx-mod-http-image-filter (1.18.0-0ubuntu1.2) ...
Setting up nginx-core (1.18.0-0ubuntu1.2) ...
Setting up nginx (1.18.0-0ubuntu1.2) ...
Processing triggers for ufw (0.36-6ubuntu1) ...
Processing triggers for systemd (245.4-4ubuntu3.15) ...
Processing triggers for man-db (2.9.1-1) ...
Processing triggers for libc-bin (2.31-0ubuntu9.7) ...
stdout_lines:
- Reading package lists...
- Building dependency tree...
- Reading state information...
- The following packages were automatically installed and are no longer required:
- libfwupdplugin1 linux-headers-5.4.0-100 linux-headers-5.4.0-100-generic
- linux-image-5.4.0-100-generic linux-modules-5.4.0-100-generic
- Use 'sudo apt autoremove' to remove them.
- The following additional packages will be installed:
- fontconfig-config fonts-dejavu-core libfontconfig1 libgd3 libjbig0
- libjpeg-turbo8 libjpeg8 libnginx-mod-http-image-filter
- libnginx-mod-http-xslt-filter libnginx-mod-mail libnginx-mod-stream libtiff5
- libwebp6 libxpm4 nginx-common nginx-core
- Suggested packages:
- libgd-tools fcgiwrap nginx-doc ssl-cert
- The following NEW packages will be installed:
- fontconfig-config fonts-dejavu-core libfontconfig1 libgd3 libjbig0
- libjpeg-turbo8 libjpeg8 libnginx-mod-http-image-filter
- libnginx-mod-http-xslt-filter libnginx-mod-mail libnginx-mod-stream libtiff5
- libwebp6 libxpm4 nginx nginx-common nginx-core
- 0 upgraded, 17 newly installed, 0 to remove and 0 not upgraded.
- Need to get 2432 kB of archives.
- After this operation, 7891 kB of additional disk space will be used.
- Get:1 http://archive.ubuntu.com/ubuntu focal/main amd64 fonts-dejavu-core all 2.37-1 [1041 kB]
- Get:2 http://archive.ubuntu.com/ubuntu focal/main amd64 fontconfig-config all 2.13.1-2ubuntu3 [28.8 kB]
- Get:3 http://archive.ubuntu.com/ubuntu focal/main amd64 libfontconfig1 amd64 2.13.1-2ubuntu3 [114 kB]
- Get:4 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libjpeg-turbo8 amd64 2.0.3-0ubuntu1.20.04.1 [117 kB]
- Get:5 http://archive.ubuntu.com/ubuntu focal/main amd64 libjpeg8 amd64 8c-2ubuntu8 [2194 B]
- Get:6 http://archive.ubuntu.com/ubuntu focal/main amd64 libjbig0 amd64 2.1-3.1build1 [26.7 kB]
- Get:7 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libwebp6 amd64 0.6.1-2ubuntu0.20.04.1 [185 kB]
- Get:8 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libtiff5 amd64 4.1.0+git191117-2ubuntu0.20.04.2 [162 kB]
- Get:9 http://archive.ubuntu.com/ubuntu focal/main amd64 libxpm4 amd64 1:3.5.12-1 [34.0 kB]
- Get:10 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libgd3 amd64 2.2.5-5.2ubuntu2.1 [118 kB]
- Get:11 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 nginx-common all 1.18.0-0ubuntu1.2 [37.5 kB]
- Get:12 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-http-image-filter amd64 1.18.0-0ubuntu1.2 [14.4 kB]
- Get:13 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-http-xslt-filter amd64 1.18.0-0ubuntu1.2 [12.7 kB]
- Get:14 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-mail amd64 1.18.0-0ubuntu1.2 [42.5 kB]
- Get:15 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 libnginx-mod-stream amd64 1.18.0-0ubuntu1.2 [67.3 kB]
- Get:16 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 nginx-core amd64 1.18.0-0ubuntu1.2 [425 kB]
- Get:17 http://archive.ubuntu.com/ubuntu focal-updates/main amd64 nginx all 1.18.0-0ubuntu1.2 [3620 B]
- Preconfiguring packages ...
- Fetched 2432 kB in 1s (2055 kB/s)
- Selecting previously unselected package fonts-dejavu-core.
- (Reading database ...
- (Reading database ... 5%
- (Reading database ... 10%
- (Reading database ... 15%
- (Reading database ... 20%
- (Reading database ... 25%
- (Reading database ... 30%
- (Reading database ... 35%
- (Reading database ... 40%
- (Reading database ... 45%
- (Reading database ... 50%
- (Reading database ... 55%
- (Reading database ... 60%
- (Reading database ... 65%
- (Reading database ... 70%
- (Reading database ... 75%
- (Reading database ... 80%
- (Reading database ... 85%
- (Reading database ... 90%
- (Reading database ... 95%
- (Reading database ... 100%
- (Reading database ... 169378 files and directories currently installed.)
- Preparing to unpack .../00-fonts-dejavu-core_2.37-1_all.deb ...
- Unpacking fonts-dejavu-core (2.37-1) ...
- Selecting previously unselected package fontconfig-config.
- Preparing to unpack .../01-fontconfig-config_2.13.1-2ubuntu3_all.deb ...
- Unpacking fontconfig-config (2.13.1-2ubuntu3) ...
- Selecting previously unselected package libfontconfig1:amd64.
- Preparing to unpack .../02-libfontconfig1_2.13.1-2ubuntu3_amd64.deb ...
- Unpacking libfontconfig1:amd64 (2.13.1-2ubuntu3) ...
- Selecting previously unselected package libjpeg-turbo8:amd64.
- Preparing to unpack .../03-libjpeg-turbo8_2.0.3-0ubuntu1.20.04.1_amd64.deb ...
- Unpacking libjpeg-turbo8:amd64 (2.0.3-0ubuntu1.20.04.1) ...
- Selecting previously unselected package libjpeg8:amd64.
- Preparing to unpack .../04-libjpeg8_8c-2ubuntu8_amd64.deb ...
- Unpacking libjpeg8:amd64 (8c-2ubuntu8) ...
- Selecting previously unselected package libjbig0:amd64.
- Preparing to unpack .../05-libjbig0_2.1-3.1build1_amd64.deb ...
- Unpacking libjbig0:amd64 (2.1-3.1build1) ...
- Selecting previously unselected package libwebp6:amd64.
- Preparing to unpack .../06-libwebp6_0.6.1-2ubuntu0.20.04.1_amd64.deb ...
- Unpacking libwebp6:amd64 (0.6.1-2ubuntu0.20.04.1) ...
- Selecting previously unselected package libtiff5:amd64.
- Preparing to unpack .../07-libtiff5_4.1.0+git191117-2ubuntu0.20.04.2_amd64.deb ...
- Unpacking libtiff5:amd64 (4.1.0+git191117-2ubuntu0.20.04.2) ...
- Selecting previously unselected package libxpm4:amd64.
- Preparing to unpack .../08-libxpm4_1%3a3.5.12-1_amd64.deb ...
- Unpacking libxpm4:amd64 (1:3.5.12-1) ...
- Selecting previously unselected package libgd3:amd64.
- Preparing to unpack .../09-libgd3_2.2.5-5.2ubuntu2.1_amd64.deb ...
- Unpacking libgd3:amd64 (2.2.5-5.2ubuntu2.1) ...
- Selecting previously unselected package nginx-common.
- Preparing to unpack .../10-nginx-common_1.18.0-0ubuntu1.2_all.deb ...
- Unpacking nginx-common (1.18.0-0ubuntu1.2) ...
- Selecting previously unselected package libnginx-mod-http-image-filter.
- Preparing to unpack .../11-libnginx-mod-http-image-filter_1.18.0-0ubuntu1.2_amd64.deb ...
- Unpacking libnginx-mod-http-image-filter (1.18.0-0ubuntu1.2) ...
- Selecting previously unselected package libnginx-mod-http-xslt-filter.
- Preparing to unpack .../12-libnginx-mod-http-xslt-filter_1.18.0-0ubuntu1.2_amd64.deb ...
- Unpacking libnginx-mod-http-xslt-filter (1.18.0-0ubuntu1.2) ...
- Selecting previously unselected package libnginx-mod-mail.
- Preparing to unpack .../13-libnginx-mod-mail_1.18.0-0ubuntu1.2_amd64.deb ...
- Unpacking libnginx-mod-mail (1.18.0-0ubuntu1.2) ...
- Selecting previously unselected package libnginx-mod-stream.
- Preparing to unpack .../14-libnginx-mod-stream_1.18.0-0ubuntu1.2_amd64.deb ...
- Unpacking libnginx-mod-stream (1.18.0-0ubuntu1.2) ...
- Selecting previously unselected package nginx-core.
- Preparing to unpack .../15-nginx-core_1.18.0-0ubuntu1.2_amd64.deb ...
- Unpacking nginx-core (1.18.0-0ubuntu1.2) ...
- Selecting previously unselected package nginx.
- Preparing to unpack .../16-nginx_1.18.0-0ubuntu1.2_all.deb ...
- Unpacking nginx (1.18.0-0ubuntu1.2) ...
- Setting up libxpm4:amd64 (1:3.5.12-1) ...
- Setting up nginx-common (1.18.0-0ubuntu1.2) ...
- Created symlink /etc/systemd/system/multi-user.target.wants/nginx.service -> /lib/systemd/system/nginx.service.
- Setting up libjbig0:amd64 (2.1-3.1build1) ...
- Setting up libnginx-mod-http-xslt-filter (1.18.0-0ubuntu1.2) ...
- Setting up libwebp6:amd64 (0.6.1-2ubuntu0.20.04.1) ...
- Setting up fonts-dejavu-core (2.37-1) ...
- Setting up libjpeg-turbo8:amd64 (2.0.3-0ubuntu1.20.04.1) ...
- Setting up libjpeg8:amd64 (8c-2ubuntu8) ...
- Setting up libnginx-mod-mail (1.18.0-0ubuntu1.2) ...
- Setting up fontconfig-config (2.13.1-2ubuntu3) ...
- Setting up libnginx-mod-stream (1.18.0-0ubuntu1.2) ...
- Setting up libtiff5:amd64 (4.1.0+git191117-2ubuntu0.20.04.2) ...
- Setting up libfontconfig1:amd64 (2.13.1-2ubuntu3) ...
- Setting up libgd3:amd64 (2.2.5-5.2ubuntu2.1) ...
- Setting up libnginx-mod-http-image-filter (1.18.0-0ubuntu1.2) ...
- Setting up nginx-core (1.18.0-0ubuntu1.2) ...
- Setting up nginx (1.18.0-0ubuntu1.2) ...
- Processing triggers for ufw (0.36-6ubuntu1) ...
- Processing triggers for systemd (245.4-4ubuntu3.15) ...
- Processing triggers for man-db (2.9.1-1) ...
- Processing triggers for libc-bin (2.31-0ubuntu9.7) ...
Summary for local
------------
Succeeded: 1 (changed=1)
Failed: 0
------------
Total states run: 1
Total run time: 14.241 s
Type of documentation
Salt documentation for the ansiblegate state modules, and maybe even the execution modules.
At least in the execution modules documentation, you know that it's supposed to be ansible.call
Location or format of documentation
Insert page URL if applicable.
Additional context
This is all using 3004 and 3004.1.
Once you know what you're doing, obviously you know what you're doing.
But when you don't know what you're doing, with ansible, salt, or both, and you try to turn to the documentation, only to get (mis)information pertaining to what you're looking for, it's not great.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the documentation for salt.states.ansiblegate.AnsibleState, salt.states.ansiblegate.playbooks, and the ansible.call state referenced in the issue. Verify the shown state examples against the reported errors, then update the names, YAML structure, and conversion guidance. Done means the examples are accurate, runnable, and explain how to translate the referenced Ansible apt example.
Written by the indexing model from the issue text.
Assessment
- Domain
- devops, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100