#81 Cockrach DB Modules

.codacy.yml

@@ -1,4 +1,6 @@
 ---
 engines:
   pylint:
-    python_version: 3
+    python_version: 3
+exclude_paths:
+  - "plugins/modules/cockroach_**" # should be removed once cockroach modules are tested

README.md

@@ -296,6 +296,13 @@ Name | Description
 [community.missing_collection.checkly_snippets_info](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.checkly_snippets_info_module.rst)|Get information about checkly snippets.
 [community.missing_collection.checkly_variables](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.checkly_variables_module.rst)|Management of the checkly environment variables.
 [community.missing_collection.checkly_variables_info](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.checkly_variables_info_module.rst)|Get information about checkly environment variables.
+[community.missing_collection.cockroach_cert](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_cert_module.rst)|Manage user certificates in a cockroach cluster
+[community.missing_collection.cockroach_cluster](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_cluster_module.rst)|Manage a cockroach cluster
+[community.missing_collection.cockroach_cluster_settings](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_cluster_settings_module.rst)|Manage settings in a Cockroach cluster
+[community.missing_collection.cockroach_db](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_db_module.rst)|Manage databases in a cockroach cluster
+[community.missing_collection.cockroach_info](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_info_module.rst)|Returns facts about a Cockroach Cluster
+[community.missing_collection.cockroach_privs](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_privs_module.rst)|Manage user privileges in a cockroach db
+[community.missing_collection.cockroach_user](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.cockroach_user_module.rst)|Manage users in a cockroach cluster
 [community.missing_collection.consul_coordinate_info](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.consul_coordinate_info_module.rst)|Get information from Consul (Coordinate).
 [community.missing_collection.consul_health](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.consul_health_module.rst)|Get information from Consul (Health).
 [community.missing_collection.consul_members](https://github.com/116davinder/ansible.missing_collection/blob/master/docs/community.missing_collection.consul_members_module.rst)|Get information from Consul (Members).

docs/community.missing_collection.cockroach_cert_module.rst

@@ -0,0 +1,79 @@
+.. _community.missing_collection.cockroach_cert_module:
+
+
+*******************************************
+community.missing_collection.cockroach_cert
+*******************************************
+
+**Manage user certificates in a cockroach cluster**
+
+
+Version added: 0.4.0
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+- Manage user certificates in a cockroach cluster
+
+
+
+
+Parameters
+----------
+
+.. raw:: html
+
+    <table  border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Parameter</th>
+            <th>Choices/<font color="blue">Defaults</font></th>
+            <th width="100%">Comments</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>name</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">-</span>
+                         / <span style="color: red">required</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"None"</div>
+                </td>
+                <td>
+                        <div>The name of the user to generate certificate for</div>
+                </td>
+            </tr>
+    </table>
+    <br/>
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml
+
+    - name: create a certificate for a user
+      cockroach_cert:
+        name: user1
+        path: "/var/lib/cockroach"
+
+
+
+
+Status
+------
+
+
+Authors
+~~~~~~~
+
+- Oscar C, based on the work of Mikael Sandstrom, [email protected], @oravirt

docs/community.missing_collection.cockroach_cluster_module.rst

@@ -0,0 +1,88 @@
+.. _community.missing_collection.cockroach_cluster_module:
+
+
+**********************************************
+community.missing_collection.cockroach_cluster
+**********************************************
+
+**Manage a cockroach cluster**
+
+
+Version added: 0.4.0
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+- Manage a cockroach cluster
+
+
+
+
+Parameters
+----------
+
+.. raw:: html
+
+    <table  border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Parameter</th>
+            <th>Choices/<font color="blue">Defaults</font></th>
+            <th width="100%">Comments</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>name</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">-</span>
+                         / <span style="color: red">required</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"None"</div>
+                </td>
+                <td>
+                        <div>The name of the service</div>
+                </td>
+            </tr>
+    </table>
+    <br/>
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml
+
+    - name: create a master node
+      cockroach_cluster:
+        path: "/var/lib/cockroach"
+        host: "{{ inventory_hostname }}"
+        state: started
+
+    - name: join a node to a cluster
+      cockroach_cluster:
+        path: "/var/lib/cockroach"
+        host: "{{ inventory_hostname }}"
+        join: true
+        cluster_master: "node1:{{ port }}"
+        state: started
+
+
+
+
+Status
+------
+
+
+Authors
+~~~~~~~
+
+- Mikael Sandström, [email protected], @oravirt

docs/community.missing_collection.cockroach_cluster_settings_module.rst

@@ -0,0 +1,99 @@
+.. _community.missing_collection.cockroach_cluster_settings_module:
+
+
+*******************************************************
+community.missing_collection.cockroach_cluster_settings
+*******************************************************
+
+**Manage settings in a Cockroach cluster**
+
+
+Version added: 0.4.0
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+- Manage settings in a Cockroach cluster
+
+
+
+
+Parameters
+----------
+
+.. raw:: html
+
+    <table  border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Parameter</th>
+            <th>Choices/<font color="blue">Defaults</font></th>
+            <th width="100%">Comments</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>name</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">-</span>
+                         / <span style="color: red">required</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"None"</div>
+                </td>
+                <td>
+                        <div>The name of the setting</div>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>value</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">-</span>
+                         / <span style="color: red">required</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"None"</div>
+                </td>
+                <td>
+                        <div>The value of the setting</div>
+                </td>
+            </tr>
+    </table>
+    <br/>
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml
+
+    - name: manage a setting
+      cockroach_cluster_settings:
+        name: 'diagnostics.reporting.enabled'
+        value: False
+        path: /var/lib/cockroach
+        host: "{{ inventory_hostname }}"
+        state: present
+
+
+
+
+Status
+------
+
+
+Authors
+~~~~~~~
+
+- Mikael Sandström, [email protected], @oravirt

docs/community.missing_collection.cockroach_db_module.rst

@@ -0,0 +1,80 @@
+.. _community.missing_collection.cockroach_db_module:
+
+
+*****************************************
+community.missing_collection.cockroach_db
+*****************************************
+
+**Manage databases in a cockroach cluster**
+
+
+Version added: 0.4.0
+
+.. contents::
+   :local:
+   :depth: 1
+
+
+Synopsis
+--------
+- Manage databases in a cockroach cluster
+
+
+
+
+Parameters
+----------
+
+.. raw:: html
+
+    <table  border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Parameter</th>
+            <th>Choices/<font color="blue">Defaults</font></th>
+            <th width="100%">Comments</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>name</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">-</span>
+                         / <span style="color: red">required</span>
+                    </div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"None"</div>
+                </td>
+                <td>
+                        <div>The name of the database</div>
+                </td>
+            </tr>
+    </table>
+    <br/>
+
+
+
+
+Examples
+--------
+
+.. code-block:: yaml
+
+    # Create a database
+    cockroach_db: name=db1 path=/var/lib/cockroach host={{ inventory_hostname }} state=present
+
+    # Drop a database
+    cockroach_db: name=db1 path=/var/lib/cockroach host={{ inventory_hostname }} state=absent
+
+
+
+
+Status
+------
+
+
+Authors
+~~~~~~~
+
+- Mikael Sandstrom, [email protected], @oravirt