This repository contains the Puppet Module for installing and configuring WSO2 Identity Server on various environments. It supports multiple versions of WSO2 Identity Server. Configuration data is managed using Hiera. Hiera provides a mechanism for separating configuration data from Puppet scripts and managing them in a separate set of YAML files in a hierarchical manner.

• Debian 6 or higher
• Ubuntu 12.04 or higher

• Puppet 2.7, 3 or newer

Follow the steps mentioned in the wiki to setup a development environment and update/create new puppet modules.

Copy the following files to their corresponding locations.

1. WSO2 Identity Server distribution (5.1.0) to <PUPPET_HOME>/modules/wso2is/files
2. JDK 1.7_80 distribution to <PUPPET_HOME>/modules/wso2base/files

Note: For wso2is_km puppet module use WSO2 Identity Server 5.1.0 distribution which has API Key Manager feature installed on it. If you are using the pre-packaged WSO2 Identity Server 5.1.0 Key Manager pack with Secure Vault enabled, extract the product zip file, remove authenticationendpoint folder in CARBON_HOME/repository/deployment/server/webapps, compress the pack and then copy it to <PUPPET_HOME>/modules/wso2is_km/files. For more details, refer step 4 under Running WSO2 Identity Server Key Manager with Secure Vault.

No changes to Hiera data are required to run the default profile. Copy the above mentioned files to their corresponding locations and apply the Puppet Modules.

No changes to Hiera data are required to run the distributed deployment of WSO2 Identity Server, other than pointing to the correct resources such as the deployment synchronization and remote DB instances. For more details refer the WSO2 Identity Server 5.1.0 and WSO2 Identity Server 5.0.0 clustering guides.

1. If the Clustering Membership Scheme is WKA, add the Well Known Address list.

   Ex:

   wso2::clustering :
       enabled: true
       local_member_host: "%{::ipaddress}"
       local_member_port: 4000
       membership_scheme: wka
       sub_domain: mgt
       wka:
          members:
            -
              hostname: 192.168.100.113
              port: 4000
            -
              hostname: 192.168.100.114
              port: 4000

2. Add external databases to master datasources

   Ex:

   wso2::master_datasources:
     wso2_config_db:
       name: WSO2_CONFIG_DB
       description: The datasource used for config registry
       driver_class_name: "%{hiera('wso2::datasources::mysql::driver_class_name')}"
       url: jdbc:mysql://mysql-is-db:3306/IS_DB?autoReconnect=true
       username: "%{hiera('wso2::datasources::common::username')}"
       password: "%{hiera('wso2::datasources::common::password')}"
       jndi_config: jdbc/WSO2_CONFIG_DB
       max_active: "%{hiera('wso2::datasources::common::max_active')}"
       max_wait: "%{hiera('wso2::datasources::common::max_wait')}"
       test_on_borrow: "%{hiera('wso2::datasources::common::test_on_borrow')}"
       default_auto_commit: "%{hiera('wso2::datasources::common::default_auto_commit')}"
       validation_query: "%{hiera('wso2::datasources::mysql::validation_query')}"
       validation_interval: "%{hiera('wso2::datasources::common::validation_interval')}"
   

3. Configure registry mounting

   Ex:

   wso2_config_db:
     path: /_system/config
     target_path: /_system/config
     read_only: false
     registry_root: /
     enable_cache: true
   
   wso2_gov_db:
     path: /_system/governance
     target_path: /_system/governance
     read_only: false
     registry_root: /
     enable_cache: true

4. Configure deployment synchronization

   Ex:

   wso2::dep_sync:
       enabled: true
       auto_checkout: true
       auto_commit: true
       repository_type: svn
       svn:
          url: http://svnrepo.example.com/repos/
          user: username
          password: password
          append_tenant_id: true

WSO2 Carbon products may contain sensitive information such as passwords in configuration files. WSO2 Secure Vault provides a solution for securing such information.

For WSO2 Identity Server 5.0.0, which is based on WSO2 Carbon Kernel 4.2.0, org.wso2.ciphertool-1.0.0-wso2v2.jar in Kernel patch patch0010 has to be applied before enabling the Secure Vault. The org.wso2.ciphertool-1.0.0-wso2v2.jar in WSO2-CARBON-PATCH-4.2.0-0009/lib has to be copied to wso2is/files/configs/lib folder and added to the file_list in hiera file as below:

wso2::file_list :
  - lib/org.wso2.ciphertool-1.0.0-wso2v2.jar

Uncomment and modify the below changes in Hiera file to apply Secure Vault.

1. Enable Secure Vault

   wso2::enable_secure_vault: true

2. Add Secure Vault configurations as below

   wso2::secure_vault_configs:
     <secure_vault_config_name>:
       secret_alias: <secret_alias>
       secret_alias_value: <secret_alias_value>
       password: <password>

   Ex:

   wso2::secure_vault_configs:
     key_store_password:
       secret_alias: Carbon.Security.KeyStore.Password
       secret_alias_value: repository/conf/carbon.xml//Server/Security/KeyStore/Password,false
       password: wso2carbon

   For Identity Server 5.0.0 which is based on WSO2 Carbon Kernel 4.2.0

   Ex:

   wso2::secure_vault_configs:
     key_store_password:
       secret_alias: Carbon.Security.KeyStore.Password
       secret_alias_value: carbon.xml//Server/Security/KeyStore/Password,true
       password: wso2carbon

3. Add Cipher Tool configuration file templates to template_list

   wso2::template_list:
     - repository/conf/security/cipher-text.properties
     - repository/conf/security/cipher-tool.properties
     - bin/ciphertool.sh

   Please add the password-tmp template also to template_list if the vm_type is not docker when you are running the server in default platform.

4. For IS 5.1.0, encrypting KeyStore and TrustStore passwords in EndpointConfig.properties using Cipher Tool fails to deploy authenticationendpoint web app. This is due to a class loading issue as reported in JIRA: IDENTITY-4276. To fix this follow the below steps:

   • get the authenticationendpoint.war in CARBON_HOME/repository/deployment/server/webapps folder, remove the org.wso2.securevault-1.0.0-wso2v2.jar from webapp's WEB_INF/lib folder and add it to files/configs/repository/deployment/server folder
   • Add the authenticationendpoint.war file path to file_list in default.yaml file

   wso2::file_list:
     - repository/deployment/server/webapps/authenticationendpoint.war

WSO2 Puppet Module ships Hiera data required to deploy WSO2 Identity Server on Kubernetes. For more information refer to the documentation on deploying WSO2 products on Kubernetes using WSO2 Puppet Modules.