users

Creates, updates, deletes, gets or lists a users resource.

Overview

Name	users
Type	Resource
Id	ovh.cluster_hadoop.users

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
cloudera_manager	boolean	Whether or not the User is allowed to access to the Cloudera Manager interface (wire: clouderaManager)
http_frontend	boolean	Whether or not the User is allowed to access to the WebUI interfaces (wire: httpFrontend)
hue	boolean	Whether or not the User is allowed to access to the Hue interface
username	string	The username of the User

list

User allowed to access interfaces on your cluster

Name	Datatype	Description
cloudera_manager	boolean	Whether or not the User is allowed to access to the Cloudera Manager interface (wire: clouderaManager)
http_frontend	boolean	Whether or not the User is allowed to access to the WebUI interfaces (wire: httpFrontend)
hue	boolean	Whether or not the User is allowed to access to the Hue interface
username	string	The username of the User

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	service_name, username		Get this object properties
list	select	service_name	x_pagination_mode	Users associated with this Hadoop Cluster
create	insert	service_name, cloudera_manager, http_frontend, hue, password, username		Add an User to your cluster
update	update	service_name, username		Alter this object properties
delete	delete	service_name, username		Remove this User
reset_password	exec	serviceName, username, password		Reset the password for a given Hadoop Cluster User

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
serviceName	string	The internal name of your cluster
service_name	string	The internal name of your cluster (wire: serviceName)
username	string	The username of the User
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get this object properties

SELECT
cloudera_manager,
http_frontend,
hue,
username
FROM ovh.cluster_hadoop.users
WHERE service_name = '{{ service_name }}' -- required
AND username = '{{ username }}' -- required
;

list

Users associated with this Hadoop Cluster

SELECT
cloudera_manager,
http_frontend,
hue,
username
FROM ovh.cluster_hadoop.users
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

INSERT examples

create

Add an User to your cluster

INSERT INTO ovh.cluster_hadoop.users (
cloudera_manager,
http_frontend,
hue,
password,
username,
service_name
)
SELECT 
{{ cloudera_manager }} /* required */,
{{ http_frontend }} /* required */,
{{ hue }} /* required */,
'{{ password }}' /* required */,
'{{ username }}' /* required */,
'{{ service_name }}'
RETURNING
name,
task_id,
status
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the users resource.
  - name: cloudera_manager
    value: {{ cloudera_manager }}
    description: |
      Whether or not the User is allowed to access to the Cloudera Manager interface
  - name: http_frontend
    value: {{ http_frontend }}
    description: |
      Whether or not the User is allowed to access to the WebUI interfaces
  - name: hue
    value: {{ hue }}
    description: |
      Whether or not the User is allowed to access to the Hue interface
  - name: password
    value: "{{ password }}"
    description: |
      Password of the User
  - name: username
    value: "{{ username }}"
    description: |
      Username of the User

UPDATE examples

update

Alter this object properties

UPDATE ovh.cluster_hadoop.users
SET 
cloudera_manager = {{ cloudera_manager }},
http_frontend = {{ http_frontend }},
hue = {{ hue }}
WHERE 
service_name = '{{ service_name }}' --required
AND username = '{{ username }}' --required;

DELETE examples

delete

Remove this User

DELETE FROM ovh.cluster_hadoop.users
WHERE service_name = '{{ service_name }}' --required
AND username = '{{ username }}' --required
;

Lifecycle Methods

EXEC variables use wire (API) names.

reset_password

Reset the password for a given Hadoop Cluster User

EXEC ovh.cluster_hadoop.users.reset_password 
@serviceName='{{ serviceName }}' --required, 
@username='{{ username }}' --required 
@@json=
'{
"password": "{{ password }}"
}'
;