[new module] adding azure_rm_mysqlserver (#33566)
* adding azure_rm_mysqlserver * removed stupid semicolon * updates to azure_rm_mysqlserver * adding dependency * updates to azure_rm_mysqlserver * updates to azure_rm_mysqlserver * updates to azure_rm_mysqlserver * updates to azure_rm_mysqlserver * updates to azure_rm_mysqlserver * updates to azure_rm_mysqlserver * Updated dependencies
This commit is contained in:
Zim Kalinowski
Jordan Borean
parent
1a3db9377a
commit
dadeae3ce6
4 changed files with 460 additions and 0 deletions
360
lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py
Normal file
360
lib/ansible/modules/cloud/azure/azure_rm_mysqlserver.py
Normal file
|
|
@ -0,0 +1,360 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# Copyright (c) 2017 Zim Kalinowski, <zikalino@microsoft.com>
|
||||
#
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: azure_rm_mysqlserver
|
||||
version_added: "2.5"
|
||||
short_description: Manage MySQL Server instance.
|
||||
description:
|
||||
- Create, update and delete instance of MySQL Server.
|
||||
|
||||
options:
|
||||
resource_group:
|
||||
description:
|
||||
- The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
|
||||
required: True
|
||||
name:
|
||||
description:
|
||||
- The name of the server.
|
||||
required: True
|
||||
sku:
|
||||
description:
|
||||
- The SKU (pricing tier) of the server.
|
||||
suboptions:
|
||||
name:
|
||||
description:
|
||||
- The name of the sku, typically, a letter + Number code, e.g. P3.
|
||||
tier:
|
||||
description:
|
||||
- The tier of the particular SKU, e.g. Basic.
|
||||
choices: ['basic', 'standard']
|
||||
capacity:
|
||||
description:
|
||||
- "The scale up/out capacity, representing server's compute units."
|
||||
size:
|
||||
description:
|
||||
- The size code, to be interpreted by resource as appropriate.
|
||||
location:
|
||||
description:
|
||||
- Resource location. If not set, location from the resource group will be used as default.
|
||||
storage_mb:
|
||||
description:
|
||||
- The maximum storage allowed for a server.
|
||||
version:
|
||||
description:
|
||||
- Server version.
|
||||
choices: ['5.6', '5.7']
|
||||
enforce_ssl:
|
||||
description:
|
||||
- Enable SSL enforcement.
|
||||
type: bool
|
||||
default: False
|
||||
admin_username:
|
||||
description:
|
||||
- "The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation)."
|
||||
admin_password:
|
||||
description:
|
||||
- The password of the administrator login.
|
||||
|
||||
extends_documentation_fragment:
|
||||
- azure
|
||||
|
||||
author:
|
||||
- "Zim Kalinowski (@zikalino)"
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: Create (or update) MySQL Server
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: TestGroup
|
||||
name: testserver
|
||||
sku:
|
||||
name: MYSQLB50
|
||||
tier: Basic
|
||||
capacity: 100
|
||||
location: eastus
|
||||
storage_mb: 1024
|
||||
enforce_ssl: True
|
||||
admin_username: cloudsa
|
||||
admin_password: password
|
||||
'''
|
||||
|
||||
RETURN = '''
|
||||
id:
|
||||
description:
|
||||
- Resource ID
|
||||
returned: always
|
||||
type: str
|
||||
sample: /subscriptions/12345678-1234-1234-1234-123412341234/testrg/providers/Microsoft.DBforMySQL/servers/mysqlsrv1b6dd89593
|
||||
version:
|
||||
description:
|
||||
- Server version. Possible values include: C(5.6), C(5.7)
|
||||
returned: always
|
||||
type: str
|
||||
sample: 5.6
|
||||
state:
|
||||
description:
|
||||
- A state of a server that is visible to user. Possible values include: C(Ready), C(Dropping), C(Disabled)
|
||||
returned: always
|
||||
type: str
|
||||
sample: Ready
|
||||
fully_qualified_domain_name:
|
||||
description:
|
||||
- The fully qualified domain name of a server.
|
||||
returned: always
|
||||
type: str
|
||||
sample: mysqlsrv1b6dd89593.mysql.database.azure.com
|
||||
'''
|
||||
|
||||
import time
|
||||
from ansible.module_utils.azure_rm_common import AzureRMModuleBase
|
||||
|
||||
try:
|
||||
from msrestazure.azure_exceptions import CloudError
|
||||
from msrestazure.azure_operation import AzureOperationPoller
|
||||
from azure.mgmt.rdbms.mysql import MySQLManagementClient
|
||||
from msrest.serialization import Model
|
||||
except ImportError:
|
||||
# This is handled in azure_rm_common
|
||||
pass
|
||||
|
||||
|
||||
class Actions:
|
||||
NoAction, Create, Update, Delete = range(4)
|
||||
|
||||
|
||||
class AzureRMServers(AzureRMModuleBase):
|
||||
"""Configuration class for an Azure RM MySQL Server resource"""
|
||||
|
||||
def __init__(self):
|
||||
self.module_arg_spec = dict(
|
||||
resource_group=dict(
|
||||
type='str',
|
||||
required=True
|
||||
),
|
||||
name=dict(
|
||||
type='str',
|
||||
required=True
|
||||
),
|
||||
sku=dict(
|
||||
type='dict'
|
||||
),
|
||||
location=dict(
|
||||
type='str'
|
||||
),
|
||||
storage_mb=dict(
|
||||
type='int'
|
||||
),
|
||||
version=dict(
|
||||
type='str',
|
||||
choices=['5.6', '5.7']
|
||||
),
|
||||
enforce_ssl=dict(
|
||||
type='bool',
|
||||
default=False
|
||||
),
|
||||
create_mode=dict(
|
||||
type='str',
|
||||
default='Default'
|
||||
),
|
||||
admin_username=dict(
|
||||
type='str'
|
||||
),
|
||||
admin_password=dict(
|
||||
type='str',
|
||||
no_log=True
|
||||
),
|
||||
state=dict(
|
||||
type='str',
|
||||
default='present',
|
||||
choices=['present', 'absent']
|
||||
)
|
||||
)
|
||||
|
||||
self.resource_group = None
|
||||
self.name = None
|
||||
self.parameters = dict()
|
||||
|
||||
self.results = dict(changed=False)
|
||||
self.mgmt_client = None
|
||||
self.state = None
|
||||
self.to_do = Actions.NoAction
|
||||
|
||||
super(AzureRMServers, self).__init__(derived_arg_spec=self.module_arg_spec,
|
||||
supports_check_mode=True,
|
||||
supports_tags=False)
|
||||
|
||||
def exec_module(self, **kwargs):
|
||||
"""Main module execution method"""
|
||||
|
||||
for key in list(self.module_arg_spec.keys()):
|
||||
if hasattr(self, key):
|
||||
setattr(self, key, kwargs[key])
|
||||
elif kwargs[key] is not None:
|
||||
if key == "sku":
|
||||
ev = kwargs[key]
|
||||
if 'tier' in ev:
|
||||
if ev['tier'] == 'basic':
|
||||
ev['tier'] = 'Basic'
|
||||
elif ev['tier'] == 'standard':
|
||||
ev['tier'] = 'Standard'
|
||||
self.parameters["sku"] = ev
|
||||
elif key == "location":
|
||||
self.parameters["location"] = kwargs[key]
|
||||
elif key == "storage_mb":
|
||||
self.parameters.setdefault("properties", {})["storage_mb"] = kwargs[key]
|
||||
elif key == "version":
|
||||
self.parameters.setdefault("properties", {})["version"] = kwargs[key]
|
||||
elif key == "enforce_ssl":
|
||||
self.parameters.setdefault("properties", {})["ssl_enforcement"] = 'Enabled' if kwargs[key] else 'Disabled'
|
||||
elif key == "create_mode":
|
||||
self.parameters.setdefault("properties", {})["create_mode"] = kwargs[key]
|
||||
elif key == "admin_username":
|
||||
self.parameters.setdefault("properties", {})["administrator_login"] = kwargs[key]
|
||||
elif key == "admin_password":
|
||||
self.parameters.setdefault("properties", {})["administrator_login_password"] = kwargs[key]
|
||||
|
||||
old_response = None
|
||||
response = None
|
||||
|
||||
self.mgmt_client = self.get_mgmt_svc_client(MySQLManagementClient,
|
||||
base_url=self._cloud_environment.endpoints.resource_manager)
|
||||
|
||||
resource_group = self.get_resource_group(self.resource_group)
|
||||
|
||||
if "location" not in self.parameters:
|
||||
self.parameters["location"] = resource_group.location
|
||||
|
||||
old_response = self.get_mysqlserver()
|
||||
|
||||
if not old_response:
|
||||
self.log("MySQL Server instance doesn't exist")
|
||||
if self.state == 'absent':
|
||||
self.log("Old instance didn't exist")
|
||||
else:
|
||||
self.to_do = Actions.Create
|
||||
else:
|
||||
self.log("MySQL Server instance already exists")
|
||||
if self.state == 'absent':
|
||||
self.to_do = Actions.Delete
|
||||
elif self.state == 'present':
|
||||
self.log("Need to check if MySQL Server instance has to be deleted or may be updated")
|
||||
self.to_do = Actions.Update
|
||||
|
||||
if (self.to_do == Actions.Create) or (self.to_do == Actions.Update):
|
||||
self.log("Need to Create / Update the MySQL Server instance")
|
||||
|
||||
if self.check_mode:
|
||||
self.results['changed'] = True
|
||||
return self.results
|
||||
|
||||
response = self.create_update_mysqlserver()
|
||||
|
||||
if not old_response:
|
||||
self.results['changed'] = True
|
||||
else:
|
||||
self.results['changed'] = old_response.__ne__(response)
|
||||
self.log("Creation / Update done")
|
||||
elif self.to_do == Actions.Delete:
|
||||
self.log("MySQL Server instance deleted")
|
||||
self.results['changed'] = True
|
||||
|
||||
if self.check_mode:
|
||||
return self.results
|
||||
|
||||
self.delete_mysqlserver()
|
||||
# make sure instance is actually deleted, for some Azure resources, instance is hanging around
|
||||
# for some time after deletion -- this should be really fixed in Azure
|
||||
while self.get_mysqlserver():
|
||||
time.sleep(20)
|
||||
else:
|
||||
self.log("MySQL Server instance unchanged")
|
||||
self.results['changed'] = False
|
||||
response = old_response
|
||||
|
||||
if response:
|
||||
self.results["id"] = response["id"]
|
||||
self.results["version"] = response["version"]
|
||||
self.results["state"] = response["user_visible_state"]
|
||||
self.results["fully_qualified_domain_name"] = response["fully_qualified_domain_name"]
|
||||
|
||||
return self.results
|
||||
|
||||
def create_update_mysqlserver(self):
|
||||
'''
|
||||
Creates or updates MySQL Server with the specified configuration.
|
||||
|
||||
:return: deserialized MySQL Server instance state dictionary
|
||||
'''
|
||||
self.log("Creating / Updating the MySQL Server instance {0}".format(self.name))
|
||||
|
||||
try:
|
||||
response = self.mgmt_client.servers.create_or_update(resource_group_name=self.resource_group,
|
||||
server_name=self.name,
|
||||
parameters=self.parameters)
|
||||
if isinstance(response, AzureOperationPoller):
|
||||
response = self.get_poller_result(response)
|
||||
|
||||
except CloudError as exc:
|
||||
self.log('Error attempting to create the MySQL Server instance.')
|
||||
self.fail("Error creating the MySQL Server instance: {0}".format(str(exc)))
|
||||
return response.as_dict()
|
||||
|
||||
def delete_mysqlserver(self):
|
||||
'''
|
||||
Deletes specified MySQL Server instance in the specified subscription and resource group.
|
||||
|
||||
:return: True
|
||||
'''
|
||||
self.log("Deleting the MySQL Server instance {0}".format(self.name))
|
||||
try:
|
||||
response = self.mgmt_client.servers.delete(resource_group_name=self.resource_group,
|
||||
server_name=self.name)
|
||||
except CloudError as e:
|
||||
self.log('Error attempting to delete the MySQL Server instance.')
|
||||
self.fail("Error deleting the MySQL Server instance: {0}".format(str(e)))
|
||||
|
||||
return True
|
||||
|
||||
def get_mysqlserver(self):
|
||||
'''
|
||||
Gets the properties of the specified MySQL Server.
|
||||
|
||||
:return: deserialized MySQL Server instance state dictionary
|
||||
'''
|
||||
self.log("Checking if the MySQL Server instance {0} is present".format(self.name))
|
||||
found = False
|
||||
try:
|
||||
response = self.mgmt_client.servers.get(resource_group_name=self.resource_group,
|
||||
server_name=self.name)
|
||||
found = True
|
||||
self.log("Response : {0}".format(response))
|
||||
self.log("MySQL Server instance : {0} found".format(response.name))
|
||||
except CloudError as e:
|
||||
self.log('Did not find the MySQL Server instance.')
|
||||
if found is True:
|
||||
return response.as_dict()
|
||||
|
||||
return False
|
||||
|
||||
|
||||
def main():
|
||||
"""Main execution"""
|
||||
AzureRMServers()
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
3
test/integration/targets/azure_rm_mysqlserver/aliases
Normal file
3
test/integration/targets/azure_rm_mysqlserver/aliases
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
cloud/azure
|
||||
destructive
|
||||
posix/ci/cloud/group2/azure
|
||||
|
|
@ -0,0 +1,2 @@
|
|||
dependencies:
|
||||
- setup_azure
|
||||
95
test/integration/targets/azure_rm_mysqlserver/tasks/main.yml
Normal file
95
test/integration/targets/azure_rm_mysqlserver/tasks/main.yml
Normal file
|
|
@ -0,0 +1,95 @@
|
|||
- name: Prepare random number
|
||||
set_fact:
|
||||
rpfx: "{{ resource_group | hash('md5') | truncate(7, True, '') }}{{ 1000 | random }}"
|
||||
run_once: yes
|
||||
|
||||
- name: Create instance of MySQL Server -- check mode
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "mysqlsrv{{ rpfx }}"
|
||||
sku:
|
||||
name: MYSQLB50
|
||||
tier: basic
|
||||
location: westus
|
||||
version: 5.6
|
||||
enforce_ssl: True
|
||||
admin_username: zimxyz
|
||||
admin_password: Testpasswordxyz12!
|
||||
check_mode: yes
|
||||
register: output
|
||||
- name: Assert the resource instance is well created
|
||||
assert:
|
||||
that:
|
||||
- output.changed
|
||||
|
||||
- name: Create instance of MySQL Server
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "mysqlsrv{{ rpfx }}"
|
||||
sku:
|
||||
name: MYSQLB50
|
||||
tier: basic
|
||||
location: westus
|
||||
version: 5.6
|
||||
enforce_ssl: True
|
||||
admin_username: zimxyz
|
||||
admin_password: Testpasswordxyz12!
|
||||
register: output
|
||||
- name: Assert the resource instance is well created
|
||||
assert:
|
||||
that:
|
||||
- output.changed
|
||||
- output.state == 'Ready'
|
||||
|
||||
- name: Create again instance of MySQL Server
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "mysqlsrv{{ rpfx }}"
|
||||
sku:
|
||||
name: MYSQLB50
|
||||
tier: basic
|
||||
location: westus
|
||||
version: 5.6
|
||||
enforce_ssl: True
|
||||
admin_username: zimxyz
|
||||
admin_password: Testpasswordxyz12!
|
||||
register: output
|
||||
- name: Assert the state has not changed
|
||||
assert:
|
||||
that:
|
||||
- output.changed == false
|
||||
- output.state == 'Ready'
|
||||
|
||||
- name: Delete instance of MySQL Server -- check mode
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "mysqlsrv{{ rpfx }}"
|
||||
state: absent
|
||||
check_mode: yes
|
||||
register: output
|
||||
- name: Assert the state has changed
|
||||
assert:
|
||||
that:
|
||||
- output.changed
|
||||
|
||||
- name: Delete instance of MySQL Server
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "mysqlsrv{{ rpfx }}"
|
||||
state: absent
|
||||
register: output
|
||||
- name: Assert the state has changed
|
||||
assert:
|
||||
that:
|
||||
- output.changed
|
||||
|
||||
- name: Delete unexisting instance of MySQL Server
|
||||
azure_rm_mysqlserver:
|
||||
resource_group: "{{ resource_group }}"
|
||||
name: "mysqlsrv{{ rpfx }}"
|
||||
state: absent
|
||||
register: output
|
||||
- name: Assert the state has changed
|
||||
assert:
|
||||
that:
|
||||
- output.changed == false
|
||||
Loading…
Reference in a new issue