Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding custom keystore truststore configurations for the two roles #172

Open
wants to merge 9 commits into
base: 3.2.x
Choose a base branch
from
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,4 @@ hs_err_pid*

# Auto-generated .retry files
*.retry
.idea/
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,15 +163,29 @@ Add the configurations to the `custom.yml`. A sample is given below.
Follow the steps mentioned under `docs` directory to customize/create new Ansible scripts and deploy the recommended patterns.

#### Including custom Keystore and Truststore
If custom keystores and truststores are needed to be added, uncomment the below list in the yml file
##### Adding custom Keystore and Truststore configurations APIM role
If custom Keystores and Truststores are needed to be added for APIM role, uncomment the below list in the apim.yml file.
(located at `dev/group_vars/apim.yml`)
```
# security_file_list:
# - { src: '{{ security_file_location }}/wso2am/client-truststore.jks',
# dest: '{{ carbon_home }}/repository/resources/security/client-truststore.jks' }
# - { src: '{{ security_file_location }}/wso2am/wso2carbon.jks',
# dest: '{{ carbon_home }}/repository/resources/security/wso2carbon.jks' }
```
Then save the changed file and add the required file to the following locations:`files/security/apim/<path-to-file>`

##### Adding custom Keystore and Truststore configurations APIM Analytics role
If custom Keystores and Truststores are needed to be added for APIM Analytics role, uncomment the below list in the apim-analytics.yml file.
(located at `dev/group_vars/apim-analytics.yml`)
```
# security_file_list:
# - { src: '{{ security_file_location }}/wso2am-analytics/client-truststore.jks',
# dest: '{{ carbon_home }}/resources/security/client-truststore.jks' }
# - { src: '{{ security_file_location }}/wso2am-analytics/wso2carbon.jks',
# dest: '{{ carbon_home }}/resources/security/wso2carbon.jks' }
```
Then save the changed file and add the required files under `files/security/<product-home>/<path-to-file>`
Then save the changed file and add the required file to the following locations:`files/security/apim-analytics/<path-to-file>`

## Performance Tuning

Expand All @@ -188,7 +202,7 @@ Refer the below documentation on configuring key-stores for APIM and APIM-Analyt
Refer the below documentation on configuring persistent artifacts of the servers.
1. [Persistent artifacts of the servers](https://apim.docs.wso2.com/en/latest/install-and-setup/setup/reference/common-runtime-and-configuration-artifacts/)

Refer the below documentation on configuring Load-Balancers for your deoloyment.
Refer the below documentation on configuring Load-Balancers for your deployment.
1. [Load balancer configurations](https://apim.docs.wso2.com/en/latest/install-and-setup/setup/setting-up-proxy-server-and-the-load-balancer/configuring-the-proxy-server-and-the-load-balancer/)

## Previous versions of Ansible
Expand Down