diff --git a/doc/ref/beacons/all/index.rst b/doc/ref/beacons/all/index.rst index 7fccfc5b1518..a3b452a9a98a 100644 --- a/doc/ref/beacons/all/index.rst +++ b/doc/ref/beacons/all/index.rst @@ -11,6 +11,7 @@ beacon modules :template: autosummary.rst.tmpl adb + aix_account avahi_announce bonjour_announce btmp diff --git a/doc/ref/beacons/all/salt.beacons.aix_account.rst b/doc/ref/beacons/all/salt.beacons.aix_account.rst new file mode 100644 index 000000000000..f7467322ac5c --- /dev/null +++ b/doc/ref/beacons/all/salt.beacons.aix_account.rst @@ -0,0 +1,5 @@ +salt.beacons.aix_account module +=============================== + +.. automodule:: salt.beacons.aix_account + :members: diff --git a/doc/ref/clouds/all/index.rst b/doc/ref/clouds/all/index.rst index 3e401eee23a3..4b3c76a33c16 100644 --- a/doc/ref/clouds/all/index.rst +++ b/doc/ref/clouds/all/index.rst @@ -12,6 +12,7 @@ cloud modules aliyun azurearm + clc cloudstack digitalocean dimensiondata @@ -19,6 +20,7 @@ cloud modules gce gogrid joyent + libvirt linode lxc msazure @@ -26,6 +28,7 @@ cloud modules oneandone opennebula openstack + packet parallels profitbricks proxmox diff --git a/doc/ref/clouds/all/salt.cloud.clouds.clc.rst b/doc/ref/clouds/all/salt.cloud.clouds.clc.rst new file mode 100644 index 000000000000..03991947dbd1 --- /dev/null +++ b/doc/ref/clouds/all/salt.cloud.clouds.clc.rst @@ -0,0 +1,6 @@ +===================== +salt.cloud.clouds.clc +===================== + +.. automodule:: salt.cloud.clouds.clc + :members: diff --git a/doc/ref/clouds/all/salt.cloud.clouds.libvirt.rst b/doc/ref/clouds/all/salt.cloud.clouds.libvirt.rst new file mode 100644 index 000000000000..32342f932ec5 --- /dev/null +++ b/doc/ref/clouds/all/salt.cloud.clouds.libvirt.rst @@ -0,0 +1,6 @@ +========================= +salt.cloud.clouds.libvirt +========================= + +.. automodule:: salt.cloud.clouds.libvirt + :members: diff --git a/doc/ref/clouds/all/salt.cloud.clouds.packet.rst b/doc/ref/clouds/all/salt.cloud.clouds.packet.rst new file mode 100644 index 000000000000..7898814742f6 --- /dev/null +++ b/doc/ref/clouds/all/salt.cloud.clouds.packet.rst @@ -0,0 +1,6 @@ +======================== +salt.cloud.clouds.packet +======================== + +.. automodule:: salt.cloud.clouds.packet + :members: diff --git a/doc/ref/grains/all/index.rst b/doc/ref/grains/all/index.rst index 22b65f66a9e7..a790fcb8610b 100644 --- a/doc/ref/grains/all/index.rst +++ b/doc/ref/grains/all/index.rst @@ -15,12 +15,20 @@ grains modules disks esxi extra + fibre_channel fx2 + iscsi junos marathon mdadm + mdata metadata + minion_process napalm + nxos opts philips_hue + smartos + ssh_sample rest_sample + zfs diff --git a/doc/ref/grains/all/salt.grains.fibre_channel.rst b/doc/ref/grains/all/salt.grains.fibre_channel.rst new file mode 100644 index 000000000000..9c4d3045eaf5 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.fibre_channel.rst @@ -0,0 +1,6 @@ +========================= +salt.grains.fibre_channel +========================= + +.. automodule:: salt.grains.fibre_channel + :members: diff --git a/doc/ref/grains/all/salt.grains.iscsi.rst b/doc/ref/grains/all/salt.grains.iscsi.rst new file mode 100644 index 000000000000..11d16faf3d34 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.iscsi.rst @@ -0,0 +1,6 @@ +================= +salt.grains.iscsi +================= + +.. automodule:: salt.grains.iscsi + :members: diff --git a/doc/ref/grains/all/salt.grains.mdata.rst b/doc/ref/grains/all/salt.grains.mdata.rst new file mode 100644 index 000000000000..34599b7329f0 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.mdata.rst @@ -0,0 +1,6 @@ +================= +salt.grains.mdata +================= + +.. automodule:: salt.grains.mdata + :members: diff --git a/doc/ref/grains/all/salt.grains.minion_process.rst b/doc/ref/grains/all/salt.grains.minion_process.rst new file mode 100644 index 000000000000..254e646416c6 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.minion_process.rst @@ -0,0 +1,6 @@ +========================== +salt.grains.minion_process +========================== + +.. automodule:: salt.grains.minion_process + :members: diff --git a/doc/ref/grains/all/salt.grains.nxos.rst b/doc/ref/grains/all/salt.grains.nxos.rst new file mode 100644 index 000000000000..79b7448a56f3 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.nxos.rst @@ -0,0 +1,6 @@ +================ +salt.grains.nxos +================ + +.. automodule:: salt.grains.nxos + :members: diff --git a/doc/ref/grains/all/salt.grains.smartos.rst b/doc/ref/grains/all/salt.grains.smartos.rst new file mode 100644 index 000000000000..0b5a9a28efc9 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.smartos.rst @@ -0,0 +1,6 @@ +=================== +salt.grains.smartos +=================== + +.. automodule:: salt.grains.smartos + :members: diff --git a/doc/ref/grains/all/salt.grains.ssh_sample.rst b/doc/ref/grains/all/salt.grains.ssh_sample.rst new file mode 100644 index 000000000000..84828a517144 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.ssh_sample.rst @@ -0,0 +1,6 @@ +====================== +salt.grains.ssh_sample +====================== + +.. automodule:: salt.grains.ssh_sample + :members: diff --git a/doc/ref/grains/all/salt.grains.zfs.rst b/doc/ref/grains/all/salt.grains.zfs.rst new file mode 100644 index 000000000000..f0875ecb1d07 --- /dev/null +++ b/doc/ref/grains/all/salt.grains.zfs.rst @@ -0,0 +1,6 @@ +=============== +salt.grains.zfs +=============== + +.. automodule:: salt.grains.zfs + :members: diff --git a/doc/ref/modules/all/index.rst b/doc/ref/modules/all/index.rst index 615956a91147..23540ad00298 100644 --- a/doc/ref/modules/all/index.rst +++ b/doc/ref/modules/all/index.rst @@ -23,6 +23,7 @@ execution modules acme aix_group + aix_shadow aliases alternatives ansiblegate @@ -31,6 +32,7 @@ execution modules apf apkpkg aptpkg + aptly archive artifactory at @@ -44,6 +46,7 @@ execution modules bluez_bluetooth boto3_elasticache boto3_route53 + boto3_sns boto_apigateway boto_asg boto_cfn @@ -67,6 +70,7 @@ execution modules boto_lambda boto_rds boto_route53 + boto_s3 boto_s3_bucket boto_secgroup boto_sns @@ -86,6 +90,7 @@ execution modules chef chocolatey chronos + cimc cisconso cloud cmdmod @@ -96,6 +101,7 @@ execution modules cp cpan cron + cryptdev csf cyg daemontools @@ -128,7 +134,10 @@ execution modules elasticsearch environ eselect + esxcluster + esxdatacenter esxi + esxvm etcd_mod ethtool event @@ -142,6 +151,7 @@ execution modules freebsdpkg freebsdports freebsdservice + gcp_addon gem genesis gentoo_service @@ -150,6 +160,7 @@ execution modules github glance glanceng + glassfish glusterfs gnomedesktop gpg @@ -164,6 +175,7 @@ execution modules heat hg hipchat + highstate_doc hosts http ifttt @@ -286,6 +298,7 @@ execution modules network neutron neutronng + nexus nfs3 nftables nginx @@ -447,11 +460,13 @@ execution modules vault vbox_guest vboxmanage + vcenter victorops virt virtualenv_mod vsphere webutil + win_auditpol win_autoruns win_certutil win_dacl @@ -486,6 +501,8 @@ execution modules win_update win_useradd win_wua + win_wusa + wordpress x509 xapi_virt xbpspkg diff --git a/doc/ref/modules/all/salt.modules.aix_shadow.rst b/doc/ref/modules/all/salt.modules.aix_shadow.rst new file mode 100644 index 000000000000..a3159fd0fd63 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.aix_shadow.rst @@ -0,0 +1,6 @@ +salt.modules.aix_shadow module +============================== + +.. automodule:: salt.modules.aix_shadow + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.aptly.rst b/doc/ref/modules/all/salt.modules.aptly.rst new file mode 100644 index 000000000000..8ecbc8ced018 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.aptly.rst @@ -0,0 +1,6 @@ +salt.modules.aptly module +========================= + +.. automodule:: salt.modules.aptly + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.boto3_sns.rst b/doc/ref/modules/all/salt.modules.boto3_sns.rst new file mode 100644 index 000000000000..3031c5c65b3e --- /dev/null +++ b/doc/ref/modules/all/salt.modules.boto3_sns.rst @@ -0,0 +1,6 @@ +salt.modules.boto3_sns module +============================= + +.. automodule:: salt.modules.boto3_sns + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.boto_s3.rst b/doc/ref/modules/all/salt.modules.boto_s3.rst new file mode 100644 index 000000000000..8f930bbc0d65 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.boto_s3.rst @@ -0,0 +1,6 @@ +salt.modules.boto_s3 module +=========================== + +.. automodule:: salt.modules.boto_s3 + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.cryptdev.rst b/doc/ref/modules/all/salt.modules.cryptdev.rst new file mode 100644 index 000000000000..c62ebb2d748a --- /dev/null +++ b/doc/ref/modules/all/salt.modules.cryptdev.rst @@ -0,0 +1,6 @@ +salt.modules.cryptdev module +============================ + +.. automodule:: salt.modules.cryptdev + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.esxcluster.rst b/doc/ref/modules/all/salt.modules.esxcluster.rst new file mode 100644 index 000000000000..8c086929ba36 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.esxcluster.rst @@ -0,0 +1,6 @@ +salt.modules.esxcluster module +============================== + +.. automodule:: salt.modules.esxcluster + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.esxdatacenter.rst b/doc/ref/modules/all/salt.modules.esxdatacenter.rst new file mode 100644 index 000000000000..4fb8d8109697 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.esxdatacenter.rst @@ -0,0 +1,6 @@ +salt.modules.esxdatacenter module +================================= + +.. automodule:: salt.modules.esxdatacenter + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.esxvm.rst b/doc/ref/modules/all/salt.modules.esxvm.rst new file mode 100644 index 000000000000..5d9305247cc1 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.esxvm.rst @@ -0,0 +1,6 @@ +salt.modules.esxvm module +========================= + +.. automodule:: salt.modules.esxvm + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.gcp_addon.rst b/doc/ref/modules/all/salt.modules.gcp_addon.rst new file mode 100644 index 000000000000..415cacfb84c2 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.gcp_addon.rst @@ -0,0 +1,6 @@ +salt.modules.gcp_addon module +============================= + +.. automodule:: salt.modules.gcp_addon + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.glassfish.rst b/doc/ref/modules/all/salt.modules.glassfish.rst new file mode 100644 index 000000000000..8297783c1228 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.glassfish.rst @@ -0,0 +1,6 @@ +salt.modules.glassfish module +============================= + +.. automodule:: salt.modules.glassfish + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.highstate_doc.rst b/doc/ref/modules/all/salt.modules.highstate_doc.rst new file mode 100644 index 000000000000..ccf7ea4f7b40 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.highstate_doc.rst @@ -0,0 +1,6 @@ +salt.modules.highstate_doc module +================================= + +.. automodule:: salt.modules.highstate_doc + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.nexus.rst b/doc/ref/modules/all/salt.modules.nexus.rst new file mode 100644 index 000000000000..09d619c15dec --- /dev/null +++ b/doc/ref/modules/all/salt.modules.nexus.rst @@ -0,0 +1,6 @@ +salt.modules.nexus module +========================= + +.. automodule:: salt.modules.nexus + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.shadow.rst b/doc/ref/modules/all/salt.modules.shadow.rst index 3b03032d28eb..3212cf1029bf 100644 --- a/doc/ref/modules/all/salt.modules.shadow.rst +++ b/doc/ref/modules/all/salt.modules.shadow.rst @@ -13,6 +13,7 @@ modules: ====================================== ======================================== Execution Module Used for ====================================== ======================================== +:py:mod:`~salt.modules.aix_shadow` AIX :py:mod:`~salt.modules.shadow` Linux :py:mod:`~salt.modules.bsd_shadow` FreeBSD, OpenBSD, NetBSD :py:mod:`~salt.modules.solaris_shadow` Solaris-based OSes diff --git a/doc/ref/modules/all/salt.modules.vcenter.rst b/doc/ref/modules/all/salt.modules.vcenter.rst new file mode 100644 index 000000000000..863f92e85d46 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.vcenter.rst @@ -0,0 +1,6 @@ +salt.modules.vcenter module +=========================== + +.. automodule:: salt.modules.vcenter + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.win_auditpol.rst b/doc/ref/modules/all/salt.modules.win_auditpol.rst new file mode 100644 index 000000000000..a5fabb2e3ce7 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.win_auditpol.rst @@ -0,0 +1,6 @@ +salt.modules.win_auditpol module +================================ + +.. automodule:: salt.modules.win_auditpol + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.win_wusa.rst b/doc/ref/modules/all/salt.modules.win_wusa.rst new file mode 100644 index 000000000000..10fefcc4415b --- /dev/null +++ b/doc/ref/modules/all/salt.modules.win_wusa.rst @@ -0,0 +1,6 @@ +salt.modules.win_wusa module +============================ + +.. automodule:: salt.modules.win_wusa + :members: + :undoc-members: diff --git a/doc/ref/modules/all/salt.modules.wordpress.rst b/doc/ref/modules/all/salt.modules.wordpress.rst new file mode 100644 index 000000000000..d21aba9e5b75 --- /dev/null +++ b/doc/ref/modules/all/salt.modules.wordpress.rst @@ -0,0 +1,6 @@ +salt.modules.wordpress module +============================= + +.. automodule:: salt.modules.wordpress + :members: + :undoc-members: diff --git a/doc/ref/pillar/all/index.rst b/doc/ref/pillar/all/index.rst index 3b33573ee8bb..1a17f5bceb24 100644 --- a/doc/ref/pillar/all/index.rst +++ b/doc/ref/pillar/all/index.rst @@ -21,6 +21,7 @@ pillar modules django_orm ec2_pillar etcd_pillar + extra_minion_data_in_pillar file_tree foreman git_pillar @@ -33,6 +34,7 @@ pillar modules makostack mongo mysql + nacl neutron nodegroups pepa @@ -41,6 +43,7 @@ pillar modules puppet reclass_adapter redismod + rethinkdb_pillar s3 saltclass sql_base diff --git a/doc/ref/pillar/all/salt.pillar.extra_minion_data_in_pillar.rst b/doc/ref/pillar/all/salt.pillar.extra_minion_data_in_pillar.rst new file mode 100644 index 000000000000..16ff48a62717 --- /dev/null +++ b/doc/ref/pillar/all/salt.pillar.extra_minion_data_in_pillar.rst @@ -0,0 +1,6 @@ +======================================= +salt.pillar.extra_minion_data_in_pillar +======================================= + +.. automodule:: salt.pillar.extra_minion_data_in_pillar + :members: diff --git a/doc/ref/pillar/all/salt.pillar.nacl.rst b/doc/ref/pillar/all/salt.pillar.nacl.rst new file mode 100644 index 000000000000..7d245c0d7ea9 --- /dev/null +++ b/doc/ref/pillar/all/salt.pillar.nacl.rst @@ -0,0 +1,6 @@ +================ +salt.pillar.nacl +================ + +.. automodule:: salt.pillar.nacl + :members: diff --git a/doc/ref/pillar/all/salt.pillar.rethinkdb_pillar.rst b/doc/ref/pillar/all/salt.pillar.rethinkdb_pillar.rst new file mode 100644 index 000000000000..bc6acb7203c8 --- /dev/null +++ b/doc/ref/pillar/all/salt.pillar.rethinkdb_pillar.rst @@ -0,0 +1,6 @@ +============================ +salt.pillar.rethinkdb_pillar +============================ + +.. automodule:: salt.pillar.rethinkdb_pillar + :members: diff --git a/doc/ref/proxy/all/index.rst b/doc/ref/proxy/all/index.rst index 6d601b743165..cd5fe81ea6f9 100644 --- a/doc/ref/proxy/all/index.rst +++ b/doc/ref/proxy/all/index.rst @@ -14,7 +14,10 @@ proxy modules cimc cisconso dummy + esxcluster + esxdatacenter esxi + esxvm fx2 junos marathon @@ -24,3 +27,4 @@ proxy modules philips_hue rest_sample ssh_sample + vcenter diff --git a/doc/ref/proxy/all/salt.proxy.esxcluster.rst b/doc/ref/proxy/all/salt.proxy.esxcluster.rst new file mode 100644 index 000000000000..38a6331bbbc4 --- /dev/null +++ b/doc/ref/proxy/all/salt.proxy.esxcluster.rst @@ -0,0 +1,6 @@ +salt.proxy.esxcluster module +============================ + +.. automodule:: salt.proxy.esxcluster + :members: + :undoc-members: diff --git a/doc/ref/proxy/all/salt.proxy.esxdatacenter.rst b/doc/ref/proxy/all/salt.proxy.esxdatacenter.rst new file mode 100644 index 000000000000..f190574f8f52 --- /dev/null +++ b/doc/ref/proxy/all/salt.proxy.esxdatacenter.rst @@ -0,0 +1,6 @@ +salt.proxy.esxdatacenter module +=============================== + +.. automodule:: salt.proxy.esxdatacenter + :members: + :undoc-members: diff --git a/doc/ref/proxy/all/salt.proxy.esxvm.rst b/doc/ref/proxy/all/salt.proxy.esxvm.rst new file mode 100644 index 000000000000..fbbf2fc821d0 --- /dev/null +++ b/doc/ref/proxy/all/salt.proxy.esxvm.rst @@ -0,0 +1,6 @@ +salt.proxy.esxvm module +======================= + +.. automodule:: salt.proxy.esxvm + :members: + :undoc-members: diff --git a/doc/ref/proxy/all/salt.proxy.vcenter.rst b/doc/ref/proxy/all/salt.proxy.vcenter.rst new file mode 100644 index 000000000000..264c38d68857 --- /dev/null +++ b/doc/ref/proxy/all/salt.proxy.vcenter.rst @@ -0,0 +1,6 @@ +salt.proxy.vcenter module +========================= + +.. automodule:: salt.proxy.vcenter + :members: + :undoc-members: diff --git a/doc/ref/renderers/all/index.rst b/doc/ref/renderers/all/index.rst index 5bc34d41f059..c5ecfed4d9b0 100644 --- a/doc/ref/renderers/all/index.rst +++ b/doc/ref/renderers/all/index.rst @@ -20,6 +20,7 @@ renderer modules json5 mako msgpack + nacl pass py pydsl diff --git a/doc/ref/renderers/all/salt.renderers.nacl.rst b/doc/ref/renderers/all/salt.renderers.nacl.rst new file mode 100644 index 000000000000..41c5da00108f --- /dev/null +++ b/doc/ref/renderers/all/salt.renderers.nacl.rst @@ -0,0 +1,6 @@ +=================== +salt.renderers.nacl +=================== + +.. automodule:: salt.renderers.nacl + :members: diff --git a/doc/ref/runners/all/index.rst b/doc/ref/runners/all/index.rst index ebbab3a420d5..3a9409b4e374 100644 --- a/doc/ref/runners/all/index.rst +++ b/doc/ref/runners/all/index.rst @@ -15,6 +15,7 @@ runner modules bgp cache cloud + config ddns digicertapi doc diff --git a/doc/ref/runners/all/salt.runners.config.rst b/doc/ref/runners/all/salt.runners.config.rst new file mode 100644 index 000000000000..cc8a4463bc89 --- /dev/null +++ b/doc/ref/runners/all/salt.runners.config.rst @@ -0,0 +1,6 @@ +=================== +salt.runners.config +=================== + +.. automodule:: salt.runners.config + :members: diff --git a/doc/ref/states/all/index.rst b/doc/ref/states/all/index.rst index d91dbc474a1f..9ecddac0fd2d 100644 --- a/doc/ref/states/all/index.rst +++ b/doc/ref/states/all/index.rst @@ -29,6 +29,7 @@ state modules blockdev boto3_elasticache boto3_route53 + boto3_sns boto_apigateway boto_asg boto_cfn @@ -53,6 +54,7 @@ state modules boto_lc boto_rds boto_route53 + boto_s3 boto_s3_bucket boto_secgroup boto_sns @@ -69,6 +71,7 @@ state modules cmd composer cron + cryptdev csf cyg ddns @@ -81,6 +84,7 @@ state modules docker_network docker_volume drac + dvs elasticsearch elasticsearch_index elasticsearch_index_template @@ -88,7 +92,10 @@ state modules eselect etcd_mod ethtool + esxcluster + esxdatacenter esxi + esxvm event file firewall @@ -98,6 +105,7 @@ state modules github glance glance_image + glassfish glusterfs gnomedesktop gpg @@ -113,6 +121,7 @@ state modules heat hg hipchat + highstate_doc host http icinga2 @@ -180,6 +189,10 @@ state modules mongodb_user monit mount + mssql_database + mssql_login + mssql_role + mssql_user msteams mysql_database mysql_grants @@ -196,6 +209,7 @@ state modules neutron_secgroup neutron_secgroup_rule neutron_subnet + nexus nfs_export nftables npm @@ -210,6 +224,8 @@ state modules pagerduty_schedule pagerduty_service pagerduty_user + panos + pbm pcs pecl pdbedit @@ -309,7 +325,9 @@ state modules win_system win_update win_wua + win_wusa winrepo + wordpress x509 xmpp zabbix_host @@ -317,6 +335,7 @@ state modules zabbix_mediatype zabbix_user zabbix_usergroup + zabbix_usermacro zcbuildout zenoss zk_concurrency diff --git a/doc/ref/states/all/salt.states.boto3_sns.rst b/doc/ref/states/all/salt.states.boto3_sns.rst new file mode 100644 index 000000000000..65248061d287 --- /dev/null +++ b/doc/ref/states/all/salt.states.boto3_sns.rst @@ -0,0 +1,5 @@ +salt.states.boto3_sns module +============================ + +.. automodule:: salt.states.boto3_sns + :members: diff --git a/doc/ref/states/all/salt.states.cryptdev.rst b/doc/ref/states/all/salt.states.cryptdev.rst new file mode 100644 index 000000000000..3672c9c90363 --- /dev/null +++ b/doc/ref/states/all/salt.states.cryptdev.rst @@ -0,0 +1,5 @@ +salt.states.cryptdev module +=========================== + +.. automodule:: salt.states.cryptdev + :members: diff --git a/doc/ref/states/all/salt.states.dvs.rst b/doc/ref/states/all/salt.states.dvs.rst new file mode 100644 index 000000000000..8b7887bb3fed --- /dev/null +++ b/doc/ref/states/all/salt.states.dvs.rst @@ -0,0 +1,5 @@ +salt.states.dvs module +====================== + +.. automodule:: salt.states.dvs + :members: diff --git a/doc/ref/states/all/salt.states.esxcluster.rst b/doc/ref/states/all/salt.states.esxcluster.rst new file mode 100644 index 000000000000..fd0baaf20827 --- /dev/null +++ b/doc/ref/states/all/salt.states.esxcluster.rst @@ -0,0 +1,5 @@ +salt.states.esxcluster module +============================= + +.. automodule:: salt.states.esxcluster + :members: diff --git a/doc/ref/states/all/salt.states.esxdatacenter.rst b/doc/ref/states/all/salt.states.esxdatacenter.rst new file mode 100644 index 000000000000..4ffaf2b65a35 --- /dev/null +++ b/doc/ref/states/all/salt.states.esxdatacenter.rst @@ -0,0 +1,5 @@ +salt.states.esxdatacenter module +================================ + +.. automodule:: salt.states.esxdatacenter + :members: diff --git a/doc/ref/states/all/salt.states.esxvm.rst b/doc/ref/states/all/salt.states.esxvm.rst new file mode 100644 index 000000000000..b20f6b060bcf --- /dev/null +++ b/doc/ref/states/all/salt.states.esxvm.rst @@ -0,0 +1,5 @@ +salt.states.esxvm module +======================== + +.. automodule:: salt.states.esxvm + :members: diff --git a/doc/ref/states/all/salt.states.glassfish.rst b/doc/ref/states/all/salt.states.glassfish.rst new file mode 100644 index 000000000000..663ccfdf95ff --- /dev/null +++ b/doc/ref/states/all/salt.states.glassfish.rst @@ -0,0 +1,5 @@ +salt.states.glassfish module +============================ + +.. automodule:: salt.states.glassfish + :members: diff --git a/doc/ref/states/all/salt.states.highstate_doc.rst b/doc/ref/states/all/salt.states.highstate_doc.rst new file mode 100644 index 000000000000..fbaee623a5d6 --- /dev/null +++ b/doc/ref/states/all/salt.states.highstate_doc.rst @@ -0,0 +1,5 @@ +salt.states.highstate_doc module +================================ + +.. automodule:: salt.states.highstate_doc + :members: diff --git a/doc/ref/states/all/salt.states.mssql_database.rst b/doc/ref/states/all/salt.states.mssql_database.rst new file mode 100644 index 000000000000..6e11650298bc --- /dev/null +++ b/doc/ref/states/all/salt.states.mssql_database.rst @@ -0,0 +1,5 @@ +salt.states.mssql_database module +================================= + +.. automodule:: salt.states.mssql_database + :members: diff --git a/doc/ref/states/all/salt.states.mssql_login.rst b/doc/ref/states/all/salt.states.mssql_login.rst new file mode 100644 index 000000000000..d579f056ca3f --- /dev/null +++ b/doc/ref/states/all/salt.states.mssql_login.rst @@ -0,0 +1,5 @@ +salt.states.mssql_login module +============================== + +.. automodule:: salt.states.mssql_login + :members: diff --git a/doc/ref/states/all/salt.states.mssql_role.rst b/doc/ref/states/all/salt.states.mssql_role.rst new file mode 100644 index 000000000000..48aef6908b0e --- /dev/null +++ b/doc/ref/states/all/salt.states.mssql_role.rst @@ -0,0 +1,5 @@ +salt.states.mssql_role module +============================= + +.. automodule:: salt.states.mssql_role + :members: diff --git a/doc/ref/states/all/salt.states.mssql_user.rst b/doc/ref/states/all/salt.states.mssql_user.rst new file mode 100644 index 000000000000..ac335693cebe --- /dev/null +++ b/doc/ref/states/all/salt.states.mssql_user.rst @@ -0,0 +1,5 @@ +salt.states.mssql_user module +============================= + +.. automodule:: salt.states.mssql_user + :members: diff --git a/doc/ref/states/all/salt.states.nexus.rst b/doc/ref/states/all/salt.states.nexus.rst new file mode 100644 index 000000000000..41e6aa415b35 --- /dev/null +++ b/doc/ref/states/all/salt.states.nexus.rst @@ -0,0 +1,5 @@ +salt.states.nexus module +======================== + +.. automodule:: salt.states.nexus + :members: diff --git a/doc/ref/states/all/salt.states.pbm.rst b/doc/ref/states/all/salt.states.pbm.rst new file mode 100644 index 000000000000..e5b2d9a6b67a --- /dev/null +++ b/doc/ref/states/all/salt.states.pbm.rst @@ -0,0 +1,5 @@ +salt.states.pbm module +====================== + +.. automodule:: salt.states.pbm + :members: diff --git a/doc/ref/states/all/salt.states.win_wusa.rst b/doc/ref/states/all/salt.states.win_wusa.rst new file mode 100644 index 000000000000..2d97fa0986bf --- /dev/null +++ b/doc/ref/states/all/salt.states.win_wusa.rst @@ -0,0 +1,5 @@ +salt.states.win_wusa module +=========================== + +.. automodule:: salt.states.win_wusa + :members: diff --git a/doc/ref/states/all/salt.states.wordpress.rst b/doc/ref/states/all/salt.states.wordpress.rst new file mode 100644 index 000000000000..ac5f78bd9699 --- /dev/null +++ b/doc/ref/states/all/salt.states.wordpress.rst @@ -0,0 +1,5 @@ +salt.states.wordpress module +============================ + +.. automodule:: salt.states.wordpress + :members: diff --git a/doc/ref/states/all/salt.states.zabbix_usermacro.rst b/doc/ref/states/all/salt.states.zabbix_usermacro.rst new file mode 100644 index 000000000000..08c758551a6f --- /dev/null +++ b/doc/ref/states/all/salt.states.zabbix_usermacro.rst @@ -0,0 +1,5 @@ +salt.states.zabbix_usermacro module +=================================== + +.. automodule:: salt.states.zabbix_usermacro + :members: diff --git a/salt/cloud/clouds/clc.py b/salt/cloud/clouds/clc.py index e3dff0ed8576..8ba249bf5d79 100644 --- a/salt/cloud/clouds/clc.py +++ b/salt/cloud/clouds/clc.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ''' CenturyLink Cloud Module -=================== +======================== .. versionadded:: Oyxgen @@ -29,9 +29,12 @@ For sdk reference see: https://github.com/CenturyLinkCloud/clc-python-sdk Flask -------- +----- + flask can be installed via pip: + .. code-block:: bash + pip install flask Configuration diff --git a/salt/cloud/clouds/packet.py b/salt/cloud/clouds/packet.py index 6c3396db2625..713f2b954262 100644 --- a/salt/cloud/clouds/packet.py +++ b/salt/cloud/clouds/packet.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ''' Packet Cloud Module Using Packet's Python API Client -=========================================== +==================================================== The Packet cloud module is used to control access to the Packet VPS system. @@ -13,17 +13,18 @@ Optional profile parameters: - - ``storage_size`` - min value is 10, defines Gigabytes of storage that will be attached to device. - - ``storage_tier`` - storage_1 - Standard Plan, storage_2 - Performance Plan - - ``snapshot_count`` - int - - ``snapshot_frequency`` - string - possible values: - - 1min - - 15min - - 1hour - - 1day - - 1week - - 1month - - 1year +- ``storage_size`` - min value is 10, defines Gigabytes of storage that will be attached to device. +- ``storage_tier`` - storage_1 - Standard Plan, storage_2 - Performance Plan +- ``snapshot_count`` - int +- ``snapshot_frequency`` - string - possible values: + + - 1min + - 15min + - 1hour + - 1day + - 1week + - 1month + - 1year This driver requires Packet's client library: https://pypi.python.org/pypi/packet-python @@ -516,7 +517,9 @@ def list_nodes(call=None): ''' Returns a list of devices, keeping only a brief listing. CLI Example: + .. code-block:: bash + salt-cloud -Q salt-cloud --query salt-cloud -f list_nodes packet-provider diff --git a/salt/cloud/clouds/saltify.py b/salt/cloud/clouds/saltify.py index e0e56349a057..d8c08c67833e 100644 --- a/salt/cloud/clouds/saltify.py +++ b/salt/cloud/clouds/saltify.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- ''' -.. _`saltify-module`: +.. _saltify-module: Saltify Module ============== diff --git a/salt/modules/gcp_addon.py b/salt/modules/gcp_addon.py index 6a587de4b506..a80cb672927b 100644 --- a/salt/modules/gcp_addon.py +++ b/salt/modules/gcp_addon.py @@ -11,7 +11,7 @@ This module will create a route to send traffic destined to the Internet through your gateway instance. -:codeauthor: :email:`Pratik Bandarkar ` +:codeauthor: `Pratik Bandarkar ` :maturity: new :depends: google-api-python-client :platform: Linux diff --git a/salt/modules/highstate_doc.py b/salt/modules/highstate_doc.py index 77a1d378480f..b9adcc1a1177 100644 --- a/salt/modules/highstate_doc.py +++ b/salt/modules/highstate_doc.py @@ -6,13 +6,13 @@ How it works: - `highstate or lowstate` data is parsed with a `proccesser` this defaults to `highstate_doc.proccesser_markdown`. - The proccessed data is passed to a `jinja` template that builds up the document content. +`highstate or lowstate` data is parsed with a `proccesser` this defaults to `highstate_doc.proccesser_markdown`. +The proccessed data is passed to a `jinja` template that builds up the document content. configuration: Pillar -.. code-block:: yaml +.. code-block:: none # the following defaults can be overrided highstate_doc.config: @@ -145,7 +145,7 @@ If you wish to customize the document format: -.. code-block:: yaml +.. code-block:: none # you could also create a new `proccesser` for perhaps reStructuredText # highstate_doc.config: @@ -178,40 +178,51 @@ - mode: '0640' -Some `replace_text_regex` values that might be helpful. - - ## CERTS - '-----BEGIN RSA PRIVATE KEY-----[\r\n\t\f\S]{0,2200}': 'XXXXXXX' - '-----BEGIN CERTIFICATE-----[\r\n\t\f\S]{0,2200}': 'XXXXXXX' - '-----BEGIN DH PARAMETERS-----[\r\n\t\f\S]{0,2200}': 'XXXXXXX' - '-----BEGIN PRIVATE KEY-----[\r\n\t\f\S]{0,2200}': 'XXXXXXX' - '-----BEGIN OPENSSH PRIVATE KEY-----[\r\n\t\f\S]{0,2200}': 'XXXXXXX' - 'ssh-rsa .* ': 'ssh-rsa XXXXXXX ' - 'ssh-dss .* ': 'ssh-dss XXXXXXX ' - ## DB - 'DB_PASS.*': 'DB_PASS = XXXXXXX' - '5432:*:*:.*': '5432:*:XXXXXXX' - "'PASSWORD': .*": "'PASSWORD': 'XXXXXXX'," - " PASSWORD '.*'": " PASSWORD 'XXXXXXX'" - 'PGPASSWORD=.* ': 'PGPASSWORD=XXXXXXX' - "_replication password '.*'": "_replication password 'XXXXXXX'" - ## OTHER - 'EMAIL_HOST_PASSWORD =.*': 'EMAIL_HOST_PASSWORD =XXXXXXX' - "net ads join -U '.*@MFCFADS.MATH.EXAMPLE.CA.* ": "net ads join -U '.*@MFCFADS.MATH.EXAMPLE.CA%XXXXXXX " - "net ads join -U '.*@NEXUS.EXAMPLE.CA.* ": "net ads join -U '.*@NEXUS.EXAMPLE.CA%XXXXXXX " - 'install-uptrack .* --autoinstall': 'install-uptrack XXXXXXX --autoinstall' - 'accesskey = .*': 'accesskey = XXXXXXX' - 'auth_pass .*': 'auth_pass XXXXXXX' - 'PSK "0x.*': 'PSK "0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' - 'SECRET_KEY.*': 'SECRET_KEY = XXXXXXX' - "password=.*": "password=XXXXXXX" - '.*': 'XXXXXXX' - '.*': 'XXXXXXX' - 'application.secret = ".*"': 'application.secret = "XXXXXXX"' - 'url = "postgres://.*"': 'url = "postgres://XXXXXXX"' - 'PASS_.*_PASS': 'PASS_XXXXXXX_PASS' - ## HTACCESS - ':{PLAIN}.*': ':{PLAIN}XXXXXXX' +Some `replace_text_regex` values that might be helpful:: + + CERTS + ----- + + ``'-----BEGIN RSA PRIVATE KEY-----[\\r\\n\\t\\f\\S]{0,2200}': 'XXXXXXX'`` + ``'-----BEGIN CERTIFICATE-----[\\r\\n\\t\\f\\S]{0,2200}': 'XXXXXXX'`` + ``'-----BEGIN DH PARAMETERS-----[\\r\\n\\t\\f\\S]{0,2200}': 'XXXXXXX'`` + ``'-----BEGIN PRIVATE KEY-----[\\r\\n\\t\\f\\S]{0,2200}': 'XXXXXXX'`` + ``'-----BEGIN OPENSSH PRIVATE KEY-----[\\r\\n\\t\\f\\S]{0,2200}': 'XXXXXXX'`` + ``'ssh-rsa .* ': 'ssh-rsa XXXXXXX '`` + ``'ssh-dss .* ': 'ssh-dss XXXXXXX '`` + + DB + -- + + ``'DB_PASS.*': 'DB_PASS = XXXXXXX'`` + ``'5432:*:*:.*': '5432:*:XXXXXXX'`` + ``"'PASSWORD': .*": "'PASSWORD': 'XXXXXXX',"`` + ``" PASSWORD '.*'": " PASSWORD 'XXXXXXX'"`` + ``'PGPASSWORD=.* ': 'PGPASSWORD=XXXXXXX'`` + ``"_replication password '.*'": "_replication password 'XXXXXXX'"`` + + OTHER + ----- + + ``'EMAIL_HOST_PASSWORD =.*': 'EMAIL_HOST_PASSWORD =XXXXXXX'`` + ``"net ads join -U '.*@MFCFADS.MATH.EXAMPLE.CA.* ": "net ads join -U '.*@MFCFADS.MATH.EXAMPLE.CA%XXXXXXX "`` + ``"net ads join -U '.*@NEXUS.EXAMPLE.CA.* ": "net ads join -U '.*@NEXUS.EXAMPLE.CA%XXXXXXX "`` + ``'install-uptrack .* --autoinstall': 'install-uptrack XXXXXXX --autoinstall'`` + ``'accesskey = .*': 'accesskey = XXXXXXX'`` + ``'auth_pass .*': 'auth_pass XXXXXXX'`` + ``'PSK "0x.*': 'PSK "0xXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'`` + ``'SECRET_KEY.*': 'SECRET_KEY = XXXXXXX'`` + ``"password=.*": "password=XXXXXXX"`` + ``'.*': 'XXXXXXX'`` + ``'.*': 'XXXXXXX'`` + ``'application.secret = ".*"': 'application.secret = "XXXXXXX"'`` + ``'url = "postgres://.*"': 'url = "postgres://XXXXXXX"'`` + ``'PASS_.*_PASS': 'PASS_XXXXXXX_PASS'`` + + HTACCESS + -------- + + ``':{PLAIN}.*': ':{PLAIN}XXXXXXX'`` ''' @@ -429,10 +440,12 @@ def render(jinja_template_text=None, jinja_template_function='highstate_doc.mark jinja_template_text: jinja text that the render uses to create the document. jinja_template_function: a salt module call that returns template text. - options: - highstate_doc.markdown_basic_jinja_template - highstate_doc.markdown_default_jinja_template - highstate_doc.markdown_full_jinja_template + + :options: + highstate_doc.markdown_basic_jinja_template + highstate_doc.markdown_default_jinja_template + highstate_doc.markdown_full_jinja_template + ''' config = _get_config(**kwargs) lowstates = proccess_lowstates(**kwargs) @@ -584,7 +597,7 @@ def proccesser_markdown(lowstate_item, config, **kwargs): This `lowstate_item_markdown` given a lowstate item, returns a dict like: - .. code-block:: yaml + .. code-block:: none vars: # the raw lowstate_item that was proccessed id: # the 'id' of the state. diff --git a/salt/modules/win_auditpol.py b/salt/modules/win_auditpol.py index 755b58aed4a8..892dc3a94e1a 100644 --- a/salt/modules/win_auditpol.py +++ b/salt/modules/win_auditpol.py @@ -169,6 +169,7 @@ def set_setting(name, value): CLI Example: .. code-block:: bash + # Set the state of the "Credential Validation" setting to Success and # Failure salt * auditpol.set_setting "Credential Validation" "Success and Failure" diff --git a/salt/pillar/extra_minion_data_in_pillar.py b/salt/pillar/extra_minion_data_in_pillar.py index bbedec68666d..2937c18465a8 100644 --- a/salt/pillar/extra_minion_data_in_pillar.py +++ b/salt/pillar/extra_minion_data_in_pillar.py @@ -11,7 +11,7 @@ Complete example in etc/salt/master ===================================== -.. code-block:: yaml +.. code-block:: none ext_pillar: - extra_minion_data_in_pillar: diff --git a/salt/pillar/rethinkdb_pillar.py b/salt/pillar/rethinkdb_pillar.py index 85d35af4ceb2..1a31a1fa6617 100644 --- a/salt/pillar/rethinkdb_pillar.py +++ b/salt/pillar/rethinkdb_pillar.py @@ -85,6 +85,7 @@ def ext_pillar(minion_id, Collect minion external pillars from a RethinkDB database Arguments: + * `table`: The RethinkDB table containing external pillar information. Defaults to ``'pillar'`` * `id_field`: Field in document containing the minion id. diff --git a/salt/proxy/esxcluster.py b/salt/proxy/esxcluster.py index 19a8bc4cf594..3c159db319a1 100644 --- a/salt/proxy/esxcluster.py +++ b/salt/proxy/esxcluster.py @@ -67,7 +67,7 @@ should be managed. Required. mechanism -^^^^^^^^ +^^^^^^^^^ The mechanism used to connect to the vCenter server. Supported values are ``userpass`` and ``sspi``. Required. @@ -91,7 +91,7 @@ User domain. Required if mechanism is ``sspi``. principal -^^^^^^^^ +^^^^^^^^^ Kerberos principal. Rquired if mechanism is ``sspi``. protocol diff --git a/salt/proxy/esxdatacenter.py b/salt/proxy/esxdatacenter.py index b360ce60f5cc..3933110c6c28 100644 --- a/salt/proxy/esxdatacenter.py +++ b/salt/proxy/esxdatacenter.py @@ -61,7 +61,7 @@ should be managed. Required. mechanism -^^^^^^^^ +^^^^^^^^^ The mechanism used to connect to the vCenter server. Supported values are ``userpass`` and ``sspi``. Required. @@ -85,7 +85,7 @@ User domain. Required if mechanism is ``sspi``. principal -^^^^^^^^ +^^^^^^^^^ Kerberos principal. Rquired if mechanism is ``sspi``. protocol diff --git a/salt/proxy/esxvm.py b/salt/proxy/esxvm.py index cbc8ca5f6b6a..d7cbb655035c 100644 --- a/salt/proxy/esxvm.py +++ b/salt/proxy/esxvm.py @@ -85,7 +85,7 @@ User realm domain. Required if mechanism is ``sspi``. principal -^^^^^^^^ +^^^^^^^^^ Kerberos principal. Rquired if mechanism is ``sspi``. protocol diff --git a/salt/proxy/vcenter.py b/salt/proxy/vcenter.py index 2adcba6adec0..d6c6df5a292c 100644 --- a/salt/proxy/vcenter.py +++ b/salt/proxy/vcenter.py @@ -2,8 +2,8 @@ ''' Proxy Minion interface module for managing VMWare vCenters. -:codeauthor: :email:`Rod McKenzie (roderick.mckenzie@morganstanley.com)` -:codeauthor: :email:`Alexandru Bleotu (alexandru.bleotu@morganstanley.com)` +:codeauthor: `Rod McKenzie (roderick.mckenzie@morganstanley.com)` +:codeauthor: `Alexandru Bleotu (alexandru.bleotu@morganstanley.com)` Dependencies ============ @@ -67,7 +67,7 @@ principal: proxytype -^^^^^^^^^ +--------- The ``proxytype`` key and value pair is critical, as it tells Salt which interface to load from the ``proxy`` directory in Salt's install hierarchy, or from ``/srv/salt/_proxy`` on the Salt Master (if you have created your @@ -75,47 +75,47 @@ ``vcenter``. vcenter -^^^^^^^ +------- The location of the VMware vCenter server (host of ip). Required username -^^^^^^^^ +-------- The username used to login to the vcenter, such as ``root``. Required only for userpass. mechanism -^^^^^^^^ +--------- The mechanism used to connect to the vCenter server. Supported values are ``userpass`` and ``sspi``. Required. passwords -^^^^^^^^^ +--------- A list of passwords to be used to try and login to the vCenter server. At least one password in this list is required if mechanism is ``userpass`` The proxy integration will try the passwords listed in order. domain -^^^^^^ +------ User domain. Required if mechanism is ``sspi`` principal -^^^^^^^^ +--------- Kerberos principal. Rquired if mechanism is ``sspi`` protocol -^^^^^^^^ +-------- If the vCenter is not using the default protocol, set this value to an alternate protocol. Default is ``https``. port -^^^^ +---- If the ESXi host is not using the default port, set this value to an alternate port. Default is ``443``. Salt Proxy ----------- +========== After your pillar is in place, you can test the proxy. The proxy can run on any machine that has network connectivity to your Salt Master and to the @@ -173,13 +173,13 @@ :mod:`Salt.modules.vsphere ` is a standard Salt execution module. - If you pull up the docs for it you'll see -that almost every function in the module takes credentials and a targets either -a vcenter or a host. When credentials and a host aren't passed, Salt runs commands -through ``pyVmomi`` against the local machine. If you wanted, you could run -functions from this module on any host where an appropriate version of -``pyVmomi`` is installed, and that host would reach out over the network -and communicate with the ESXi host. +If you pull up the docs for it you'll see that almost every function in the +module takes credentials and a targets either a vcenter or a host. When +credentials and a host aren't passed, Salt runs commands through ``pyVmomi`` +against the local machine. If you wanted, you could run functions from this +module on any host where an appropriate version of ``pyVmomi`` is installed, +and that host would reach out over the network and communicate with the ESXi +host. ''' # Import Python Libs diff --git a/salt/renderers/nacl.py b/salt/renderers/nacl.py index 5c05383666a8..f85ca84314ed 100644 --- a/salt/renderers/nacl.py +++ b/salt/renderers/nacl.py @@ -26,7 +26,7 @@ Using encrypted pillar ---------------------- +---------------------- To encrypt secrets, copy the public key to your local machine and run: diff --git a/salt/states/boto3_sns.py b/salt/states/boto3_sns.py index b70785943d82..ffd58d343f91 100644 --- a/salt/states/boto3_sns.py +++ b/salt/states/boto3_sns.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ''' Manage SNS Topics - +================= Create and destroy SNS topics. Be aware that this interacts with Amazon's services, and so may incur charges. @@ -40,13 +40,21 @@ - keyid: GKTADJGHEIQSXMKKRBJ08H - key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs - # Using a profile from pillars +Using a profile from pillars +^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: yaml + mytopic: boto3_sns.topic_present: - region: us-east-1 - profile: mysnsprofile - # Passing in a profile +Passing in a profile +^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: yaml + mytopic: boto3_sns.topic_present: - region: us-east-1 @@ -97,6 +105,7 @@ def topic_present(name, subscriptions=None, attributes=None, attributes Dictionary of attributes to set on the SNS topic Valid attribute keys are: + - Policy: the JSON serialization of the topic's access control policy - DisplayName: the human-readable name used in the "From" field for notifications to email and email-json endpoints diff --git a/salt/states/boto_s3.py b/salt/states/boto_s3.py index 49e77510cf6d..6081c16c01ea 100644 --- a/salt/states/boto_s3.py +++ b/salt/states/boto_s3.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ''' Manage S3 Resources -================= +=================== .. versionadded:: 2018.3.0 diff --git a/salt/states/cryptdev.py b/salt/states/cryptdev.py index 8178376784ea..59d48395d6bd 100644 --- a/salt/states/cryptdev.py +++ b/salt/states/cryptdev.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- ''' Opening of Encrypted Devices -======================= +============================ Ensure that an encrypted device is mapped with the `mapped` function: diff --git a/salt/states/dvs.py b/salt/states/dvs.py index 1ff39cde00eb..4bba15b83465 100644 --- a/salt/states/dvs.py +++ b/salt/states/dvs.py @@ -3,7 +3,7 @@ Manage VMware distributed virtual switches (DVSs) and their distributed virtual portgroups (DVportgroups). -:codeauthor: :email:`Alexandru Bleotu ` +:codeauthor: `Alexandru Bleotu ` Examples ======== @@ -121,6 +121,7 @@ --------- .. code-block:: python + 'security_policy': { 'allow_promiscuous': true, 'mac_changes': false, @@ -166,7 +167,6 @@ Dependencies ============ - - pyVmomi Python Module diff --git a/salt/states/esxdatacenter.py b/salt/states/esxdatacenter.py index ae83b4d37174..0a9b6adb8f13 100644 --- a/salt/states/esxdatacenter.py +++ b/salt/states/esxdatacenter.py @@ -2,7 +2,7 @@ ''' Salt states to create and manage VMware vSphere datacenters (datacenters). -:codeauthor: :email:`Alexandru Bleotu ` +:codeauthor: `Alexandru Bleotu ` Dependencies ============ @@ -32,6 +32,7 @@ Proxy minion configuration (connects passthrough to the vCenter): .. code-block:: yaml + proxy: proxytype: esxdatacenter datacenter: target_dc diff --git a/salt/states/glassfish.py b/salt/states/glassfish.py index 813f1e84a498..28a67cf99e5e 100644 --- a/salt/states/glassfish.py +++ b/salt/states/glassfish.py @@ -7,6 +7,7 @@ You can setup connection parameters like this .. code-block:: yaml + - server: - ssl: true - url: localhost diff --git a/salt/states/pbm.py b/salt/states/pbm.py index 836c95b807da..45d10b6dd930 100644 --- a/salt/states/pbm.py +++ b/salt/states/pbm.py @@ -11,67 +11,65 @@ .. code-block:: python -{ - "name": "salt_storage_policy" - "description": "Managed by Salt. Random capability values.", - "resource_type": "STORAGE", - "subprofiles": [ - { - "capabilities": [ - { - "setting": { - "type": "scalar", - "value": 2 + { + "name": "salt_storage_policy" + "description": "Managed by Salt. Random capability values.", + "resource_type": "STORAGE", + "subprofiles": [ + { + "capabilities": [ + { + "setting": { + "type": "scalar", + "value": 2 + }, + "namespace": "VSAN", + "id": "hostFailuresToTolerate" }, - "namespace": "VSAN", - "id": "hostFailuresToTolerate" - }, - { - "setting": { - "type": "scalar", - "value": 2 + { + "setting": { + "type": "scalar", + "value": 2 + }, + "namespace": "VSAN", + "id": "stripeWidth" }, - "namespace": "VSAN", - "id": "stripeWidth" - }, - { - "setting": { - "type": "scalar", - "value": true + { + "setting": { + "type": "scalar", + "value": true + }, + "namespace": "VSAN", + "id": "forceProvisioning" }, - "namespace": "VSAN", - "id": "forceProvisioning" - }, - { - "setting": { - "type": "scalar", - "value": 50 + { + "setting": { + "type": "scalar", + "value": 50 + }, + "namespace": "VSAN", + "id": "proportionalCapacity" }, - "namespace": "VSAN", - "id": "proportionalCapacity" - }, - { - "setting": { - "type": "scalar", - "value": 0 - }, - "namespace": "VSAN", - "id": "cacheReservation" - } - ], - "name": "Rule-Set 1: VSAN", - "force_provision": null - } - ], -} + { + "setting": { + "type": "scalar", + "value": 0 + }, + "namespace": "VSAN", + "id": "cacheReservation" + } + ], + "name": "Rule-Set 1: VSAN", + "force_provision": null + } + ], + } Dependencies ============ - - pyVmomi Python Module - pyVmomi ------- @@ -88,9 +86,9 @@ Python 2.7.9, or newer must be present. This is due to an upstream dependency in pyVmomi 6.0 that is not supported in Python versions 2.7 to 2.7.8. If the version of Python is not in the supported range, you will need to install an - earlier version of pyVmomi. See `Issue #29537`_ for more information. - -.. _Issue #29537: https://github.com/saltstack/salt/issues/29537 + earlier version of pyVmomi. See + `Issue #29537 ` for more + information. ''' # Import Python Libs diff --git a/tests/unit/test_doc.py b/tests/unit/test_doc.py index 6ce6159eb67a..250bfac3a65e 100644 --- a/tests/unit/test_doc.py +++ b/tests/unit/test_doc.py @@ -97,3 +97,342 @@ def test_check_for_doc_inline_markup(self): # test_ret should be empty, otherwise there are :doc: references present self.assertEqual(test_ret, {}) + + def _check_doc_files(self, module_skip, module_dir, doc_skip, module_doc_dir): + ''' + Ensure various salt modules have associated documentation + ''' + + salt_dir = RUNTIME_VARS.CODE_DIR + + # Build list of module files + module_files = [] + skip_module_files = module_skip + full_module_dir = os.path.join(salt_dir, *module_dir) + for file in os.listdir(full_module_dir): + if file.endswith(".py"): + module_name = os.path.splitext(file)[0] + if module_name not in skip_module_files: + module_files.append(module_name) + + # Build list of beacon documentation files + module_docs = [] + skip_doc_files = doc_skip + full_module_doc_dir = os.path.join(salt_dir, *module_doc_dir) + doc_prefix = '.'.join(module_dir) + '.' + for file in os.listdir(full_module_doc_dir): + if file.endswith(".rst"): + doc_name = os.path.splitext(file)[0] + if doc_name.startswith(doc_prefix): + doc_name = doc_name[len(doc_prefix):] + if doc_name not in skip_doc_files: + module_docs.append(doc_name) + + # Check that every beacon has associated documentaiton file + for module in module_files: + self.assertIn(module, + module_docs, + 'module file {0} is missing documentation in {1}'.format(module, + full_module_doc_dir)) + + for doc_file in module_docs: + self.assertIn(doc_file, + module_files, + 'Doc file {0} is missing associated module in {1}'.format(doc_file, + full_module_dir)) + + def test_auth_doc_files(self): + ''' + Ensure auth modules have associated documentation + + doc example: doc/ref/auth/all/salt.auth.rest.rst + auth module example: salt/auth/rest.py + ''' + + skip_files = ['__init__'] + module_dir = ['salt', 'auth'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'auth', 'all'] + self._check_doc_files(skip_files, module_dir, skip_doc_files, doc_dir) + + def test_beacon_doc_files(self): + ''' + Ensure beacon modules have associated documentation + + doc example: doc/ref/beacons/all/salt.beacon.rest.rst + beacon module example: salt/beacons/rest.py + ''' + + skip_files = ['__init__'] + module_dir = ['salt', 'beacons'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'beacons', 'all'] + self._check_doc_files(skip_files, module_dir, skip_doc_files, doc_dir) + + def test_cache_doc_files(self): + ''' + Ensure cache modules have associated documentation + + doc example: doc/ref/cache/all/salt.cache.consul.rst + cache module example: salt/cache/consul.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'cache'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'cache', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_cloud_doc_files(self): + ''' + Ensure cloud modules have associated documentation + + doc example: doc/ref/clouds/all/salt.cloud.gce.rst + cloud module example: salt/cloud/clouds/gce.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'cloud', 'clouds'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'clouds', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_engine_doc_files(self): + ''' + Ensure engine modules have associated documentation + + doc example: doc/ref/engines/all/salt.engines.docker_events.rst + engine module example: salt/engines/docker_events.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'engines'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'engines', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_fileserver_doc_files(self): + ''' + Ensure fileserver modules have associated documentation + + doc example: doc/ref/fileserver/all/salt.fileserver.gitfs.rst + module example: salt/fileserver/gitfs.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'fileserver'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'file_server', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_grain_doc_files(self): + ''' + Ensure grain modules have associated documentation + + doc example: doc/ref/grains/all/salt.grains.core.rst + module example: salt/grains/core.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'grains'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'grains', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_module_doc_files(self): + ''' + Ensure modules have associated documentation + + doc example: doc/ref/modules/all/salt.modules.zabbix.rst + execution module example: salt/modules/zabbix.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'modules'] + skip_doc_files = ['index', 'group', 'inspectlib', 'inspectlib.collector', 'inspectlib.dbhandle', + 'inspectlib.entities', 'inspectlib.exceptions', 'inspectlib.fsdb', + 'inspectlib.kiwiproc', 'inspectlib.query', 'kernelpkg', 'pkg', 'user'] + doc_dir = ['doc', 'ref', 'modules', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_output_doc_files(self): + ''' + Ensure output modules have associated documentation + + doc example: doc/ref/output/all/salt.output.highstate.rst + module example: salt/output/highstate.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'output'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'output', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_pillar_doc_files(self): + ''' + Ensure pillar modules have associated documentation + + doc example: doc/ref/pillar/all/salt.pillar.cobbler.rst + module example: salt/pillar/cobbler.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'pillar'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'pillar', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_proxy_doc_files(self): + ''' + Ensure proxy modules have associated documentation + + doc example: doc/ref/proxy/all/salt.proxy.docker.rst + module example: salt/proxy/docker.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'proxy'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'proxy', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_queues_doc_files(self): + ''' + Ensure queue modules have associated documentation + + doc example: doc/ref/queues/all/salt.queues.sqlite_queue.rst + module example: salt/queues/sqlite_queue.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'queues'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'queues', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_renderers_doc_files(self): + ''' + Ensure render modules have associated documentation + + doc example: doc/ref/renderers/all/salt.renderers.json.rst + module example: salt/renderers/json.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'renderers'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'renderers', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_returners_doc_files(self): + ''' + Ensure return modules have associated documentation + + doc example: doc/ref/returners/all/salt.returners.cassandra_return.rst + module example: salt/returners/cassandra_return.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'returners'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'returners', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_runners_doc_files(self): + ''' + Ensure runner modules have associated documentation + + doc example: doc/ref/runners/all/salt.runners.auth.rst + module example: salt/runners/auth.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'runners'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'runners', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_sdb_doc_files(self): + ''' + Ensure sdb modules have associated documentation + + doc example: doc/ref/sdb/all/salt.sdb.rest.rst + module example: salt/sdb/rest.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'sdb'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'sdb', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_serializers_doc_files(self): + ''' + Ensure serializer modules have associated documentation + + doc example: doc/ref/serializers/all/salt.serializers.yaml.rst + module example: salt/serializers/yaml.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'serializers'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'serializers', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_states_doc_files(self): + ''' + Ensure states have associated documentation + + doc example: doc/ref/states/all/salt.states.zabbix_host.rst + module example: salt/states/zabbix_host.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'states'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'states', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_thorium_doc_files(self): + ''' + Ensure thorium modules have associated documentation + + doc example: doc/ref/thorium/all/salt.thorium.calc.rst + module example: salt/thorium/calc.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'thorium'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'thorium', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_tops_doc_files(self): + ''' + Ensure top modules have associated documentation + + doc example: doc/ref/tops/all/salt.tops.saltclass.rst + module example: salt/tops/saltclass.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'tops'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'tops', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir) + + def test_wheel_doc_files(self): + ''' + Ensure wheel modules have associated documentation + + doc example: doc/ref/wheel/all/salt.wheel.key.rst + module example: salt/wheel/key.py + ''' + + skip_module_files = ['__init__'] + module_dir = ['salt', 'wheel'] + skip_doc_files = ['index', 'all'] + doc_dir = ['doc', 'ref', 'wheel', 'all'] + self._check_doc_files(skip_module_files, module_dir, skip_doc_files, doc_dir)