// Module included in the following assemblies:
//
// assembly-installing-openshift.adoc

[id='installing-using-ansible-{context}']
= Installing {ProductName} using Ansible

Installing {ProductName} using Ansible requires creating an inventory file with the variables for
configuring the system. Example inventory files can be found in the `ansible/inventory` folder.

An example inventory file that enables both the API server and service broker integration:

[source,options="nowrap"]
.link:service_admin/example.inventory[example.inventory]
----
include::../service_admin/example.inventory[]
----

The following Ansible configuration settings are supported:

.Ansible Configuration Settings
|===
|Name |Description |Default value| Required
|namespace|Specifies the namespace where {ProductName} is installed.|Not applicable |yes
|enable_rbac|Specifies whether to enable RBAC authentication of REST APIs.|True |no
|service_catalog|Specifies whether to enable integration with the Service Catalog.|False |no
|authentication_services|Specifies the list of authentication services to deploy. `none` and `standard` are supported. |`none` |no
|keycloak_admin_password|Specifies the admin password to use for the standard authentication service Keycloak instance. |Not applicable |yes (if `standard` authentication service is enabled)
|api_server|Specifies whether to enable the REST API server.|True |no
|register_api_server|Specifies whether to register the API server with Kubernetes master.|False |no
|secure_api_server|Specifies whether to enable mutual TLS for the API server.|False |no
|enable_monitoring|Specifies whether to enable the monitoring services|Not applicable|no
|smtp_server|Specifies the SMTP server used to send alert emails|Not applicable|no
|smtp_username|Specifies the username used to authenticate to the SMTP server|Not applicable|no
|smtp_password|Specifies the password used to authenticate to the SMTP server|Not applicable|no
|smtp_from_address|Specifies the from address displayed in alert emails|Not applicable|no
|sysadmin_email|Specifies the email address to which alerts are sent|Not applicable|no
|===


.Procedure

. (Optional) Create an inventory file.

. Run the Ansible playbook:
+
[options="nowrap",subs="+quotes,attributes"]
----
ansible-playbook -i _inventory-file_ ansible/playbooks/openshift/deploy_all.yml
----

