scale_computing.hypercore.cluster_config role – Configure HyperCore cluster

Note

This role is part of the scale_computing.hypercore collection (version 1.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it use: ansible-galaxy collection install scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.cluster_config.

Entry point main – Configure HyperCore cluster

Synopsis

• Role cluster_config can be used to fully configure a new HyperCore server, or partially reconfigure an existing HyperCore server.

• The role will continue with cluster configuration tasks if one of tasks fail, to apply as many changes as possible. Whole role will still exit with error.

Parameters

Parameter	Comments
cluster_config_configuration dictionary / required	A dict describing a full or partial cluster configuration. Partial configuration will be used if some of the keys in `scale_computing_hypercore_cluster_config` are omitted.
dns dictionary	DNS configuration. If missing, cluster DNS configuration will not be changed. See also scale_computing.hypercore.dns_config.
search_domains list / elements=string	DNS search domain.
server_ips list / elements=string	DNS resolver IP.
email_alerts list / elements=string	Email addresses that will receive email alerts. If missing, Email alert recipients will not be changed. See also scale_computing.hypercore.email_alert.
name string	Cluster name. If missing, cluster name will not be changed. See also scale_computing.hypercore.cluster_name.
oidc dictionary	OpenID connect configuration allows using Microsoft Azure as authentication backend. If missing, cluster OpenID connect configuration will not be changed. See also scale_computing.hypercore.oidc_config.
certificate string	OIDC client certificate, PEM encoded.
client_id string / required	OIDC client ID.
config_url string / required	OIDC configuration URL (for example, https://auth.example.com/.well-known/openid-configuration).
scopes string / required	OIDC client scopes.
shared_secret string	OIDC client secret.
registration dictionary	Cluster registration data. If missing, cluster registration data will not be changed. See also scale_computing.hypercore.registration.
company_name string / required	Company name
contact string / required	Technical contact first and second name
email string / required	Technical contact email address
phone string / required	Technical contact phone number
smtp dictionary	Cluster SMTP server configuration. If missing, cluster SMTP server will not be changed. See also scale_computing.hypercore.smtp.
auth_password string	Password to authenticate against SMTP server.
auth_user string	Username to authenticate against SMTP server.
from_address string / required	The “From” email address for email alerts.
port integer / required	SMTP server TCP port.
server string / required	SMTP server (IP or DNS name).
use_ssl boolean	Use SSL/TLS encryption between HyperCore and SMTP server. Choices: false true
syslog_servers list / elements=dictionary	Cluster syslog server configuration. If missing, cluster syslog server will not be changed. See also scale_computing.hypercore.syslog_server.
host string / required	Syslog server IP address or DNS name.
port integer	The IP port syslog server is listening to.
protocol string	Syslog IP protocol. Choices: "udp" "tcp"
time_server string	Cluster NTP time server. If missing, cluster NTP time server will not be changed. See also scale_computing.hypercore.time_server.
time_zone string	Cluster time zone. If missing, cluster time zone will not be changed. See also scale_computing.hypercore.time_zone.
scale_computing_hypercore_cluster_config dictionary	DEPRECATED, will be removed in release 3.0.0. Please use cluster_config_configuration instead.
dns dictionary	DNS configuration. If missing, cluster DNS configuration will not be changed. See also scale_computing.hypercore.dns_config.
search_domains list / elements=string	DNS search domain.
server_ips list / elements=string	DNS resolver IP.
email_alerts list / elements=string	Email addresses that will receive email alerts. If missing, Email alert recipients will not be changed. See also scale_computing.hypercore.email_alert.
name string	Cluster name. If missing, cluster name will not be changed. See also scale_computing.hypercore.cluster_name.
oidc dictionary	OpenID connect configuration allows using Microsoft Azure as authentication backend. If missing, cluster OpenID connect configuration will not be changed. See also scale_computing.hypercore.oidc_config.
certificate string	OIDC client certificate, PEM encoded.
client_id string / required	OIDC client ID.
config_url string / required	OIDC configuration URL (for example, https://auth.example.com/.well-known/openid-configuration).
scopes string / required	OIDC client scopes.
shared_secret string	OIDC client secret.
registration dictionary	Cluster registration data. If missing, cluster registration data will not be changed. See also scale_computing.hypercore.registration.
company_name string / required	Company name
contact string / required	Technical contact first and second name
email string / required	Technical contact email address
phone string / required	Technical contact phone number
smtp dictionary	Cluster SMTP server configuration. If missing, cluster SMTP server will not be changed. See also scale_computing.hypercore.smtp.
auth_password string	Password to authenticate against SMTP server.
auth_user string	Username to authenticate against SMTP server.
from_address string / required	The “From” email address for email alerts.
port integer / required	SMTP server TCP port.
server string / required	SMTP server (IP or DNS name).
use_ssl boolean	Use SSL/TLS encryption between HyperCore and SMTP server. Choices: false true
syslog_servers list / elements=dictionary	Cluster syslog server configuration. If missing, cluster syslog server will not be changed. See also scale_computing.hypercore.syslog_server.
host string / required	Syslog server IP address or DNS name.
port integer	The IP port syslog server is listening to.
protocol string	Syslog IP protocol. Choices: "udp" "tcp"
time_server string	Cluster NTP time server. If missing, cluster NTP time server will not be changed. See also scale_computing.hypercore.time_server.
time_zone string	Cluster time zone. If missing, cluster time zone will not be changed. See also scale_computing.hypercore.time_zone.

Collection links

• Issue Tracker
• Repository (Sources)