wbrawner/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

vertica doc fixes

Browse source
This commit is contained in:
Brian Coca 2015-03-31 10:44:34 -04:00 committed by Matt Clay
parent 346e34ac79
commit b90f97442d
5 changed files with 103 additions and 116 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
lib/ansible/modules/extras/database/vertica/vertica_configuration.py
View file

@ -22,59 +22,55 @@ module: vertica_configuration
version_added: '1.0' version_added: '1.0'
short_description: Updates Vertica configuration parameters. short_description: Updates Vertica configuration parameters.
description: description:
Updates Vertica configuration parameters. - Updates Vertica configuration parameters.
options: options:
name: name:
description: description:
Name of the parameter to update. - Name of the parameter to update.
required: true required: true
default: null
value: value:
description: description:
Value of the parameter to be set. - Value of the parameter to be set.
required: true required: true
default: null
db: db:
description: description:
Name of the Vertica database. - Name of the Vertica database.
required: false required: false
default: null default: null
cluster: cluster:
description: description:
Name of the Vertica cluster. - Name of the Vertica cluster.
required: false required: false
default: localhost default: localhost
port: port:
description: description:
Vertica cluster port to connect to. - Vertica cluster port to connect to.
required: false required: false
default: 5433 default: 5433
login_user: login_user:
description: description:
The username used to authenticate with. - The username used to authenticate with.
required: false required: false
default: dbadmin default: dbadmin
login_password: login_password:
description: description:
The password used to authenticate with. - The password used to authenticate with.
required: false required: false
default: null default: null
notes: notes:
The default authentication assumes that you are either logging in as or sudo'ing - The default authentication assumes that you are either logging in as or sudo'ing
to the C(dbadmin) account on the host. to the C(dbadmin) account on the host.
This module uses C(pyodbc), a Python ODBC database adapter. You must ensure - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure
that C(unixODBC) and C(pyodbc) is installed on the host and properly configured. that C(unixODBC) and C(pyodbc) is installed on the host and properly configured.
Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so)
to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini)
and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16)
to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini).
requirements: [ 'unixODBC', 'pyodbc' ] requirements: [ 'unixODBC', 'pyodbc' ]
author: Dariusz Owczarek author: Dariusz Owczarek
""" """
EXAMPLES = """ EXAMPLES = """
Examples:
- name: updating load_balance_policy - name: updating load_balance_policy
vertica_configuration: name=failovertostandbyafter value='8 hours' vertica_configuration: name=failovertostandbyafter value='8 hours'
""" """

26
lib/ansible/modules/extras/database/vertica/vertica_facts.py
View file

@ -22,11 +22,11 @@ module: vertica_facts
version_added: '1.0' version_added: '1.0'
short_description: Gathers Vertica database facts. short_description: Gathers Vertica database facts.
description: description:
Gathers Vertica database facts. - Gathers Vertica database facts.
options: options:
cluster: cluster:
description: description:
Name of the cluster running the schema. - Name of the cluster running the schema.
required: false required: false
default: localhost default: localhost
port: port:
@ -36,28 +36,28 @@ options:
default: 5433 default: 5433
db: db:
description: description:
Name of the database running the schema. - Name of the database running the schema.
required: false required: false
default: null default: null
login_user: login_user:
description: description:
The username used to authenticate with. - The username used to authenticate with.
required: false required: false
default: dbadmin default: dbadmin
login_password: login_password:
description: description:
The password used to authenticate with. - The password used to authenticate with.
required: false required: false
default: null default: null
notes: notes:
The default authentication assumes that you are either logging in as or sudo'ing - The default authentication assumes that you are either logging in as or sudo'ing
to the C(dbadmin) account on the host. to the C(dbadmin) account on the host.
This module uses C(pyodbc), a Python ODBC database adapter. You must ensure - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure
that C(unixODBC) and C(pyodbc) is installed on the host and properly configured. that C(unixODBC) and C(pyodbc) is installed on the host and properly configured.
Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so)
to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini)
and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16)
to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini).
requirements: [ 'unixODBC', 'pyodbc' ] requirements: [ 'unixODBC', 'pyodbc' ]
author: Dariusz Owczarek author: Dariusz Owczarek
""" """

39
lib/ansible/modules/extras/database/vertica/vertica_role.py
View file

@ -22,66 +22,63 @@ module: vertica_role
version_added: '1.0' version_added: '1.0'
short_description: Adds or removes Vertica database roles and assigns roles to them. short_description: Adds or removes Vertica database roles and assigns roles to them.
description: description:
Adds or removes Vertica database role and, optionally, assign other roles. - Adds or removes Vertica database role and, optionally, assign other roles.
options: options:
name: name:
description: description:
Name of the role to add or remove. - Name of the role to add or remove.
required: true required: true
default: null
assigned_roles: assigned_roles:
description: description:
Comma separated list of roles to assign to the role. - Comma separated list of roles to assign to the role.
[Alias I(assigned_role)] aliases: ['assigned_role']
required: false required: false
default: null default: null
state: state:
description: description:
Whether to create C(present), drop C(absent) or lock C(locked) a role. - Whether to create C(present), drop C(absent) or lock C(locked) a role.
required: false required: false
choices: ['present', 'absent'] choices: ['present', 'absent']
default: present default: present
db: db:
description: description:
Name of the Vertica database. - Name of the Vertica database.
required: false required: false
default: null default: null
cluster: cluster:
description: description:
Name of the Vertica cluster. - Name of the Vertica cluster.
required: false required: false
default: localhost default: localhost
port: port:
description: description:
Vertica cluster port to connect to. - Vertica cluster port to connect to.
required: false required: false
default: 5433 default: 5433
login_user: login_user:
description: description:
The username used to authenticate with. - The username used to authenticate with.
required: false required: false
default: dbadmin default: dbadmin
login_password: login_password:
description: description:
The password used to authenticate with. - The password used to authenticate with.
required: false required: false
default: null default: null
notes: notes:
The default authentication assumes that you are either logging in as or sudo'ing - The default authentication assumes that you are either logging in as or sudo'ing
to the C(dbadmin) account on the host. to the C(dbadmin) account on the host.
This module uses C(pyodbc), a Python ODBC database adapter. You must ensure - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure
that C(unixODBC) and C(pyodbc) is installed on the host and properly configured. that C(unixODBC) and C(pyodbc) is installed on the host and properly configured.
Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so)
to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini)
and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16)
to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini).
requirements: [ 'unixODBC', 'pyodbc' ] requirements: [ 'unixODBC', 'pyodbc' ]
author: Dariusz Owczarek author: Dariusz Owczarek
""" """
EXAMPLES = """ EXAMPLES = """
Examples:
- name: creating a new vertica role - name: creating a new vertica role
vertica_role: name=role_name db=db_name state=present vertica_role: name=role_name db=db_name state=present

55
lib/ansible/modules/extras/database/vertica/vertica_schema.py
View file

@ -22,82 +22,79 @@ module: vertica_schema
version_added: '1.0' version_added: '1.0'
short_description: Adds or removes Vertica database schema and roles. short_description: Adds or removes Vertica database schema and roles.
description: description:
Adds or removes Vertica database schema and, optionally, roles - Adds or removes Vertica database schema and, optionally, roles
with schema access privileges. with schema access privileges.
A schema will not be removed until all the objects have been dropped. - A schema will not be removed until all the objects have been dropped.
In such a situation, if the module tries to remove the schema it - In such a situation, if the module tries to remove the schema it
will fail and only remove roles created for the schema if they have will fail and only remove roles created for the schema if they have
no dependencies. no dependencies.
options: options:
name: name:
description: description:
Name of the schema to add or remove. - Name of the schema to add or remove.
required: true required: true
default: null
usage_roles: usage_roles:
description: description:
Comma separated list of roles to create and grant usage access to the schema. - Comma separated list of roles to create and grant usage access to the schema.
[Alias I(usage_role)] aliases: ['usage_role']
required: false required: false
default: null default: null
create_roles: create_roles:
description: description:
Comma separated list of roles to create and grant usage and create access to the schema. - Comma separated list of roles to create and grant usage and create access to the schema.
[Alias I(create_role)] aliases: ['create_role']
required: false required: false
default: null default: null
owner: owner:
description: description:
Name of the user to set as owner of the schema. - Name of the user to set as owner of the schema.
required: false required: false
default: null default: null
state: state:
description: description:
Whether to create C(present), or drop C(absent) a schema. - Whether to create C(present), or drop C(absent) a schema.
required: false required: false
default: present default: present
choices: ['present', 'absent'] choices: ['present', 'absent']
db: db:
description: description:
Name of the Vertica database. - Name of the Vertica database.
required: false required: false
default: null default: null
cluster: cluster:
description: description:
Name of the Vertica cluster. - Name of the Vertica cluster.
required: false required: false
default: localhost default: localhost
port: port:
description: description:
Vertica cluster port to connect to. - Vertica cluster port to connect to.
required: false required: false
default: 5433 default: 5433
login_user: login_user:
description: description:
The username used to authenticate with. - The username used to authenticate with.
required: false required: false
default: dbadmin default: dbadmin
login_password: login_password:
description: description:
The password used to authenticate with. - The password used to authenticate with.
required: false required: false
default: null default: null
notes: notes:
The default authentication assumes that you are either logging in as or sudo'ing - The default authentication assumes that you are either logging in as or sudo'ing
to the C(dbadmin) account on the host. to the C(dbadmin) account on the host.
This module uses C(pyodbc), a Python ODBC database adapter. You must ensure - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure
that C(unixODBC) and C(pyodbc) is installed on the host and properly configured. that C(unixODBC) and C(pyodbc) is installed on the host and properly configured.
Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so)
to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini)
and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16)
to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini).
requirements: [ 'unixODBC', 'pyodbc' ] requirements: [ 'unixODBC', 'pyodbc' ]
author: Dariusz Owczarek author: Dariusz Owczarek
""" """
EXAMPLES = """ EXAMPLES = """
Examples:
- name: creating a new vertica schema - name: creating a new vertica schema
vertica_schema: name=schema_name db=db_name state=present vertica_schema: name=schema_name db=db_name state=present

63
lib/ansible/modules/extras/database/vertica/vertica_user.py
View file

@ -22,98 +22,95 @@ module: vertica_user
version_added: '1.0' version_added: '1.0'
short_description: Adds or removes Vertica database users and assigns roles. short_description: Adds or removes Vertica database users and assigns roles.
description: description:
Adds or removes Vertica database user and, optionally, assigns roles. - Adds or removes Vertica database user and, optionally, assigns roles.
A user will not be removed until all the dependencies have been dropped. - A user will not be removed until all the dependencies have been dropped.
In such a situation, if the module tries to remove the user it - In such a situation, if the module tries to remove the user it
will fail and only remove roles granted to the user. will fail and only remove roles granted to the user.
options: options:
name: name:
description: description:
Name of the user to add or remove. - Name of the user to add or remove.
required: true required: true
default: null
profile: profile:
description: description:
Sets the user's profile. - Sets the user's profile.
required: false required: false
default: null default: null
resource_pool: resource_pool:
description: description:
Sets the user's resource pool. - Sets the user's resource pool.
required: false required: false
default: null default: null
password: password:
description: description:
The user's password encrypted by the MD5 algorithm. - The user's password encrypted by the MD5 algorithm.
The password must be generated with the format C("md5" + md5[password + username]), - The password must be generated with the format C("md5" + md5[password + username]),
resulting in a total of 35 characters. An easy way to do this is by querying resulting in a total of 35 characters. An easy way to do this is by querying
the Vertica database with select 'md5'||md5('<user_password><user_name>'). the Vertica database with select 'md5'||md5('<user_password><user_name>').
required: false required: false
default: null default: null
expired: expired:
description: description:
Sets the user's password expiration. - Sets the user's password expiration.
required: false required: false
default: null default: null
ldap: ldap:
description: description:
Set to true if users are authenticated via LDAP. - Set to true if users are authenticated via LDAP.
The user will be created with password expired and set to I($ldap$). - The user will be created with password expired and set to I($ldap$).
required: false required: false
default: null default: null
roles: roles:
description: description:
Comma separated list of roles to assign to the user. - Comma separated list of roles to assign to the user.
[Alias I(role)] aliases: ['role']
required: false required: false
default: null default: null
state: state:
description: description:
Whether to create C(present), drop C(absent) or lock C(locked) a user. - Whether to create C(present), drop C(absent) or lock C(locked) a user.
required: false required: false
choices: ['present', 'absent', 'locked'] choices: ['present', 'absent', 'locked']
default: present default: present
db: db:
description: description:
Name of the Vertica database. - Name of the Vertica database.
required: false required: false
default: null default: null
cluster: cluster:
description: description:
Name of the Vertica cluster. - Name of the Vertica cluster.
required: false required: false
default: localhost default: localhost
port: port:
description: description:
Vertica cluster port to connect to. - Vertica cluster port to connect to.
required: false required: false
default: 5433 default: 5433
login_user: login_user:
description: description:
The username used to authenticate with. - The username used to authenticate with.
required: false required: false
default: dbadmin default: dbadmin
login_password: login_password:
description: description:
The password used to authenticate with. - The password used to authenticate with.
required: false required: false
default: null default: null
notes: notes:
The default authentication assumes that you are either logging in as or sudo'ing - The default authentication assumes that you are either logging in as or sudo'ing
to the C(dbadmin) account on the host. to the C(dbadmin) account on the host.
This module uses C(pyodbc), a Python ODBC database adapter. You must ensure - This module uses C(pyodbc), a Python ODBC database adapter. You must ensure
that C(unixODBC) and C(pyodbc) is installed on the host and properly configured. that C(unixODBC) and C(pyodbc) is installed on the host and properly configured.
Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so) - Configuring C(unixODBC) for Vertica requires C(Driver = /opt/vertica/lib64/libverticaodbc.so)
to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini) to be added to the C(Vertica) section of either C(/etc/odbcinst.ini) or C($HOME/.odbcinst.ini)
and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16) and both C(ErrorMessagesPath = /opt/vertica/lib64) and C(DriverManagerEncoding = UTF-16)
to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini). to be added to the C(Driver) section of either C(/etc/vertica.ini) or C($HOME/.vertica.ini).
requirements: [ 'unixODBC', 'pyodbc' ] requirements: [ 'unixODBC', 'pyodbc' ]
author: Dariusz Owczarek author: Dariusz Owczarek
""" """
EXAMPLES = """ EXAMPLES = """
Examples:
- name: creating a new vertica user with password - name: creating a new vertica user with password
vertica_user: name=user_name password=md5<encrypted_password> db=db_name state=present vertica_user: name=user_name password=md5<encrypted_password> db=db_name state=present