kontena-plugin-app-command 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2abc67629273b9e6c15006ff20de87faf5188d4e
+  data.tar.gz: daa28184df495745720b1b3e37405b630f24baef
+SHA512:
+  metadata.gz: 94a1e66085aa971577acf722382f5353ffe986a74b6f6110e1d0ad015fc3e82f54d973a93101da446ae7365fe19f4d7a2ae6679db165a2fa53e987760a3108cd
+  data.tar.gz: f693c1ea56742ec9284bd1e43dee3e646865142da3deec3cfdd3d9f25c90bb7cafd3fdaa156dea7932c5d2f8bf101e102973753fcabc04f7968ea270583bc2c5

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+*.gem
+/vendor/

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,21 @@
+sudo: required
+language: ruby
+services:
+- docker
+rvm:
+- 2.1.10
+- 2.2.6
+- 2.3.3
+- 2.4.1
+env:
+  global:
+    secure: lZ13zDiPIfKv6kd+dw93+UBgR+V5dEiwfcFOmPqhTbcdZKbBFYx7MX5l3pc3+T3W91O7To2xz+73f85OzDTyQn41HY6qrolwgQh/Pqo+8gbXu+eTN13qkUtr1RxLw0Qk+O697q85T1mM3GQd2IR5fdsyB3E56Z4Y2+NsA0YAXu7tuxGRsRgHg4B96/GxdLIKzF99TwqrZhxRncGgz76x7hN81K0kfRRKKWSx3fqXWdhM0KOZzxPbeyTaB46di2QHgyal5RqzqgFD0aWQ/wMxlkKebzajsG2ArHOccgH+2thXlMdRV6hjV9cEtNnAaTi2DypFbshoMTNN4Uox7L4kFlGXrikEownl8T66XYc05cdKiy8ekbhV0M7pKNcVSD7mwn68XZpqPsECpAI0QMgYTwGYN2DWdLVUBudYSFBhBkN7D7/HIdpN+s/Sszl5fpvZNnclVcZE/6s0X+2uDf6jurqm+Bel+e58JUm4KfWFVyMLM6NA7rq+zfOXzPOAivOTd9651o4w2Rot3GiuvnmNdS4rndaVpXdF4NT1/SHVDcJ5faqbaZ0/9498zUv8ylesOOnL0QUWG58xd6bsFYlgTfwR3TDlm6xFBsUvnxZhv3Lz0G/L4XRW1H2q6P/QfGt4JOje40+zUoCtjtI21MQcj19Lx1r5Vr6Fnf/aD6vdJDs=
+cache: bundler
+script: bundle install && bundle exec rspec spec/
+deploy:
+- provider: rubygems
+  api_key: "$GEM_TOKEN"
+  gem: kontena-plugin-app-command
+  on:
+    tags: true
+    rvm: 2.4.1

data/Dockerfile

@@ -0,0 +1,19 @@
+FROM alpine:3.5
+MAINTAINER Kontena, Inc. <info@kontena.io>
+
+RUN apk update && apk --update add tzdata ruby ruby-irb ruby-rdoc ruby-bigdecimal \
+    ruby-io-console ruby-json ca-certificates libssl1.0 openssl libstdc++
+
+ARG CLI_VERSION
+ADD . /app/build
+RUN apk --update add --virtual build-dependencies ruby-dev build-base && \
+    gem install bundler --no-ri --no-rdoc && \
+    cd /app/build && \
+    gem build kontena-plugin-app-command.gemspec && \
+    gem install --no-ri --no-rdoc kontena-plugin-aws kontena-plugin-shell && \
+    gem install --no-ri --no-rdoc `ls -t kontena-plugin-app-command*.gem|head -1` && \
+    rm -rf /app/build && \
+    apk del build-dependencies
+
+WORKDIR /app
+ENTRYPOINT kosh

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kontena-plugin-api_command.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,191 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2015 Kontena, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,299 @@
+# Kontena APP subcommand plugin
+
+This plugin adds back the "app" subcommand to kontena-cli which was removed in Kontena CLI V1.4.
+
+## Installation
+
+`kontena plugin install app-command`
+
+## Usage
+
+> Applications has been superceded by Stacks.
+
+Any kind of application can be easily deployed to Kontena using the Kontena `app` commands. With these commands, you can use Kontena like any regular PaaS platform. One of the most interesting features of Kontena is the ability to import projects from other common PaaS platforms.
+
+Kontena app commands include:
+
+* `kontena app init` - Initialize Application; Import from existing PaaS project
+* `kontena app deploy` - Deploy Application
+* `kontena app start` - Start Application
+* `kontena app stop` - Stop Application
+* `kontena app rm` - Remove Application
+* `kontena app ps` - List Application Services
+* `kontena app logs` - Display Application Logs
+* `kontena app monitor` - Monitor Application Service Instances
+* `kontena app show` - Display Application Service Details
+
+## Initializing Application
+
+The `kontena app init` command may be used to prepare your application to be run in Kontena. It will:
+
+* Create a `Dockerfile` file for your project if not already exists.
+* Create a `docker-compose.yml` file for your project if not already exists.
+* Create a `kontena.yml` file for your project if not already exists.
+
+The initialization will generate `Dockerfile`, `docker-compose.yml` and `kontena.yml` files automatically by inspecting the directory where the `kontena app init` command is executed. In the event that this directory contains files used by the [Heroku](https://www.heroku.com) PaaS platform, Kontena will automatically import Heroku settings.
+
+### Importing Heroku PaaS Platform Projects
+
+Heroku is one of the most widely used PaaS platform out there. Heroku projects are described with `app.json` and `Procfile` files located in the root of the project directory. When Kontena detects these files, it generates corresponding services, add-ons and environment variables for docker-compose.yml and kontena.yml. The functionality is very similar to Heroku's [Build and Deploy with Docker](https://devcenter.heroku.com/articles/docker)
+
+**Example**
+
+Given the following files:
+
+**app.json**
+
+```json
+{
+  "name": "Small Sharp Tool",
+  "description": "This app does one little thing, and does it well.",
+  "env": {
+    "SECRET_TOKEN": {
+      "description": "A secret key for verifying the integrity of signed cookies.",
+      "generator": "secret"
+    },
+    "WEB_CONCURRENCY": {
+      "description": "The number of processes to run.",
+      "value": "5"
+    }
+  },
+  "addons": ["heroku-redis","mongolab:shared-single-small"]
+}
+```
+
+**Procfile**
+
+```
+web: rackup -p $PORT -E production
+worker: RACK_ENV=production ruby ./worker.rb run
+```
+
+The command `kontena app init` will produce:
+
+**docker-compose.yml**
+
+```yaml
+web:
+  build: "."
+  command: "/start web"
+  env_file: ".env"
+  links:
+  - redis:redis
+  - mongolab:mongolab
+  environment:
+  - REDIS_URL=redis://redis:6379
+  - MONGOLAB_URI=mongolab:27017
+redis:
+  image: redis:latest
+mongolab:
+  image: mongo:latest
+worker:
+  build: "."
+  command: "/start worker"
+  env_file: ".env"
+  links:
+  - redis:redis
+  - mongolab:mongolab
+  environment:
+  - REDIS_URL=redis://redis:6379
+  - MONGOLAB_URI=mongolab:27017
+```
+
+**.env**
+
+```
+SECRET_TOKEN=41977498daabf8b0f0ffbae63ce8bb4cd137b4a5f89d28248abe27e49724da274794e6bcc7df60a2b2c54ecaf16487830eb6c65e1fcf5aabc6f9cab8d3e34d83
+WEB_CONCURRENCY=5
+```
+
+**kontena.yml**
+
+```yaml
+---
+web:
+  extends:
+    file: docker-compose.yml
+    service: web
+  image: registry.kontena.local/docker-twitter-stream:latest
+redis:
+  extends:
+    file: docker-compose.yml
+    service: heroku-redis
+mongolab:
+  extends:
+    file: docker-compose.yml
+    service: mongolab
+worker:
+  extends:
+    file: docker-compose.yml
+    service: worker
+  image: registry.kontena.local/docker-twitter-stream:latest
+```
+
+## Deploying Application
+
+Your application can be deployed to Kontena Nodes with a single command: `kontena app deploy`. The deploy process will look for the [kontena.yml](../references/kontena-yml.md) file (unless an alternative filename was specified), which is used to describe your application. Then, it will take care of everything needed to run your application. It will schedule services across your Nodes, pull required images, link services together, set environment variables, configure overlay networking, start the containers and more.
+
+The usage of the `kontena app deploy` command is as follows:
+
+```
+Usage:
+    kontena app deploy [OPTIONS] [SERVICE ...]
+
+Options:
+    -f, --file FILE               Specify an alternate kontena project file (default: kontena.yml)
+    -p, --project-name NAME       Specify an alternate project name (default: directory name)
+    -h, --help                    print help
+```
+
+**NOTE**: If you don't yet have the kontena.yml file in your project, you can get started with the `kontena app init` command.
+
+### Using Custom File to Describe Application
+
+By default, Kontena will search for the `kontena.yml` file in the current directory. If you want to specify the path to a custom file, you can use the `-f` switch.
+
+```
+$ kontena app deploy -f myapp.yml      # application described in myapp.yml file
+```
+
+### Project Name
+
+When an application is deployed, Kontena will prefix all service names with the name of your application. By default, Kontena uses the name of the current working directory. If you want to use a custom project name (prefix your application), you can do so via the `-p` switch.
+
+```
+/foo/bar $ kontena app deploy          # project name is bar, all services are prefixed "bar"
+/foo/bar $ kontena app deploy -p app   # project name is app, all services are prefixed "app"
+```
+
+### Deploying Partial Application
+
+Sometimes you might want to deploy just some parts of your application. If that's the case, you can define the name of those specific services that you want deployed.
+
+```
+$ kontena app deploy wordpress         # only deploy services named "wordpress" and "lb"
+```
+
+### Example `kontena.yml`
+
+Here's an example of a typical WordPress application described in `kontena.yml` file. See the complete kontena.yml reference [here](../references/kontena-yml.md).
+
+```yaml
+wordpress:
+  image: wordpress:4.1
+  instances: 2
+  stateful: true
+  ports:
+    - 8080:80
+  links:
+    - mysql:wordpress-mysql
+  env_file: wordpress.env
+  deploy:
+    strategy: ha
+    wait_for_port: 80
+mysql:
+  image: mariadb:5.5
+  stateful: true
+  environment:
+   - MYSQL_ROOT_PASSWORD=secret
+```
+
+## Stopping Application
+
+The `kontena app stop` command stops running services without removing them.
+
+```
+Usage:
+    kontena app stop [OPTIONS] [SERVICE] ...
+
+Parameters:
+    [SERVICE] ...                 Services to stop
+
+Options:
+    -f, --file FILE               Specify an alternate Kontena compose file (default: "kontena.yml")
+    -p, --project-name NAME       Specify an alternate project name (default: directory name)
+    -h, --help                    print help
+```
+
+You can start services again with `kontena app start`
+
+## Starting Application
+
+The `kontena app start` command starts existing services.
+
+```
+Usage:
+    kontena app start [OPTIONS] [SERVICE] ...
+
+Parameters:
+    [SERVICE] ...                 Services to start
+
+Options:
+    -f, --file FILE               Specify an alternate Kontena compose file (default: "kontena.yml")
+    -p, --project-name NAME       Specify an alternate project name (default: directory name)
+    -h, --help                    print help
+```
+
+## Remove Application
+
+You can remove an application's services with `kontena app rm`.
+
+```
+Usage:
+    kontena app rm [OPTIONS] [SERVICE] ...
+
+Parameters:
+    [SERVICE] ...                 Remove services
+
+Options:
+    -f, --file FILE               Specify an alternate Kontena compose file (default: "kontena.yml")
+    -p, --project-name NAME       Specify an alternate project name (default: directory name)
+    -h, --help                    print help
+```
+
+## List Services of Application
+
+`kontena app ps` lists and displays details about services
+
+```
+Usage:
+    kontena app ps [OPTIONS] [SERVICE] ...
+
+Parameters:
+    [SERVICE] ...                 Services to start
+
+Options:
+    -f, --file FILE               Specify an alternate Kontena compose file (default: "kontena.yml")
+    -p, --project-name NAME       Specify an alternate project name (default: directory name)
+    -h, --help                    print help
+```
+
+## Display Application Logs
+
+`kontena app logs` displays combined log entries from services.
+
+```
+Usage:
+    kontena app logs [OPTIONS] [SERVICE] ...
+
+Parameters:
+    [SERVICE] ...                 Services to start
+
+Options:
+    -f, --file FILE               Specify an alternate Kontena compose file (default: "kontena.yml")
+    -p, --project-name NAME       Specify an alternate project name (default: directory name)
+    -h, --help                    print help
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/kontena/kontena-plugin-app-command )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Kontena is licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE.txt) for full license text.