config_kit 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d87686cf24927b1e2bfb70a50dfb58e2cde955e5
+  data.tar.gz: 1635b8f74554c97e702ec4261846cde10435a6c8
+SHA512:
+  metadata.gz: f7965a88abcbbddaa6e0437f0fd7c61f371702c87b0beadf85074639548420d09132f1bff27a91a0a5be7570bd3a54b4169c4185d58ee7fb7bb8cccc0a39a55f
+  data.tar.gz: b51369d2c72f7c65c85b75eef778663a3c10794bcf1afb54ebc996e595f17403948f49563fcb392dfccbb2279b50324992527a732264e12babe14e0ce0aeda77

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# Vim
+*.swp
+*.swo
+
+# ctags
+tags
+
+#Mac
+.DS_Store
+tmp/
+
+.idea
+reports/
+target/
+log
+migrations/*.db

data/Gemfile

@@ -0,0 +1,11 @@
+source 'http://gems.sd.laxino.com'
+
+gem 'diplomat', '1.4.1'
+gem 'git', '1.3.0'
+group :test do
+  gem 'simplecov', '0.12.0'
+  gem 'rspec'
+  gem 'faker'
+  gem 'as-duration'
+  gem 'factory_girl'
+end

data/Gemfile.lock

@@ -0,0 +1,62 @@
+GEM
+  remote: http://gems.sd.laxino.com/
+  specs:
+    activesupport (5.1.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    as-duration (0.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    diplomat (1.4.1)
+      faraday (~> 0.9)
+      json
+    docile (1.1.5)
+    factory_girl (4.8.0)
+      activesupport (>= 3.0.0)
+    faker (1.7.3)
+      i18n (~> 0.5)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    git (1.3.0)
+    i18n (0.8.1)
+    json (2.1.0)
+    minitest (5.10.2)
+    multipart-post (2.0.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  as-duration
+  diplomat (= 1.4.1)
+  factory_girl
+  faker
+  git (= 1.3.0)
+  rspec
+  simplecov (= 0.12.0)
+
+BUNDLED WITH
+   1.14.6

data/README.md

@@ -0,0 +1,146 @@
+# Configuration Kit(config_kit)
+
+## Introduction
+
+config_kit is a tool to manage the application configuration using consul as back service as configuration store, and support configuration versioning, rollout or rollback control.
+
+## How to Use
+
+To understand config_kit, first we need to understand basic configuration management approaches using in config_kit. Next we will provide quick starting for you to experience config_kit functionalities.
+
+### Seven Types of Configuration Management
+
+config_kit provides command line(ck) to init, bootstrap, deploy, rollout, rollback for appication configuration
+
+* init: init is to initialize metadata for specific data center, which will including the informaction of data center name and entitled environment for the data center
+
+* describe: retrieve inforamation about all configuration or app configuration
+
+>describe all information of configuration
+
+```bash
+ck describe
+```
+
+>describe one application information of configuration
+
+```bash
+ck describe --app axle
+```
+
+>describe specified version of an application of configuration
+
+```bash
+ck describe --app axle --version 1.0.0
+```
+
+
+* get: get is to retrive the full contents of the configuration
+
+>get current version full configuration information
+
+```bash
+ck get
+```
+
+>get current version full configuration information and output to yaml format
+
+```bash
+ck get -o yaml
+```
+
+>get current version full configuration of an application
+
+```bash
+ck get --app axle -o yaml
+```
+
+>get specify version configuration of an application
+
+```bash
+ck get --app axle --version 1.0.0 -o yaml
+```
+
+* bootstrap: bootstrap is to create a application configuration tied specified version, and will not take active after bootstrap.
+
+>bootstrap from file
+
+```shell
+ck bootstrap --from-file file:///config/int0 --app all --version 1.0.0
+```
+
+>bootstrap from git
+
+```bash
+ck bootstrap --from-git ssh://git_repository/config.git --app all --version=1.0.0
+```
+
+* deploy: deploy is not only to creat a application configuration, but also set as default configuration for active after deploy
+
+* rollout: rollout is to activate specified version.
+
+* rollback: TBD
+
+### Setup Consul Storage
+
+To setup consul, we using docker to run a testing consul server, if you need a consul server in production, pls using stack file in cluster folder.
+
+```
+docker container run -d --name=consul -p 8400:8400 -p 8500:8500 -p 8600:53/udp consul
+```
+
+You can open urs http://localhost:8500 to access UI of consul
+
+### Prepare the configuration data
+
+To create configuration data, pls refere to README in config folder, and two configuration data for axle and infra is placed in same folder as well.
+
+### Default Setting of config_kit
+
+In order to simplified process for new user, we have default settings in config_kit to shorten start step for new user.
+
+In config_kit
+
+* default consul server: http://localhost:8500
+* default configuration data: ./config (where example configuration is ready for you)
+
+### Let's Go
+
+Assume consul container is up and running, so we can use deploy command to deploy the first configuration in config folder
+
+```
+ck bootstrap
+```
+
+Then open http://localhost:8500 to check the configuration data.
+
+### How to manage configuration data
+
+### Todo
+
+#### Cli
+- [ ] provide deployment summary for deploy command;
+- [ ] provide bootstrp summary for bootstrap command;
+- [ ] provide rollback summary for rollback command;
+- [ ] provide rollout summary fro rollout command;
+- [ ] support --pretty options in get command for output formatting;
+- [ ] enhance error output for all comamnds;
+
+#### Configuration
+- [X] support change configuration throught environment;
+
+#### Data Loader
+- [ ] support load configuration data from git repository;
+- [ ] support checksum for loaded data;
+- [ ] join all array elements with comma;
+
+#### Doc
+- [ ] provide writing configuration data file guideline;
+- [ ] complete manage configuration data section;
+
+#### Manager
+- [ ] provide API to integrate with d13n, which can get configuration data from application;
+
+## Thank you!
+Pls let me know if you have any problems.
+

data/bin/ck

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << File.expand_path(File.join(File.dirname(__FILE__), '..','lib'))
+require 'config_kit/cli/command'
+begin
+  ConfigKit::Cli::Command.run
+rescue ConfigKit::Cli::Command::CommandFailure => failure
+  STDERR.puts failure.message
+  STDERR.puts failure.options if failure.options
+  exit 1
+end

data/cluster/consul.yml

@@ -0,0 +1,64 @@
+version: '3.1'
+
+#customise this with options from
+#https://www.consul.io/docs/agent/options.html
+
+services:
+
+  seed:
+    image: consul:latest
+    deploy:
+      restart_policy:
+        condition: none  #we do not want this to be restarted on timeout (see entrypoint options below)
+      replicas: 1
+      placement:
+        constraints:
+          - 'node.role != manager'
+    environment:
+      - "CONSUL_BIND_INTERFACE=eth0"
+    entrypoint:
+      - timeout     #this seed fires up the cluster after which it is no longer needed
+      - -sTERM      #this is the same signal as docker would send on a scale down / stop
+      - -t300       #terminate after 5 mins
+      - consul
+      - agent
+      - -server
+      - -bootstrap-expect=3
+      - -data-dir=/tmp/consuldata
+      - -advertise={{ GetInterfaceIP "eth0" }}
+    networks:
+      - "consul"
+
+  cluster:
+    image: consul:latest
+    depends_on:
+      - "seed"
+    deploy:
+      mode: global                                      ##this will deploy to all nodes that
+      placement:
+        constraints:
+          - 'node.role == manager'
+    environment:
+      - "CONSUL_LOCAL_CONFIG={\"disable_update_check\": true}"
+      - "CONSUL_BIND_INTERFACE=eth0"
+      - "CONSUL_HTTP_ADDR=0.0.0.0"
+    entrypoint:
+      - consul
+      - agent
+      - -server
+      - -data-dir=/tmp/consuldata
+      - -bind={{ GetInterfaceIP "eth0" }}
+      - -client=0.0.0.0
+      - -retry-join=seed:8301
+      - -disable-host-node-id=true
+      - -advertise={{ GetInterfaceIP "eth0" }}
+      - -ui                                              ##assuming you want the UI on
+    networks:
+      - "consul"
+    ports:
+      - "8500:8500"
+      - "8600:8600"
+
+networks:
+  consul:
+    driver: overlay

data/config/README.md

@@ -0,0 +1,134 @@
+# Configuration Kit(config_kit)
+
+Configuration Kit is tool kit to handle application configuration which need to specified with deployment environment, so that all the configuration for the deployment environment can be isolated from application code phrase(which is including three phrase only, they are test, development and production). Finally, we can archive build once and run everywhere.
+
+## Design Detail
+
+We are use consul as configration data store and reply on its high avaibility and reliabilty to maintain and provide robust configuration management service for all running docker container.
+
+### Configruation Data Source Structure
+
+Config kit will support two type of data source, which are local file directory and git source repository structure
+
+#### Local File Directory
+
+Assum local file data source is located in current_path/config, under this config folder we will separate all config data per deployment environment and application, which will share one same infra configuration data within this deployment environment.
+
+Here is an example
+
+* file:///./config/int0/int0.infra.yml
+* file:///./config/int0/int0.axle.yml
+* file:///./config/int0/int0.belt.yml
+
+Above is for integration0 environment. Similarily, for staging0 environment, we can have below configuration data file structure:
+
+* file:///./config/stg0/stg0.infra.yml
+* file:///./config/stg0/stg0.axle.yml
+* file:///./config/stg0/stg0.belt.yml
+
+#### Git source repository
+
+Similary with local file, we will define the following structure in git repository
+
+* git://git_repos/config_kit.git/int0/int0.infra.yml
+* git://git_repos/config_kit.git/int0/int0.axle.yml
+* git://git_repos/config_kit.git/int0/int0.belt.yml
+* git://git_repos/config_kit.git/stg0/stg0.infra.yml
+* git://git_repos/config_kit.git/stg0/stg0.axle.yml
+* git://git_repos/config_kit.git/stg0/stg0.belt.yml
+
+### K/V Structure
+
+Since consul is KV storage and we use this property to store all the configuration.
+
+Application Configuration
+
+* /v1/config_kit/axle/v1.0/database => 'mysql'
+
+Deployment Configuration:
+
+* /v1/config_kit/deploy/axle/default => v1.0
+* /v1/config_kit/deploy/axle/v1.0/ts => 201705061235 # Timestamp
+* /v1/config_kit/deploy/axle/v1.0/cm => b193bc91     # Checksum or git commit hash
+
+## Configuration List
+
+### Description
+
+ * key: reference key in Axle.config, which is symble. If key is dotted, you need to single quote to reference it as symble such as Axle.config[:
+ 'service.schedule.base_path'].
+ * default: it is default value of this configuration.
+ * type: Ruby data type of this configuration.
+ * allowed_from_server: It can be overwrited by config-kit from server side.
+ * description: describe the information of configuration.
+ * deprecated: indicate configuration is deprecated or not.
+
+### Axle
+
+#### Configuration Catagory
+
+* default: No prefix and including axle service host, port etc..
+* service: containe the configuration of service host, port and endpoint path etc...
+* database: containe the configuration of database host name, port, username and password etc...
+* jackpot: containe the configuration about Jackpot such alert configuration...
+* game: containe the configuration for game;
+* alert: container the configuration for alert;
+
+Pls follow the catagory mentioned above with proper prefix to named the configuration list below.
+
+#### Config Data
+| key     | default | type | allowed_from_server | description         | deprecated |
+|---------|---------|------|---------------------|---------------------|-------------|
+| port    | 3000    | Integer | false | Define service port. | false |
+| host    | 'localhost' | String | false | Define Service host. | false |
+| log_file_name | 'axle.log' | String | false | log file name | false |
+| log_level | 'info' | String | false | Sets the level of logger.  | false |
+| log_file_path | 'stdout' | String | false | Define a path to the log file, excluding the filename. | false |
+| config_path | DefaultSource.config_path | String | false | Path to <b>axle.yml</b>. If undefined, the agent checks the following directories (in order): <b>config/axle.yml</b>, <b>axle.yml</b>, <b>$HOME/.axle/axle.yml</b> and <b>$HOME/axle.yml</b>. | false |
+| config_search_path | DefaultSource.config_search_paths | String | false | An array of candidate locations for the service\'s configuration file. | false |
+| service.action.base_path | '/action' | String | false | Defines base path for action service endpoint. | false |
+| service.schedule.base_path | '/schedule' | String | false | Defines base path for schedule service endpoint. | false |
+| service.loopback.base_path | '/loopback' | String | false | Defines base path for loopback service endpoint. | false |
+| service.operation.base_path | '/operation' | String | false | Defines base path for operation service endpoint. | false |
+| database.adapter  | 'mysql2'    | String | true | database adapter for sequel | false |
+| database.host     | 'localhost' | String | true | database server hostname | false |
+| database.port     | 3306        | Integer | true | database server port | false |
+| database.username | 'laxino'    | String | true | database server username | false |
+| database.passward | 'passord'   | String | true | database password | false |
+| database.database | 'g2_axle_production' | String | true | database name | false |
+| jackpot.submit_status.#{property_id}.path | 'http://games.83suncity.local' | String | true | Jackpot Status Submission Path | false |
+| jackpot.submit_status.#{property_id}.secret_access_key | 'akjlasdfasdfalas;sdkfajs' | String | true | Jackpot Status Submission Secret | false |
+| jackpot.submit_status.#{property_id}.stats_postfix | 'jackpotstats' | String | true | Jackpot Status Submission Stats Postfix | false |
+| jackpot.submit_status.#{property_id}.post_with_content_md5 | true | Boolean | true | Jackpot Status ON/OFF Context md5 Checksum | false |
+| jackpot.allow_debug_mode | false | Boolean | false | 'Jackpot debug mode ON/OFF' | false |
+| service.fams.host | 'fams' | String | true | 'FAMS host name' | false |
+| service.fams.port | 80 | Integer | true | 'FAMS host name' | false |
+| service.fams.bet_path | '/fund_adapter/bet' | String | false | 'FAMS result path.' | false |
+| service.fams.cancel_bet_path | '/fund_adapter/cancel_bet' | String | false | 'FAMS cancel bet path.' | false |
+| service.fams.query_balance_path | '/fund_adapter/query_player_balance' | String | false | 'FAMS query player balance path.' | false |
+| service.fams.get_balance_path | '/get_player_balance_info' | String | false | 'FAMS get player balance info path.' | false |
+| service.rap.host | 'rap' | String | true | 'RAP host name' | false |
+| service.rap.port | 80 | Integer | true | 'RAP service port' | false |
+| service.rap.get_token_path | '/get_third_party_token' | String | false | 'RAP service port' | false |
+| service.sm.host | 'sm' | String | true | 'Station Management Service host name' | false |
+| service.sm.port | 80 | Integer | true | 'Station Management Service port' | false |
+| service.sm.message_path | '/messages/create.json' | String | false | 'Station Management Service message path' | false |
+| service.sm.validate_machine_token_path | '/validate_machine_token.json' | String | false | 'Station Management Service validate machine token path' | false |
+| service.anms.host | 'snms' | String | true | 'ANMS host name' | false |
+| service.anms.port | 80 | Integer | true | 'ANMS port' | false |
+| service.anms.request_send_alert_path | '/messages/request_send_alert.json' | String | false | 'ANMS message path' | false |
+| service.js.host | 'job_scheduler.com' | String | true | 'Job Scheduler host name' | false |
+| service.js.port | 80 | Integer | true | 'Job Scheduler Service Port' | false |
+| service.js.message_path | '/messages/create.json' | String | false | 'Job Scheduler Service message path' | false |
+| service.self_schedule_host | 'axle.com' | String | true | 'axle schedule url' | false |
+| player.token_secret | 'secret' | String | false | 'Player token (JWT) secret key.' | false |
+| alert.mail_server | 'moexc01.mo.laxino.com' | String | true | 'alert mail server.' | false |
+| game.allow_test_mode | false | Boolean | false | 'Allow test mode player ON/OFF' | false |
+| alert.big_win.property_ids | [20000] | Array | false | 'Properties that need to send big win alert mail' | false |
+| alert.big_win.mail_context.serverity | 2 | Integer | false | 'Big win alert mail serverity' | false |
+| alert.jackpot.win.mail_recipient | 'lm.cs@laxino.com' | String | true | Jackpot Win Alert Mail Recipient | false |
+| alert.jackpot.win.mail_context.serverity | 2 | Integer | true | serverity of Jackpot Win Alert | false |
+| alert.jackpot.win.anms_property_ids | [20000] | Array | false | 'Properties that need to send jackpot win alert mail by ANMS' | false |
+| alert.jackpot.submit_status.exception.mail_recipient | 'lm.cs@laxino.com' | String | true | Jackpot Status Submision Exception Mail Recipient | false |
+| alert.jackpot.submit_status.exception.mail_context.serverity | 2 | Integer | true | Serverity of Jackpot Status Submision Exception Mail | false |
+| alert.jackpot.snapshot_report.mail_recipient | 'lm.cs@laxino.com' | String | true | Jackpot Snapshot Report Recipient | false |