Skip to content

Latest commit

 

History

History
209 lines (136 loc) · 4.72 KB

Ansible_Settings_Instruction.md

File metadata and controls

209 lines (136 loc) · 4.72 KB

Ansible setup instruction

Introduction

This is the setup document to launch Personium unit by ansible. Part 1 (Initial Configuration) must be completed, where Part 2 (Tuning Personium) modification is optional, based on the developers requirement.

Below are the files where modification is required.

Part 1 : Initial Configuration ✅

  • Items to be set initially
  • all elements inside /static_inventory/hosts file enclosed with {}, replace with the constructed server configuration.
  • Example
    master_token={Master_Token}

    # should be changed to

    master_token=abc123
  • Modify the hosts file as per instruction below

Common Server Setting

{Bastion_Private_IP}
# -> Specify the private IP of Bastion server
# EX: {Bastion_Private_IP}->172.31.10.248

{Web_Private_IP}
# -> Specify the private IP of Web server
# EX: {Web_Private_IP}->172.31.10.248

{AP_Private_IP}
# -> Specify the private IP of  AP server
# EX: {AP_Private_IP}->172.31.13.38

{ES_Private_IP}
# -> Set the private IP for ES server
# EX: {ES_Private_IP}->172.31.3.80

{NFS_Private_IP}
# -> Set the private IP for NFS server
# EX: {NFS_Private_IP}->172.31.13.38

{Ansible_Execution_User}
# -> Specify a user ansible execution
# EX: {Ansible_Execution_User}->root

{SSH_PrivateKey}
# -> Set the secret key in the absolute path for  ansible user ssh public key authentication
# EX: {SSH_PrivateKey}->/root/.ssh/id_rsa

{Web_Global_IP}
# -> Specify the global IP for Web server
# EX: {Web_Global_IP}->54.65.33.203

{Web_FQDN}
# -> Specify the FQDN for Web server(same as unit FQDN)
# EX: {Web_FQDN}->ec2-54-65-33-203.ap-northeast-1.compute.amazonaws.com

{Bastion_Network_Separation}
# -> Specify the network category for Bastion server
# EX: {Bastion_Network_Separation}->172.31.10.0/24

{WEB_Network_Separation}
# -> Specify the network category for WEB server
# EX: {WEB_Network_Separation}->172.31.10.0/24

{AP_Network_Separation}
# -> Specify the network category for AP server
# EX: {AP_Network_Separation}->172.31.13.0/24

{Master_Token}
# -> To authorize all kind of operation, set the master token (Strictly managed)
# EX: enable_mastertoken=true
#     {Master_Token}->abc123

{Path_Based_Cell_Url_Enabled}
# -> URL format to access cell*1
# -> true:path based cell url
# -> false:per cell fqdn url
# EX: {Path_Based_Cell_Url_Enabled}->false

*1.For explanation about URL format to access cell, please confirm here.

AP server

{PIO_LOGVOL}
# -> Specify the disk name for Personium log
# EX: {PIO_LOGVOL}->vdb

ES server

{ES_DATA_VOL}
# -> Specify the disk name for ES Data Log
# EX: {ES_DATA_VOL}->vdb

NFS server

{NFS_WEBDAV_VOL}
# -> Specify the disk name for NFS_WEBDAV
# EX: {NFS_WEBDAV_VOL}->vdc

Part 2 (Tuning Personium) ✅

  • Item to be set upon ansible execution(File destination : /group_vars/[group name].yml)
  • As an option, changing the recorded values of all .yml files under group_vars directory is possible. But basically, no modification is required unless server tuning is necessary.
  • By specifying the git branch name of personium_core and personium_engine in /group_vars/bastion.yml, you can build by specifying the version of Personium.(Default is master)

Web server (file destination : /group_vars/web.yml)

  tag_ServerType: web

  nginx_version: 1.14.2

  nginx_hm_version: 0.33

AP server (file destination : /group_vars/ap.yml)

  tag_ServerType: ap

  tomcat_xms: 1024m

  tomcat_xmx: 1024m

  tomcat_metaspace_size: 256m

  tomcat_max_metaspace_size: 256m

  lock_host: personium-nfs

  lock_port: 11211

  cache_host: personium-nfs

  cache_port: 11212

  cache_manager: memcached

  tomcat_version: 9.0.27

  commons_daemon_version : 1.2.2

  activemq_version: 5.15.8

ES server (file destination : /group_vars/es.yml)

  tag_ServerType: es

  version: 6.6.1

  es_heapsize: 3328

NFS server (file destination : /group_vars/nfs.yml)

  tag_ServerType: nfs

  memcached_version: 1.5.12

  memcached_lock_maxconn: 1024

  memcached_cache_maxconn: 1024

  # lock / cache instance
  cache_in_nfs: true

  lock_port: 11211

  cache_port: 11212

  # memcached cachesize
  memcached_lock_cachesize: 512

  memcached_cache_cachesize: 512

bastion server (file destination : /group_vars/bastion.yml)

  tag_ServerType: bastion

  personium_core_version : master

  personium_engine_version : master

Summary

In this document we tried to explain what are the file we require you to modify before executing ansible and build Personium unit. Please use this document as reference.