Please see before starting:
-
https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.DBAccounts.html
-
https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/UsingWithRDS.IAMDBAuth.Enabling.html
Kubemq mysql target connector allows services using kubemq server to access mysql database services. Using the IAM user login instead of username password method.
The following is required to run the mysql target connector:
- kubemq cluster
- aws rds with IAM user mysql server
- db user with IAM Authentication privileges
- kubemq-targets deployment
Mysql target connector configuration properties:
Properties Key | Required | Description | Example |
---|---|---|---|
max_idle_connections | no | set max idle connections | "10" |
max_open_connections | no | set max open connections | "100" |
connection_max_lifetime_seconds | no | set max lifetime for connections in seconds | "3600" |
db_user | yes | aws db user name | "<aws user" |
db_name | yes | aws db name | "<aws instance name" |
aws_key | yes | aws key | aws key supplied by aws |
aws_secret_key | yes | aws secret key | aws secret key supplied by aws |
region | yes | region | aws region |
token | no | aws token ("default" empty string | aws token |
end_point | yes | aws rds endpoint | "<aws rds end point" |
Example:
bindings:
- name: kubemq-query-aws-mysql
source:
kind: kubemq.query
name: kubemq-query
properties:
address: "kubemq-cluster:50000"
client_id: "kubemq-query-mysql-connector"
auth_token: ""
channel: "query.aws.rds.mysql"
group: ""
auto_reconnect: "true"
reconnect_interval_seconds: "1"
max_reconnects: "0"
target:
kind: aws.rds.mysql
name: aws-rds-mysql
properties:
instance_connection_name: "test"
db_user: "test"
db_name: "test"
end_point: "my-end-point"
aws_key: "id"
aws_secret_key: 'json'
region: "region"
token: ""
db_port: "3306",
max_idle_connections: "10"
max_open_connections: "100"
connection_max_lifetime_seconds: "3600"
Query request metadata setting:
Metadata Key | Required | Description | Possible values |
---|---|---|---|
method | yes | set type of request | "query" |
Query request data setting:
Data Key | Required | Description | Possible values |
---|---|---|---|
data | yes | query string | base64 bytes array |
Example:
Query string: SELECT id,title,content,bignumber,boolvalue FROM post;
{
"metadata": {
"method": "query"
},
"data": "U0VMRUNUIGlkLHRpdGxlLGNvbnRlbnQsYmlnbnVtYmVyLGJvb2x2YWx1ZSBGUk9NIHBvc3Q7"
}
Exec request metadata setting:
Metadata Key | Required | Description | Possible values |
---|---|---|---|
method | yes | set type of request | "exec" |
isolation_level | no | set isolation level for exec operation | "" |
"read_uncommitted" | |||
"read_committed" | |||
"repeatable_read" | |||
"serializable" | |||
Exec request data setting:
Data Key | Required | Description | Possible values |
---|---|---|---|
data | yes | exec string | base64 bytes array |
Example:
Exec string:
INSERT INTO post(ID,TITLE,CONTENT,BIGNUMBER,BOOLVALUE) VALUES
(0,NULL,'Content One',1231241241231231123,true),
(1,'Title Two','Content Two',123125241231231123,false);
{
"metadata": {
"method": "exec",
"isolation_level": "read_uncommitted"
},
"data": "SU5TRVJUIElOVE8gcG9zdChJRCxUSVRMRSxDT05URU5ULEJJR05VTUJFUixCT09MVkFMVUUpIFZBTFVFUwoJICAgICAgICAgICAgICAgICAgICAgICAoMCxOVUxMLCdDb250ZW50IE9uZScsMTIzMTI0MTI0MTIzMTIzMTEyMyx0cnVlKSwKCSAgICAgICAgICAgICAgICAgICAgICAgKDEsJ1RpdGxlIFR3bycsJ0NvbnRlbnQgVHdvJywxMjMxMjUyNDEyMzEyMzExMjMsZmFsc2UpOw=="
}
Transaction request metadata setting:
Metadata Key | Required | Description | Possible values |
---|---|---|---|
method | yes | set type of request | "transaction" |
isolation_level | no | set isolation level for exec operation | "" |
"read_uncommitted" | |||
"read_committed" | |||
"repeatable_read" | |||
"serializable" |
Transaction request data setting:
Data Key | Required | Description | Possible values |
---|---|---|---|
data | yes | string string | base64 bytes array |
Example:
Transaction string:
DROP TABLE IF EXISTS post;
CREATE TABLE post (
ID bigint,
TITLE varchar(40),
CONTENT varchar(255),
BIGNUMBER bigint,
BOOLVALUE boolean,
CONSTRAINT pk_post PRIMARY KEY(ID)
);
{
"metadata": {
"method": "transaction"
},
"data": "RFJPUCBUQUJMRSBJRiBFWElTVFMgcG9zdDsKCSAgICAgICBDUkVBVEUgVEFCTEUgcG9zdCAoCgkgICAgICAgICBJRCBiaWdpbnQsCgkgICAgICAgICBUSVRMRSB2YXJjaGFyKDQwKSwKCSAgICAgICAgIENPTlRFTlQgdmFyY2hhcigyNTUpLAoJCQkgQklHTlVNQkVSIGJpZ2ludCwKCQkJIEJPT0xWQUxVRSBib29sZWFuLAoJICAgICAgICAgQ09OU1RSQUlOVCBwa19wb3N0IFBSSU1BUlkgS0VZKElEKQoJICAgICAgICk7"
}