mirror of
https://github.com/ansible-collections/community.mysql.git
synced 2025-04-09 20:20:32 -07:00
[stable-2] Backport of all the doc PRs merged to main since the last backporting (#182)
* Add CONTRIBUTORS file (#166) (cherry picked from commitac927fdb08
) * Add documentation for privs with functions and procedures (#169) (cherry picked from commit6bce48e771
) * Update README.md (#168) * Update README.md * Fix * Add MAINTAINERS file (cherry picked from commit479edd81d1
) * Improve wording in README (#170) * Improve wording in README * Update README.md Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <jorge.rodriguez@tiriel.eu> Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <jorge.rodriguez@tiriel.eu> (cherry picked from commitc909aa2182
) * Update REVIEW_CHECKLIST.md (#171) (cherry picked from commit2236110bae
) * README: add a note how people can complain (#172) * README: add a note how people can complain * Change * Improve * Update README.md Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <jorge.rodriguez@tiriel.eu> Co-authored-by: Jorge Rodriguez (A.K.A. Tiriel) <jorge.rodriguez@tiriel.eu> (cherry picked from commitbe4e84a92a
) * README: fix typos (#174) (cherry picked from commit2a80c301a6
) * README.md: Add link to IRC (#175) (cherry picked from commit3335a95ba5
) * README.md, CONTRIBUTING.md: add links to the Maintainer guidelines (#179) (cherry picked from commit8fad3f85b8
) * Update README (#181) (cherry picked from commit6d9288d19b
) Co-authored-by: Alexander Skiba <ghostlyrics@gmail.com>
This commit is contained in:
parent
a68c83f7b5
commit
2e748efb02
6 changed files with 317 additions and 41 deletions
|
@ -4,6 +4,8 @@ We follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/comm
|
|||
|
||||
If you are a committer, also refer to the [Ansible committer guidelines](https://docs.ansible.com/ansible/devel/community/committer_guidelines.html).
|
||||
|
||||
If you are a maintainer / interested in becoming a maintainer of this collection, refer to the [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
|
||||
|
||||
## Issue tracker
|
||||
|
||||
Whether you are looking for an opportunity to contribute or you found a bug and already know how to solve it, please go to the [issue tracker](https://github.com/ansible-collections/community.mysql/issues).
|
||||
|
|
273
CONTRIBUTORS
Normal file
273
CONTRIBUTORS
Normal file
|
@ -0,0 +1,273 @@
|
|||
116davinder
|
||||
20
|
||||
28
|
||||
29
|
||||
4
|
||||
4n70w4
|
||||
abadger
|
||||
abondis
|
||||
acozine
|
||||
adamchainz
|
||||
adq
|
||||
Akasurde
|
||||
Alexander198961
|
||||
alustenberg
|
||||
aminvakil
|
||||
amitk79
|
||||
amree
|
||||
Andersson007
|
||||
andrewhowdencom
|
||||
ansibot
|
||||
anthonyxpalermo
|
||||
antonioribeiro
|
||||
apollo13
|
||||
aquach
|
||||
arcmop
|
||||
asad-at-srt
|
||||
AshDevilRed
|
||||
aurimasl
|
||||
axelll
|
||||
axisK
|
||||
azielke
|
||||
baldpale
|
||||
banyek
|
||||
BarbzYHOOL
|
||||
Berbe
|
||||
bjne
|
||||
bmalynovytch
|
||||
bmildren
|
||||
boreal321
|
||||
brutus
|
||||
burner1024
|
||||
calfonso
|
||||
candeira
|
||||
caphrim007
|
||||
cdalbergue
|
||||
checkphi
|
||||
chrismeyersfsu
|
||||
ChristopherGAndrews
|
||||
cmodijk
|
||||
codeaken
|
||||
codebymikey
|
||||
coreylane
|
||||
CormacBracken
|
||||
cosmix
|
||||
cptMikky
|
||||
crashes
|
||||
dagwieers
|
||||
damianmoore
|
||||
Davidffry
|
||||
denisemauldin
|
||||
diclophis
|
||||
d-lee
|
||||
dmp1ce
|
||||
dnelson
|
||||
dramaley
|
||||
drybjed
|
||||
drzraf
|
||||
DSpeichert
|
||||
dungdm93
|
||||
dwagelaar
|
||||
dylanjbarth
|
||||
einarc
|
||||
E-M
|
||||
eowin
|
||||
Ernest0x
|
||||
esamattis
|
||||
Everspace
|
||||
F21
|
||||
faitno
|
||||
felixfontein
|
||||
flatrocks
|
||||
fourjay
|
||||
fraff
|
||||
g00fy-
|
||||
geerlingguy
|
||||
georgeOsdDev
|
||||
ghjm
|
||||
ghost
|
||||
giacmir
|
||||
giorgio-v
|
||||
gkoller
|
||||
gottwald
|
||||
gstorme
|
||||
gundalow
|
||||
hansbaer
|
||||
hchargois
|
||||
hluaces
|
||||
hwali
|
||||
hyperfocus1338
|
||||
igormukhingmailcom
|
||||
imjoseangel
|
||||
infigoKriti
|
||||
ipergenitsa
|
||||
iredmail
|
||||
ivandigiusto
|
||||
jadbaz
|
||||
jaikdean
|
||||
jamescassell
|
||||
janosmiko
|
||||
jarnold-timeout
|
||||
JaSafieddine
|
||||
jborean93
|
||||
jctanner
|
||||
jean-christophe-manciot
|
||||
Jean-Daniel
|
||||
jgornick
|
||||
jhagg
|
||||
jhoekx
|
||||
jirib
|
||||
jkleckner
|
||||
jkordish
|
||||
jlaska
|
||||
Jmainguy
|
||||
jochu
|
||||
JoelFeiner
|
||||
johnavp1989
|
||||
jonatasbaldin
|
||||
Jorge-Rodriguez
|
||||
jpjaatin
|
||||
jpmens
|
||||
JSafieddine
|
||||
jsmartin
|
||||
juergenhoetzel
|
||||
jw34
|
||||
kalaisubbiah
|
||||
kenichi-ogawa-1988
|
||||
kkeane
|
||||
klingac
|
||||
kotso
|
||||
kuntalFreshBooks
|
||||
kurtdavis
|
||||
larsks
|
||||
ldesgrange
|
||||
leeadh
|
||||
LeonB
|
||||
leucos
|
||||
loomsen
|
||||
lorin
|
||||
lowwalker
|
||||
lperezs
|
||||
makmanalp
|
||||
manuelmorena
|
||||
MarcinOrlowski
|
||||
markdorison
|
||||
markotitel
|
||||
marktheunissen
|
||||
markuman
|
||||
mattclay
|
||||
matt-horwood-mayden
|
||||
mavimo
|
||||
maxamillion
|
||||
maxbube
|
||||
mcgoldrickm
|
||||
meanstrong
|
||||
meersjo
|
||||
megamisan
|
||||
michaeldg
|
||||
michalmedvecky
|
||||
MikeiLL
|
||||
milky-milk
|
||||
milosz
|
||||
mistaka0s
|
||||
mklassen
|
||||
mkrizek
|
||||
mmoya
|
||||
mohag
|
||||
mohsenSy
|
||||
mpdehaan
|
||||
MRwangyd
|
||||
mverwijs
|
||||
mvgrimes
|
||||
mysqlbox
|
||||
netmonk
|
||||
nhojpatrick
|
||||
nicolas-g
|
||||
NielsH
|
||||
nitinkansal1984
|
||||
nitzmahone
|
||||
Ompragash
|
||||
on
|
||||
order
|
||||
organman91
|
||||
p53
|
||||
pakal
|
||||
paulbadcock
|
||||
pennycoders
|
||||
petoju
|
||||
petracvv
|
||||
pgrenaud
|
||||
philfry
|
||||
pileofrogs
|
||||
pkaramol
|
||||
platypus-geek
|
||||
plumbeo
|
||||
pratikgadiya12
|
||||
pshanbhag
|
||||
r0bj
|
||||
rajsshah86
|
||||
reduzent
|
||||
relrod
|
||||
resmo
|
||||
ricco24
|
||||
richlv
|
||||
riupie
|
||||
rndmh3ro
|
||||
robertdebock
|
||||
robpblake
|
||||
rokka-n
|
||||
Roxyrob
|
||||
roysmith
|
||||
rthouvenin
|
||||
ruudk
|
||||
samccann
|
||||
samdoran
|
||||
sayap
|
||||
scottbrown
|
||||
seanorama
|
||||
sedrubal
|
||||
sergey-trukhin
|
||||
Shaps
|
||||
shrikeh
|
||||
sivel
|
||||
skalfyfan
|
||||
skoriy88
|
||||
sperantus
|
||||
spoyd
|
||||
steverweber
|
||||
steveteahan
|
||||
stijnopheide
|
||||
stintel
|
||||
stoned
|
||||
strixBE
|
||||
SWADESNA
|
||||
tapologo
|
||||
tejatsk14
|
||||
tersmitten
|
||||
the
|
||||
the02
|
||||
thomasliddledba
|
||||
time-palominodb
|
||||
timorunge
|
||||
Tomasthanes
|
||||
tomdymond
|
||||
Tronde
|
||||
tvlooy
|
||||
tyll
|
||||
UncertaintyP
|
||||
vamshi8
|
||||
vanne
|
||||
vdboor
|
||||
vmahadev
|
||||
v-zhuravlev
|
||||
webmat
|
||||
wedi
|
||||
whysthatso
|
||||
willthames
|
||||
windowsansiblernew
|
||||
wrosario
|
||||
xiata
|
||||
Xyon
|
||||
yangchao0512
|
||||
ziegenberg
|
||||
Zverik
|
3
MAINTAINERS
Normal file
3
MAINTAINERS
Normal file
|
@ -0,0 +1,3 @@
|
|||
bmalynovytch
|
||||
Jorge-Rodriguez
|
||||
Andersson007 (andersson007_ in #ansible-community IRC)
|
33
README.md
33
README.md
|
@ -1,6 +1,33 @@
|
|||
# MySQL collection for Ansible
|
||||
[](https://github.com/ansible-collections/community.mysql/actions?query=workflow%3A"Plugins+CI") [](https://github.com/ansible-collections/community.mysql/actions?query=workflow%3A"Roles+CI") [](https://codecov.io/gh/ansible-collections/community.mysql)
|
||||
|
||||
This collection is a part of Ansible package.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
We follow the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our interactions within this project.
|
||||
|
||||
If you encounter abusive behavior violating the [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html), please refer to the [policy violations](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html#policy-violations) section of the Code of Conduct for information on how to raise a complaint.
|
||||
|
||||
## Contributing
|
||||
|
||||
The content of this collection is made by [people](CONTRIBUTORS) like you.
|
||||
|
||||
Any kind of contribution is very welcome.
|
||||
|
||||
You don't know how to start? Refer to our [contribution guide](CONTRIBUTING.md)!
|
||||
|
||||
The current maintainers are listed in the [MAINTAINERS](MAINTAINERS) file. Don't hesitate to reach them out mentioning in the proposals. To learn how to maintain / become a maintainer of this collection, refer to the [Maintainer guidelines](https://github.com/ansible/community-docs/blob/main/maintaining.rst).
|
||||
|
||||
Join us on IRC in the ``ansible-community`` [irc.libera.chat](https://libera.chat/) channel.
|
||||
See the [Registration guide](https://libera.chat/guides/registration) to learn how to register.
|
||||
|
||||
## Governance
|
||||
|
||||
The process of decision making in this collection is based on discussing and finding consensus among participants.
|
||||
|
||||
Every voice is important and every idea is valuable. If you have something on your mind, create an issue or dedicated discussion and let's discuss it!
|
||||
|
||||
## Included content
|
||||
|
||||
- **Modules**:
|
||||
|
@ -20,7 +47,7 @@
|
|||
|
||||
## External requirements
|
||||
|
||||
The MySQL modules rely on a MySQL connector. The list of supported drivers is below:
|
||||
The MySQL modules rely on a MySQL connector. The list of supported drivers is below:
|
||||
|
||||
- [PyMySQL](https://github.com/PyMySQL/PyMySQL)
|
||||
- [MySQLdb](https://github.com/PyMySQL/mysqlclient-python)
|
||||
|
@ -46,10 +73,6 @@ collections:
|
|||
|
||||
See [Ansible Using collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html) for more details.
|
||||
|
||||
## Contributing
|
||||
|
||||
See the [contribution guide](CONTRIBUTING.md).
|
||||
|
||||
## Licensing
|
||||
|
||||
<!-- Include the appropriate license information here and a pointer to the full licensing details. If the collection contains modules migrated from the ansible/ansible repo, you must use the same license that existed in the ansible/ansible repo. See the GNU license example below. -->
|
||||
|
|
|
@ -1,38 +1,3 @@
|
|||
# Review Checklist
|
||||
|
||||
When reviewing, keep in mind that we follow [Ansible Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html) in all our contributions and interactions within this repository.
|
||||
|
||||
If you are a committer, also refer to the [Ansible committer guidelines](https://docs.ansible.com/ansible/devel/community/committer_guidelines.html).
|
||||
|
||||
**General tips**
|
||||
- Try to create a culture of collaboration when reviewing
|
||||
- Welcome the author and thank them for the pull request
|
||||
- When suggesting changes, try to use questions, not statements
|
||||
- When suggesting mandatory changes, do it as politely as possible providing documentation references
|
||||
- If your suggestion is optional or a matter of personal preferences, please say it explicitly
|
||||
- When asking for adding tests or for complex code refactoring, say that the author is welcome to ask for clarifications and help if they need
|
||||
- If somebody suggests a good idea, mention it or put a thumbs up
|
||||
- After merging, thank the author and reviewers for their time and effort
|
||||
|
||||
**Standards and documentation**
|
||||
- [ ] if the pull request is not a documentation fix, it must include a [changelog fragment](https://docs.ansible.com/ansible/devel/community/development_process.html#creating-a-changelog-fragment) - please check the format carefully
|
||||
- [ ] if new files are added with the pull request, they follow the [licensing rules](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#licensing)
|
||||
- [ ] the changes follow the [Ansible documentation standards](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_documenting.html) and the [style guide](https://docs.ansible.com/ansible/devel/dev_guide/style_guide/index.html#style-guide)
|
||||
- [ ] the changes follow the [development conventions](https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html)
|
||||
- [ ] if a new plugin is added, it is one of the [allowed plugin types](https://github.com/ansible-collections/overview/blob/main/collection_requirements.rst#modules-plugins)
|
||||
- [ ] documentation, examples, and return sections use FQCNs for the `M(..)` [format macros](https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#linking-and-other-format-macros-within-module-documentation) when referring to modules
|
||||
- [ ] modules and plugins from ansible-core use `ansible.builtin.` as a FQCN prefix when mentioned
|
||||
- [ ] when a new option, module, plugin, or return value is added, the corresponding documentation or return sections use `version_added:` containing the *collection* version which they will be first released in
|
||||
* this usually is the next minor release, sometimes the next major release (example: if 2.7.5 is the current release, the next minor release will be 2.8.0, and the next major release will be 3.0.0)
|
||||
- [ ] FQCNs are used for `extends_documentation_fragment:`, unless the author is referring to doc_fragments from ansible-core
|
||||
|
||||
**Tests (if applicable and technically possible to implement)**
|
||||
- [ ] the pull request has [integration tests](https://docs.ansible.com/ansible/devel/dev_guide/testing_integration.html)
|
||||
- [ ] the pull request has [unit tests](https://docs.ansible.com/ansible/devel/dev_guide/testing_units.html)
|
||||
- [ ] all changes are covered
|
||||
- [ ] integration tests also cover `check_mode` (if it is supported)
|
||||
- [ ] integration tests check an actual state of the system, not only what the module reports (for example, if the module changes a file, check that the file was actually changed by using the `ansible.builtin.stat` module)
|
||||
|
||||
**Other**
|
||||
- [ ] the pull request does not contain merge commits (see GitHub warnings at the bottom of the pull request) - in this case, ask the author to rebase the pull request branch
|
||||
- [ ] if the pull request contains breaking changes, ask the author and the collection maintainers if it is really needed and there is no way not to introduce them
|
||||
Refer to the [Collection review checklist](https://github.com/ansible/community-docs/blob/main/review_checklist.rst).
|
||||
|
|
|
@ -53,6 +53,7 @@ options:
|
|||
the module will always report changes. It includes grouping columns
|
||||
by permission (C(SELECT(col1,col2)) instead of C(SELECT(col1),SELECT(col2))).
|
||||
- Can be passed as a dictionary (see the examples).
|
||||
- Supports GRANTs for procedures and functions (see the examples).
|
||||
type: raw
|
||||
append_privs:
|
||||
description:
|
||||
|
@ -188,6 +189,15 @@ EXAMPLES = r'''
|
|||
'db1.*': 'ALL,GRANT'
|
||||
'db2.*': 'ALL,GRANT'
|
||||
|
||||
# Use 'PROCEDURE' instead of 'FUNCTION' to apply GRANTs for a MySQL procedure instead.
|
||||
- name: Grant a user the right to execute a function
|
||||
community.mysql.mysql_user:
|
||||
name: readonly
|
||||
password: 12345
|
||||
priv:
|
||||
FUNCTION my_db.my_function: EXECUTE
|
||||
state: present
|
||||
|
||||
# Note that REQUIRESSL is a special privilege that should only apply to *.* by itself.
|
||||
# Setting this privilege in this manner is deprecated.
|
||||
# Use 'tls_requires' instead.
|
||||
|
|
Loading…
Add table
Reference in a new issue