Modify roles README for consistency.

Modify examples in server and replica roles for consistency with client
role, by defining language for code blocks.
This commit is contained in:
Rafael Guterres Jeffman
2020-02-12 20:47:33 -03:00
parent 84aab60dd3
commit 1875dd6cb2
2 changed files with 107 additions and 82 deletions

View File

@@ -47,15 +47,19 @@ Usage
Example inventory file with fixed principal using auto-discovery with DNS records: Example inventory file with fixed principal using auto-discovery with DNS records:
```ini
[ipareplicas] [ipareplicas]
ipareplica1.example.com ipareplica1.example.com
ipareplica2.example.com ipareplica2.example.com
[ipareplicas:vars] [ipareplicas:vars]
ipaadmin_principal=admin ipaadmin_principal=admin
```
Example playbook to setup the IPA client(s) using principal from inventory file and password from an [Ansible Vault](http://docs.ansible.com/ansible/latest/playbooks_vault.html) file: Example playbook to setup the IPA client(s) using principal from inventory file and password from an [Ansible Vault](http://docs.ansible.com/ansible/latest/playbooks_vault.html) file:
```yaml
---
- name: Playbook to configure IPA replicas - name: Playbook to configure IPA replicas
hosts: ipareplicas hosts: ipareplicas
become: true become: true
@@ -65,9 +69,12 @@ Example playbook to setup the IPA client(s) using principal from inventory file
roles: roles:
- role: ipareplica - role: ipareplica
state: present state: present
```
Example playbook to unconfigure the IPA client(s) using principal and password from inventory file: Example playbook to unconfigure the IPA client(s) using principal and password from inventory file:
```yaml
---
- name: Playbook to unconfigure IPA replicas - name: Playbook to unconfigure IPA replicas
hosts: ipareplicas hosts: ipareplicas
become: true become: true
@@ -75,9 +82,11 @@ Example playbook to unconfigure the IPA client(s) using principal and password f
roles: roles:
- role: ipareplica - role: ipareplica
state: absent state: absent
```
Example inventory file with fixed server, principal, password and domain: Example inventory file with fixed server, principal, password and domain:
```ini
[ipaserver] [ipaserver]
ipaserver.example.com ipaserver.example.com
@@ -90,9 +99,12 @@ Example inventory file with fixed server, principal, password and domain:
ipaadmin_principal=admin ipaadmin_principal=admin
ipaadmin_password=MySecretPassword123 ipaadmin_password=MySecretPassword123
ipadm_password=MySecretPassword456 ipadm_password=MySecretPassword456
```
Example playbook to setup the IPA client(s) using principal and password from inventory file: Example playbook to setup the IPA client(s) using principal and password from inventory file:
```yaml
---
- name: Playbook to configure IPA replicas with username/password - name: Playbook to configure IPA replicas with username/password
hosts: ipareplicas hosts: ipareplicas
become: true become: true
@@ -100,7 +112,7 @@ Example playbook to setup the IPA client(s) using principal and password from in
roles: roles:
- role: ipareplica - role: ipareplica
state: present state: present
```
Playbooks Playbooks
========= =========

View File

@@ -42,8 +42,7 @@ Requirements
Limitations Limitations
----------- -----------
External signed CA **External signed CA**
External signed CA is now supported. But the currently needed two step process is an issue for the processing in a simple playbook. External signed CA is now supported. But the currently needed two step process is an issue for the processing in a simple playbook.
Work is planned to have a new method to handle CSR for external signed CAs in a separate step before starting the server installation. Work is planned to have a new method to handle CSR for external signed CAs in a separate step before starting the server installation.
@@ -54,6 +53,7 @@ Usage
Example inventory file with fixed domain and realm, setting up of the DNS server and using forwarders from /etc/resolv.conf: Example inventory file with fixed domain and realm, setting up of the DNS server and using forwarders from /etc/resolv.conf:
```ini
[ipaserver] [ipaserver]
ipaserver2.example.com ipaserver2.example.com
@@ -62,9 +62,12 @@ Example inventory file with fixed domain and realm, setting up of the DNS server
ipaserver_realm=EXAMPLE.COM ipaserver_realm=EXAMPLE.COM
ipaserver_setup_dns=yes ipaserver_setup_dns=yes
ipaserver_auto_forwarders=yes ipaserver_auto_forwarders=yes
```
Example playbook to setup the IPA server using admin and dirman passwords from an [Ansible Vault](http://docs.ansible.com/ansible/latest/playbooks_vault.html) file: Example playbook to setup the IPA server using admin and dirman passwords from an [Ansible Vault](http://docs.ansible.com/ansible/latest/playbooks_vault.html) file:
```yaml
---
- name: Playbook to configure IPA server - name: Playbook to configure IPA server
hosts: ipaserver hosts: ipaserver
become: true become: true
@@ -74,9 +77,12 @@ Example playbook to setup the IPA server using admin and dirman passwords from a
roles: roles:
- role: ipaserver - role: ipaserver
state: present state: present
```
Example playbook to unconfigure the IPA client(s) using principal and password from inventory file: Example playbook to unconfigure the IPA client(s) using principal and password from inventory file:
```yaml
---
- name: Playbook to unconfigure IPA server - name: Playbook to unconfigure IPA server
hosts: ipaserver hosts: ipaserver
become: true become: true
@@ -84,9 +90,11 @@ Example playbook to unconfigure the IPA client(s) using principal and password f
roles: roles:
- role: ipaserver - role: ipaserver
state: absent state: absent
```
Example inventory file with fixed domain, realm, admin and dirman passwords: Example inventory file with fixed domain, realm, admin and dirman passwords:
```ini
[ipaserver] [ipaserver]
ipaserver.example.com ipaserver.example.com
@@ -95,9 +103,12 @@ Example inventory file with fixed domain, realm, admin and dirman passwords:
ipaserver_realm=EXAMPLE.COM ipaserver_realm=EXAMPLE.COM
ipaadmin_password=MySecretPassword123 ipaadmin_password=MySecretPassword123
ipadm_password=MySecretPassword234 ipadm_password=MySecretPassword234
```
Example playbook to setup the IPA server using admin and dirman passwords from inventory file: Example playbook to setup the IPA server using admin and dirman passwords from inventory file:
```yaml
---
- name: Playbook to configure IPA server - name: Playbook to configure IPA server
hosts: ipaserver hosts: ipaserver
become: true become: true
@@ -105,6 +116,7 @@ Example playbook to setup the IPA server using admin and dirman passwords from i
roles: roles:
- role: ipaserver - role: ipaserver
state: present state: present
```
Example playbook to setup the IPA primary with external signed CA using the previous inventory file: Example playbook to setup the IPA primary with external signed CA using the previous inventory file:
@@ -135,6 +147,7 @@ Sign with CA: This is up to you
Server installation step 2: Copy `<ipaserver hostname>-chain.crt` to the IPA server and continue with installation of the primary. Server installation step 2: Copy `<ipaserver hostname>-chain.crt` to the IPA server and continue with installation of the primary.
```yaml ```yaml
---
- name: Playbook to configure IPA server step3 - name: Playbook to configure IPA server step3
hosts: ipaserver hosts: ipaserver
become: true become: true