BeAPI Framework Configuration
Once you have completed installation, you will next need to configure your environment. Follow these configuration steps in order to get your environment setup and working:
Settings
Since this is an API application, people will want to get into the nuts an bolts of configuring this so we also supply some of the more advanced configuration settings:
- JVM Args: Should you need to tweak the default config, you will find the JVM Args in the demo-application's build.gradle; there is a section that looks like the following:
application { mainClass = 'demo.application.Application' applicationDefaultJvmArgs = ["-Xms1024m -Xmx2048m -XX:+UseParallelGC -XX:ParallelGCThreads=4 -XX:MaxGCPauseMillis=200 -XX:MaxGCMinorPauseMillis=75 -server -noverify -Xshare:off -Djava.net.preferIPv4Stack=true -XX:+EliminateLocks -XX:GCTimeRatio=7 -Djava.security.egd=file:/dev/urandom"] } - SSL: No SSL is required; SSL should be being done at your load balancer so that it is checked for ALL SERVERS and then can send an HTTP tunnel to the regular servers. Should you need SSL, you will have to set that up yourself as that is not provided for the demo-application
API Configuration
Once you have created your project, you will need to edit your 'beapi_api.yaml' file in your demo-application/src/main/resources directory.
Don't be intimidated! You only need to change the values beginning with the word (CHANGE):
API
procCores: (CHANGE)
Change this to the number of processors your machine has; if running on AWS/Google/SpringCloud, this will be your HyperThreads/vCPU number.chainingenabled: (optional)
These will toggle chaining functionality on / off.batchingenabled: (optional)
These will toggle batching functionality on / off.iostateDir: (optional)
if you downloaded your config into a different directory (or named it something else) as well as the .iostate directory.
SECURITY
superUserRole / userRole:
These are used to help define networkGroups and for bootstrapping. These do not have to be changed for the DEMO-APPLICATION but if you are building your own application, you will want to put in the ROLES from your OWN SYSTEM.
BOOTSTRAP
superUser/login: (CHANGE)
Superuser that is bootstrapped with your application (also used for functional testing)superUser/password: (CHANGE)
Superuser that is bootstrapped with your application (also used for functional testing)superUser/email: (CHANGE)
Superuser that is bootstrapped with your application (also used for functional testing)testUser/login: (CHANGE)
Testuser that is bootstrapped with your application (also used for functional testing)testUser/password: (CHANGE)
Testuser that is bootstrapped with your application (also used for functional testing)testUser/email: (CHANGE)
Testuser that is bootstrapped with your application (also used for functional testing)