improve (rds): modify rds instance and database #205

lixue323 · 2019-11-28T03:51:30Z

No description provided.

xiaozhu36 · 2019-12-11T06:30:04Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

@@ -0,0 +1,251 @@
+#!/usr/bin/python
+# Copyright (c) 2017 Alibaba Group Holding Limited. He Guimin <[email protected]>


xiaozhu36 · 2019-12-11T06:30:21Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+DOCUMENTATION = '''
+---
+module: ali_rds_database
+version_added: "1.5.0"


版本跟其他的一样

xiaozhu36 · 2019-12-11T06:31:11Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    description:
+      - The state of the instance after operating.
+    default: 'present'
+    choices: ['present', 'restart', 'absent']


需要restart么？

xiaozhu36 · 2019-12-11T06:31:25Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    choices: ['present', 'restart', 'absent']
+  db_instance_id:
+    description:
+      - rds instance id. Required when C(state=present).


加一个alias：instance_id

xiaozhu36 · 2019-12-11T06:32:39Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+---
+module: ali_rds_database
+version_added: "1.5.0"
+short_description: Create, Restart or Terminate an Instance in RDS.


这个描述跟这个module不符吧

xiaozhu36 · 2019-12-11T07:01:58Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    aliases: ['target_id']
+  db_names:
+    description:
+      - when copy databases between instances, format: {"source instance database name": "target instance database name"}.


source instance database name 不就是当前的db name么？

xiaozhu36 · 2019-12-11T07:02:32Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+  roles:
+    - vpc
+    - vswitch
+    - rds


这个是得又role的情况下才能这么些，不是所有的用户都有这个

xiaozhu36 · 2019-12-11T07:03:06Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+'''
+
+RETURN = '''
+instance:


合格return完全跟当前module不符啊，看下其他的return怎么写的

xiaozhu36 · 2019-12-11T07:04:16Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    for db in rds.describe_databases(db_instance_id=modules.params['db_instance_id']):
+        if db.name == name:
+            match = db
+    return match


要在文档中说清楚哪些字段来保证module的幂等

xiaozhu36 · 2019-12-11T07:05:00Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

@@ -0,0 +1,219 @@
+#!/usr/bin/python


后面的modudle都先按照上面的review改，改完后在review

xiaozhu36 · 2019-12-11T07:06:00Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+        db_description: create for ansible test
+        state: present
+
+    - name: Get the existing db


看下别的module的example是怎么写的

xiaozhu36 · 2019-12-17T03:44:47Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+      - database name. It must be 2 to 64 characters in length.It must start with a lowercase letter and end with a 
+        lowercase letter or digit. It can contain lowercase letters, digits, underscores (_), and hyphens (-). 
+        The database name must be unique whithin the instance.
+        For more information about invalid characters, see Forbidden keywords table(https://www.alibabacloud.com/help/doc-detail/26317.htm?spm=a2c63.p38356.879954.8.617de6d58lT07x#reference-pwh-14n-12b).


链接中问号及问号后面的那长串不要

xiaozhu36 · 2019-12-17T03:45:14Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    description:
+      - database character name. MySQL or MariaDB (utf8 | gbk | latin1 | utf8mb4).
+        SQL Server (Chinese_PRC_CI_AS | Chinese_PRC_CS_AS | SQL_Latin1_General_CP1_CI_AS | SQL_Latin1_General_CP1_CS_AS | Chinese_PRC_BIN). 
+        see more (https://www.alibabacloud.com/help/doc-detail/26258.htm?spm=a2c63.l28256.b99.795.310413c7998oJs)


这个也一样

xiaozhu36 · 2019-12-17T03:46:18Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    description:
+      - The ID of the destination instance, which must differ from the ID of the source instance.
+    aliases: ['target_instance_id']
+  db_names:


如果只有一个元素，直接写成target_db_name

拷贝一个实例数据库到另一个实例，需要两个参数的，原数据库名字和拷贝之后的命名

对啊，原数据库名为 db_name; 拷贝后的叫做 target_db_name

xiaozhu36 · 2019-12-17T04:19:02Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+            returned: always
+            type: string
+            sample: rm-uf6wjk5xxxxxxx        
+        dbname:


为啥return中就连起来了

它返回的参数叫DBName， footmark转换之后就连在一起了
changed: [localhost] => {
"changed": true,
"database": {
"accounts": {
"account_privilege_info": []
},
"character_set_name": "utf8",
"dbdescription": "create for ansible test",
"dbinstance_id": "rm-2zef503eq1vkmop04",
"dbname": "ansible_test",
"dbstatus": "Running",
"description": "create for ansible test",
"engine": "MySQL",
"id": "rm-2zef503eq1vkmop04",
"name": "ansible_test",
"status": "Running"

xiaozhu36 · 2019-12-17T04:20:22Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

+EXAMPLES = '''
+- name: Get the existing database with name prefix
+  ali_rds_database_info:
+    name_prefix: ansible_


字符串得要引号吧

测试过了，不加引号也没问题

xiaozhu36 · 2019-12-17T04:21:18Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

+'''
+
+RETURN = '''
+database:


info 返回的是一个list

database->databases

xiaozhu36 · 2019-12-19T07:57:55Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    description:
+      - The ID of the destination instance, which must differ from the ID of the source instance.
+    aliases: ['target_instance_id']
+  db_names:


对啊，原数据库名为 db_name; 拷贝后的叫做 target_db_name

xiaozhu36 · 2019-12-19T07:58:06Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+            returned: always
+            type: string
+            sample: rm-uf6wjk5xxxxxxx        
+        dbname:


xiaozhu36 · 2019-12-19T08:00:00Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

+'''
+
+RETURN = '''
+database:


database->databases

xiaozhu36 · 2019-12-19T08:24:51Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

 options:
  state:
    description:
      - The state of the instance after operating.
+    choices: ['present', 'restart', 'absent']


state: description: - If I(state=present), instance will be created. - If I(state=present) and instance exists, it will be updated. - If I(state=absent), instance will be removed. - If I(state=restart), instance will be restarted. default: present choices: ['present', 'restart', 'absent']

以后所有的state都这样写，说清楚每个state分别是干什么的

xiaozhu36 · 2019-12-19T08:26:17Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-      - Type of payment. Postpaid: postpaid instance; Prepaid: prepaid instance. Required when C(state=present).
-    choices: [ "Postpaid", "Prepaid" ]
+      - The billing method of the instance.Required when C(state=present).
+    choices: ["Postpaid", "Prepaid"]


所有的计费类型统一为 PostPaid 和 PrePaid

这个也没改啊

xiaozhu36 · 2019-12-19T08:29:53Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-      - Port of public net work.
-  private_port:
+      - The prefix of the target connection address. Only the prefix of CurrentConnectionString can be modified.
+  is_readonly:


只读实例单独抽象为一个module吧

xiaozhu36 · 2019-12-19T08:30:26Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-    description:
-      - Automatic renewal period. Required when C(auto_renew='True')
-    choices: [1, 2, 3, 6, 12]
+      - Instance id, the unique identifier of the instance. Required when C(state in ["present", "absent", "restart"])


用 instance name来保证幂等吧

xiaozhu36 · 2019-12-23T09:17:39Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+  sync_user_privilege:
+    description:
+      - Indicates whether to copy users and permissions.
+    choices: ['YES', 'NO']


用一个bool来代替 yes和no

xiaozhu36 · 2019-12-23T09:27:40Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+version_added: "2.9.2"
+short_description: Create, delete or copy an database in Alibaba Cloud RDS.
+description:
+    - Create, delete, copy or modify description for database in RDS.


以后在所有的module的description中都显示的说明当前这个module的唯一标识符有哪几个字段决定，比如这个database的增加这么一句：
- An unique ali_rds_database module is co-determined by parameters db_instance_id and db_name.

xiaozhu36 · 2019-12-23T09:31:52Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+      - database name. It must be 2 to 64 characters in length.It must start with a lowercase letter and end with a 
+        lowercase letter or digit. It can contain lowercase letters, digits, underscores (_), and hyphens (-). 
+        The database name must be unique whithin the instance. this will specify unique database in one instance.
+        For more information about invalid characters, see Forbidden keywords table U(https://www.alibabacloud.com/help/doc-detail/26317.htm).


一个module的唯一性除了最上面说明外，在每个参数中的描述中也在再说明一次，比如db_name:
- This is used in combination with C(db_instance_id) to determine if the database already exists.
db_instance_id：
- This is used in combination with C(db_name) to determine if the database already exists.

xiaozhu36 · 2019-12-23T09:33:02Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+            returned: always
+            type: string
+            sample: MySQL
+        id:


这个ID去掉吧

xiaozhu36 · 2019-12-23T09:35:16Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

+DOCUMENTATION = '''
+---
+module: ali_rds_database_info
+version_added: "2.9.2"


这个版本号以后统一写成2.9 吧

xiaozhu36 · 2019-12-23T09:35:43Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

+            returned: always
+            type: string
+            sample: MySQL
+        id:


id 去掉吧

xiaozhu36 · 2019-12-23T09:36:55Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

+        SQL Server (2008r2 | 2012 | 2012_ent_ha | 2012_std_ha | 2012_web | 2016_ent_ha | 2016_std_ha | 2016_web | 2017_ent)
+        PostgreSQL (9.4 | 10.0)
+        PPAS (9.3 | 10.0)
+        MariaDB (10.3)


xiaozhu36 · 2019-12-23T09:38:33Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

+        connection_mode:
+            description: The access mode of the instance
+            returned: always
+            type: string


返回参数中没有分配的connection string啊。这个出参至少要跟入参对齐

改用了另一个接口，返回了更全的参数，已经补充

xiaozhu36 · 2019-12-23T09:39:24Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance_info.py

+            description: The access mode of the instance
+            returned: always
+            type: string
+            sample: Standard  


info中的出参要跟module中的出参保持一直

xiaozhu36 · 2019-12-25T04:24:11Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+short_description: Create, delete or copy an database in Alibaba Cloud RDS.
+description:
+    - Create, delete, copy or modify description for database in RDS.
+      An unique ali_rds_database module is co-determined by parameters db_instance_id and db_name.


前面的 “-” 呢？
如果没有 “-”，会跟在上面那行，如果有，会另起一行

xiaozhu36 · 2019-12-25T04:24:55Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+        lowercase letter or digit. It can contain lowercase letters, digits, underscores (_), and hyphens (-). 
+        this will specify unique database in one instance.
+        For more information about invalid characters, see Forbidden keywords table U(https://www.alibabacloud.com/help/doc-detail/26317.htm).
+        This is used in combination with C(db_instance_id) to determine if the database already exists.


这个也一样，加一个 “-”

xiaozhu36 · 2019-12-25T04:25:29Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+      - Target instance database name.
+  backup_id:
+    description:
+      - The ID of the backup set on the source instance. When you copy databases based on the backup set


最后的句号呢

xiaozhu36 · 2019-12-25T04:26:05Z

lib/ansible/modules/cloud/alicloud/ali_rds_database.py

+    db_name: ansible_test
+    character_set_name: utf8
+    db_description: create for ansible test
+    state: present


example中最好不要出现test的字眼

xiaozhu36 · 2019-12-25T04:27:46Z

lib/ansible/modules/cloud/alicloud/ali_rds_database_info.py

+  db_instance_id:
+    description:
+      - The ID of the instance.
+    aliases: ["instance_id"]


这个应该得是required的吧，没有实例id怎么查database啊

xiaozhu36 · 2019-12-25T04:30:00Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

    choices: ["Internet", "Intranet"]
-    aliases: ['db_instance_net_type']
-  description:
+  db_instance_description:


改成 db_instance_name, alias是 name 和 description

xiaozhu36 · 2019-12-25T04:31:19Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-      - Type of payment. Postpaid: postpaid instance; Prepaid: prepaid instance. Required when C(state=present).
-    choices: [ "Postpaid", "Prepaid" ]
+      - The billing method of the instance.Required when C(state=present).
+    choices: ["Postpaid", "Prepaid"]


这个也没改啊

xiaozhu36 · 2019-12-25T04:32:24Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-    choices: [1~9,12,24,36]
-    default: 1
+      - The prepayment period of the instance.
+    choices: ['Year', 'Month']


统一都采用 Month，如果计费周期大于9，就将其转换为年

xiaozhu36 · 2019-12-25T04:32:50Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-    choices: ["Performance", "Safty"]
+      - The access mode of the instance.
+    choices: ["Standard", "Safe"]
+  instance_network_type:


instance_network_type 可以去掉，如果指定了vswitchid，就是 vpc，否则就是classic

xiaozhu36 · 2019-12-25T04:33:04Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

-  page_size:
+      - The intranet IP address of the instance. It must be within the IP address range provided by the switch. 
+        By default, the system automatically assigns an IP address based on the VPCId and VSwitchId.
+  db_instance_id:


db_instance_id 是用来干嘛的

xiaozhu36 · 2019-12-25T08:38:55Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

 description:
-    - Create, restart, modify or terminate rds instances.
+    - Create, Restart, Delete and Modify connection_string, spec for RDS Instance.
+    - An unique ali_rds_instance module is determined by parameters db_instance_description(instance name).


不是改称 db_instance_name 了么

xiaozhu36 · 2019-12-25T08:39:59Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

    description:
-      - Type of payment. Postpaid: postpaid instance; Prepaid: prepaid instance. Required when C(state=present).
-    choices: [ "Postpaid", "Prepaid" ]
+      - The billing method of the instance.Required when C(state=present).


句号后如果还有语句，要空一格

xiaozhu36 · 2019-12-25T08:40:30Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

    choices: [1~9,12,24,36]
-    default: 1
+    default: 1 


每一行最后不要留对于的空格

xiaozhu36 · 2019-12-25T08:41:35Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

+            if ins.name == name:
+                res = ins
+        if res:
+            res = rds.describe_db_instance_attribute(DBInstanceId=res.id)


为啥还要再查一遍

xiaozhu36 · 2019-12-25T08:41:57Z

lib/ansible/modules/cloud/alicloud/ali_rds_instance.py

+        db_instance_name=dict(type='str', aliases=['description', 'name'], required=True),
+        security_ip_list=dict(type='str', aliases=['security_ips']),
+        pay_type=dict(type='str', choices=["PostPaid", "PrePaid"]),
+        period=dict(type='str', choice=['1', '2', '3', '4', '5', '6', '7', '8', '9', '12', '24', '36'], default='1'),


这个period的类型应该是 int把

lixue323 force-pushed the rds branch 4 times, most recently from fd69c54 to f9a6ca2 Compare November 29, 2019 10:33

lixue323 changed the title ~~improve (rds): modify rds instance~~ improve (rds): modify rds instance and database Nov 29, 2019

lixue323 force-pushed the rds branch 2 times, most recently from 80d0dc6 to 0c7f5f3 Compare November 29, 2019 10:41

xiaozhu36 approved these changes Dec 11, 2019

View reviewed changes

xiaozhu36 requested changes Dec 11, 2019

View reviewed changes

lixue323 force-pushed the rds branch 3 times, most recently from 6b0507b to 1b7f943 Compare December 16, 2019 06:07

xiaozhu36 requested changes Dec 17, 2019

View reviewed changes

lixue323 force-pushed the rds branch 2 times, most recently from 1ea83e1 to 4ef5d81 Compare December 18, 2019 12:09

xiaozhu36 requested changes Dec 19, 2019

View reviewed changes

lixue323 force-pushed the rds branch 5 times, most recently from 80518bf to f1a81d5 Compare December 20, 2019 10:11

xiaozhu36 requested changes Dec 23, 2019

View reviewed changes

lixue323 force-pushed the rds branch from f1a81d5 to 0c285d4 Compare December 24, 2019 07:35

xiaozhu36 requested changes Dec 25, 2019

View reviewed changes

lixue323 force-pushed the rds branch 2 times, most recently from 790995f to dbb73cd Compare December 25, 2019 08:13

xiaozhu36 requested changes Dec 25, 2019

View reviewed changes

lixue323 force-pushed the rds branch 2 times, most recently from 47c975c to 2ec2fd2 Compare December 25, 2019 09:18

improve (rds): modify rds instance and database

5f76955

lixue323 force-pushed the rds branch from 2ec2fd2 to 5f76955 Compare December 25, 2019 10:24

xiaozhu36 approved these changes Dec 26, 2019

View reviewed changes

xiaozhu36 merged commit 1bc8267 into alibaba:master Dec 26, 2019

lixue323 deleted the rds branch March 1, 2020 08:45

		@@ -0,0 +1,251 @@
		#!/usr/bin/python
		# Copyright (c) 2017 Alibaba Group Holding Limited. He Guimin <[email protected]>

improve (rds): modify rds instance and database #205

improve (rds): modify rds instance and database #205

Conversation

lixue323 commented Nov 28, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment