Skip to content

Commit

Permalink
Fixed README file according to validated content preference.
Browse files Browse the repository at this point in the history
  • Loading branch information
RanabirChakraborty committed Sep 10, 2024
1 parent 5f3f5cb commit 6351ac4
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Provision and deploy a Red Hat Build of Keycloak authentication service on multi

### Use case of rhbk-datagrid-aws collection

The primary use case of the `rhbk-datagrid-aws` collection is to install Red Hat Build of Keycloak (RHBK) with high availability (HA) across multiple AWS regions. This ensures that the authentication service is resilient, fault-tolerant, and capable of serving users even in the event of a regional failure. By leveraging AWS infrastructure, the collection automates the setup of RHBK in a highly available architecture, integrating with Data Grid for distributed caching and ensuring smooth, secure authentication.

### 0. prerequisites

Expand Down Expand Up @@ -56,16 +57,26 @@ This key pair will be used by ansible to connect to the EC2 instances.

### 4. domain names and certificates

* Update the configuration to reflect your domain and certificate details for secure access.

### 5. edit the configuration

### edit the configuration
To edit the configuration, you would need to modify the ansible.cfg file and relevant playbook variables. This includes:

* Setting the private_key_file path in ansible.cfg to allow Ansible to connect to EC2 instances.
* Specifying AWS regions, database information, and TLS certificates in the playbooks or group variables (typically located in group_vars/).
* Configuring other parameters like the domain names for Keycloak and Data Grid.

### run the infra provisioning
These configurations ensure the infrastructure is tailored to your specific setup requirements before provisioning and deploying.

### 6. run the infra provisioning

Inside `playbooks/roles` path we have `infra-up.yml` and `infra-down.yml` run both according to you need.

### run the deployment of data_grid and rhbk

Inside `playbooks/roles` path we have `deploy.yml` playbook to deploy data_grid and rhbk.

## License

[Apache License Version 2.0](https://github.com/ansible-middleware/rhbk-datagrid-aws/blob/main/LICENSE)

0 comments on commit 6351ac4

Please sign in to comment.