cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[new module] adding azure_rm_postgresqlserver (#33569)

Browse source 
* adding azure_rm_postgresqlserver

* removed semicolon placed by mistake

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* updates to azure_rm_postgresqlserver

* Updated dependencies
This commit is contained in:
Zim Kalinowski 2018-01-10 12:39:26 +08:00 committed by Jordan Borean
parent 9cb0c08d75
commit 1a3db9377a
6 changed files with 468 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

365
lib/ansible/modules/cloud/azure/azure_rm_postgresqlserver.py Normal file
View file

@ -0,0 +1,365 @@
#!/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_postgresqlserver
version_added: "2.5"
short_description: Manage PostgreSQL Server instance.
description:
- Create, update and delete instance of PostgreSQL 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: ['9.5', '9.6']
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) PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: TestGroup
name: testserver
sku:
name: PGSQLS100
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/resourceGroups/samplerg/providers/Microsoft.DBforPostgreSQL/servers/mysqlsrv1b6dd89593
version:
description:
- Server version. Possible values include: C(9.5), C(9.6)
returned: always
type: str
sample: 9.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: postgresqlsrv1b6dd89593.postgresql.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.postgresql import PostgreSQLManagementClient
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 PostgreSQL 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=['9.5', '9.6']
),
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(PostgreSQLManagementClient,
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_postgresqlserver()
if not old_response:
self.log("PostgreSQL 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("PostgreSQL Server instance already exists")
if self.state == 'absent':
self.to_do = Actions.Delete
elif self.state == 'present':
self.log("Need to check if PostgreSQL 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 PostgreSQL Server instance")
if self.check_mode:
self.results['changed'] = True
return self.results
response = self.create_update_postgresqlserver()
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("PostgreSQL Server instance deleted")
self.results['changed'] = True
if self.check_mode:
return self.results
self.delete_postgresqlserver()
# 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_postgresqlserver():
time.sleep(20)
else:
self.log("PostgreSQL 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_postgresqlserver(self):
'''
Creates or updates PostgreSQL Server with the specified configuration.
:return: deserialized PostgreSQL Server instance state dictionary
'''
self.log("Creating / Updating the PostgreSQL Server instance {0}".format(self.name))
try:
if self.to_do == Actions.Create:
response = self.mgmt_client.servers.create(resource_group_name=self.resource_group,
server_name=self.name,
parameters=self.parameters)
else:
response = self.mgmt_client.servers.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 PostgreSQL Server instance.')
self.fail("Error creating the PostgreSQL Server instance: {0}".format(str(exc)))
return response.as_dict()
def delete_postgresqlserver(self):
'''
Deletes specified PostgreSQL Server instance in the specified subscription and resource group.
:return: True
'''
self.log("Deleting the PostgreSQL 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 PostgreSQL Server instance.')
self.fail("Error deleting the PostgreSQL Server instance: {0}".format(str(e)))
return True
def get_postgresqlserver(self):
'''
Gets the properties of the specified PostgreSQL Server.
:return: deserialized PostgreSQL Server instance state dictionary
'''
self.log("Checking if the PostgreSQL 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("PostgreSQL Server instance : {0} found".format(response.name))
except CloudError as e:
self.log('Did not find the PostgreSQL Server instance.')
if found is True:
return response.as_dict()
return False
def main():
"""Main execution"""
AzureRMServers()
if __name__ == '__main__':
main()

2
packaging/requirements/requirements-azure.txt
View file

@ -15,3 +15,5 @@ azure-mgmt-sql>=0.7.1,<0.8
azure-mgmt-web>=0.32.0,<0.33
azure-mgmt-containerservice>=2.0.0,<3.0.0
azure-mgmt-containerregistry>=1.0.1
azure-mgmt-rdbms>=0.2.0rc1,<0.3.0

3
test/integration/targets/azure_rm_postgresqlserver/aliases Normal file
View file

@ -0,0 +1,3 @@
cloud/azure
destructive
posix/ci/cloud/group2/azure

2
test/integration/targets/azure_rm_postgresqlserver/meta/main.yml Normal file
View file

@ -0,0 +1,2 @@
dependencies:
- setup_azure

92
test/integration/targets/azure_rm_postgresqlserver/tasks/main.yml Normal file
View file

@ -0,0 +1,92 @@
- name: Prepare random number
set_fact:
rpfx: "{{ resource_group | hash('md5') | truncate(7, True, '') }}{{ 1000 | random }}"
run_once: yes
- name: Create instance of PostgreSQL Server -- check mode
azure_rm_postgresqlserver:
resource_group: "{{ resource_group }}"
name: "postgresqlsrv{{ rpfx }}"
sku:
name: PGSQLS100
tier: basic
location: westus
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 PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: "{{ resource_group }}"
name: "postgresqlsrv{{ rpfx }}"
sku:
name: PGSQLS100
tier: basic
location: westus
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 PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: "{{ resource_group }}"
name: "postgresqlsrv{{ rpfx }}"
sku:
name: PGSQLS100
tier: basic
location: westus
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 PostgreSQL Server -- check mode
azure_rm_postgresqlserver:
resource_group: "{{ resource_group }}"
name: "postgresqlsrv{{ rpfx }}"
state: absent
check_mode: yes
register: output
- name: Assert the state has changed
assert:
that:
- output.changed
- name: Delete instance of PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: "{{ resource_group }}"
name: "postgresqlsrv{{ rpfx }}"
state: absent
register: output
- name: Assert the state has changed
assert:
that:
- output.changed
- name: Delete unexisting instance of PostgreSQL Server
azure_rm_postgresqlserver:
resource_group: "{{ resource_group }}"
name: "postgresqlsrv{{ rpfx }}"
state: absent
register: output
- name: Assert the state has changed
assert:
that:
- output.changed == false

2
test/runner/requirements/integration.cloud.azure.txt
View file

@ -15,3 +15,5 @@ azure-mgmt-sql>=0.7.1,<0.8
azure-mgmt-web>=0.32.0,<0.33
azure-mgmt-containerservice>=2.0.0,<3.0.0
azure-mgmt-containerregistry>=1.0.1
azure-mgmt-rdbms>=0.2.0rc1,<0.3.0