devkitkat 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ed6fa28306bb394d6f6128300d955ce43eacd9ca81c6a06abe9ac29ea3232f0
-  data.tar.gz: 681ffd8da74c5a2f64e5e118caad29a15a7b99e92c8a7b21da0b9f5329d220ea
+  metadata.gz: e730a451bae542a99bfa35ea7f4f5c0eb3f65da04c1b6e686e3d8dce16770c07
+  data.tar.gz: e865d0c254cff4b007b2680ef0e61f62fff9cd2b1dbddb2c53dde21b888f4016
 SHA512:
-  metadata.gz: a8648ee8040928383c3e5129a4faa1d82233dd54a42cd71f7bf7273c532e3458212877e1f691229ae44172413d646f131bb11b695c6e58ff67774f412f82ee5e
-  data.tar.gz: f4f857bd6f21acc44e29ba53e1819638afa3a82bac2691592b7692e3e5a1897a238224280e376c294f55ae6e757939e7a8ff68a515640c75539a5eff2c4ddd67
+  metadata.gz: 7f1f690b3a05189d32ba031d8f1b5d40b92a7ca9879af34142c45dc07565f50459e56f65cfa48b4b1368c768d27ebfd6d13c342af11663cd5893b42c696789c1
+  data.tar.gz: f80a184c8992db158b4750d0c3421109f3ea0e74f51f94bb480e6e5b245cc8802998650b38cace5beb1cf0147b0bc68f71485ada2aedc8c446f52f3bf122b546

data/.gitlab-ci.yml

@@ -1,5 +1,12 @@
 image: ruby:2.6
 
+services:
+  - docker:19.03.1-dind
+
+variables:
+  DOCKER_HOST: tcp://docker:2375
+  DOCKER_TLS_CERTDIR: ""
+
 rspec:
   stage: test
   variables:
@@ -7,9 +14,12 @@ rspec:
     LC_ALL: C.UTF-8
   before_script:
   - apt-get update
-  - apt-get install -y cmake
-  - locale
-  - locale -a
+  - apt-get install -y cmake docker.io
+  - docker info
+  - pwd
   script:
+  - mkdir ../test
+  - cp -a . ../test
+  - cd ../test
   - bin/setup
   - bundle exec rspec

data/README.md

@@ -1,4 +1,4 @@
-[![pipeline status](https://gitlab.com/dosuken123/devkitkat-cicd/badges/master/pipeline.svg)](https://gitlab.com/dosuken123/devkitkat-cicd/commits/master)
+[![pipeline status](https://gitlab.com/dosuken123/devkitkat/badges/master/pipeline.svg)](https://gitlab.com/dosuken123/devkitkat/commits/master)
 
 # Devkitkat
 
@@ -6,17 +6,26 @@ Devkitkat is a framework for development kits. It lets you
 bootstrap separate services for running a complex application easily.
 This is especially helpful for local development that runs/compiles everything from source code.
 
+## Key concepts
+
+- It's an alternative solution of docker-compose.
+- It's an alternative solution of Makefile.
+- Convention over configuration. No need to write up complicated config file from scratch.
+- Prepare one image to work on everything (All you need is runnable VM not
+  fully fine-tuned containers/images for deployments)
+- Respect the best practice architecture of Cloud Native.
+- No more Makefile for bootstraping.
+
 ## Features
 
 This tool provides the following features:
 
-- Easy configuration, easiser than docker-compose.
-- Customizable/Flexible scripts for controlling services.
-- Logging command output dy default.
-- Respect the best practice architecture of Cloud Native.
-- Easy to run services in containers (Not available yet).
+- Maintain your services in clean and explicit architecture.
+- Control services with an easy and intuitive command.
+- Fully customizable scripts.
+- Logging everything by default.
+- Easy to run services in containers.
 - Distrubte machine resources to the cloud VM (Not available yet).
-- No more Makefile for orchestrating services.
 
 ## The only config file - `.devkitkat.yml`
 
@@ -25,25 +34,32 @@ download/prepare services. These are available keys.
 
 |Key                                         |Type        |Required|Default|Description|
 |---                                         |---         |---     |---|---|
-|`application:`                              |String      |Yes     |-|The name of the application that consists of the services|
-|`environment:type:`                         |String      |Yes     |-|The type of the environment. One of `local`, `docker` or `cloud`. Default is `local`.|
-|`environment:image:`                        |String      |Yes     |-|The docker image. Only effective when `type` is `docker` or `cloud`|
 |`services:`                                 |Hash        |Yes     |-|The services to run the application|
 |`services:<name>`                           |Hash        |Yes     |-|The service name e.g. `rails`, `db`, `redis`|
 |`services:<name>:repo: <value>`             |String      |No      |-|The git URL of the repository|
 |`services:<name>:<key>: <value>`            |Hash        |No      |-|The key and value of the environment variable. e.g. `POSTGRES_PASSWORD: abcdef`. |
+|`image:`                                    |String      |No      |-|The docker image. Only effective when `type` is `docker` or `cloud`|
 |`groups:`                                   |Hash        |No      |-|The groups of the services|
 |`groups:<name>: <service-names>`            |Hash        |No      |-|The name of the group and the service names|
+|`application:`                              |String      |No      |-|The name of the application that consists of the services|
 
 There are pre-occupied special keys, please do not use these keys in your config file: `services:system`, `services:self`
 
-## Sample `.devkitkat.yml`
+## Sample `.devkitkat.yml` that runs services in local environment
 
 ```yaml
-application: awesome-app
+services:
+  web:
+    repo: https://gitlab.com/gitlab-org/gitlab-ce.git
+    port: 1234
+  db:
+    port: 9999
+```
 
-environment:
-  type: local
+## Sample `.devkitkat.yml` that runs services in docker containers
+
+```yaml
+image: ruby:2.6
 
 services:
   web:
@@ -55,6 +71,11 @@ services:
 
 ## Devkitkat image
 
+The key concept is to prepare only one docker image to run services. It's just a
+virtual machine just like your local computer. You install native applications/runtime
+(such as postgresql) on your computer. We just need one workable image. So each
+service has an individual container which initialized from the single image.
+
 When you run your application with docker containers, you might need to write up
 [Dockerfile](https://docs.docker.com/engine/reference/builder/) and build the image at first,
 this often is time consuming and repeatable task.

data/lib/devkitkat/config.rb

@@ -2,6 +2,8 @@ module Devkitkat
   class Config
     DEVKITKAT_FILE_NAME = '.devkitkat.yml'
     HIDDEN_SERVICES = %w[system]
+    DEFAULT_APPLICATION_NAME = 'devkitkat'
+    DEFAULT_IMAGE = 'ubuntu:18.04'
 
     attr_reader :devkitkat_yml, :kit_root
 
@@ -33,15 +35,19 @@ module Devkitkat
     end
 
     def environment_type
-      devkitkat_yml.dig('environment', 'type') || 'local'
+      if devkitkat_yml.key?('image')
+        'docker'
+      else
+        'local'
+      end
     end
 
-    def environment_image
-      devkitkat_yml.dig('environment', 'image')
+    def image
+      devkitkat_yml.fetch('image', DEFAULT_IMAGE)
     end
 
     def application
-      devkitkat_yml.fetch('application', '')
+      devkitkat_yml.fetch('application', DEFAULT_APPLICATION_NAME)
     end
 
     def variables

data/lib/devkitkat/executor/docker.rb

@@ -13,6 +13,7 @@ module Devkitkat
       end
 
       def prepare
+        pull_image
         start_container
       end
 
@@ -48,7 +49,7 @@ module Devkitkat
       end
 
       def docker_image
-        config.environment_image
+        config.image
       end
   
       def container
@@ -84,6 +85,10 @@ module Devkitkat
         "/devkitkat"
       end
 
+      def pull_image
+        ::Docker::Image.create('fromImage' => docker_image)
+      end
+
       def start_container
         container.start
       end

data/lib/devkitkat/service.rb

@@ -152,7 +152,7 @@ See the log file: #{log_path}]
     end
 
     def add_script
-      names = command.args.any? ? command.args : %w[configure unconfigure start stop]
+      names = command.args.any? ? command.args : %w[configure unconfigure start]
 
       FileUtils.mkdir_p(script_dir)
 

data/lib/devkitkat/version.rb

@@ -1,3 +1,3 @@
 module Devkitkat
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: devkitkat
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shinya Maeda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2019-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler