kubes 0.2.4 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d2e75bd0d156b889fcbd5a55389d335e4509e2c27bc667940bfd87155b3d9a0
-  data.tar.gz: f13237e1d8fa442d2b1a1ed07d7e209b3054cf3cdfee8f68dab20e3358352add
+  metadata.gz: 717e82d009d9109cbd891aa3881a0ab645fca4388a0268b979bd80b6c65b4b5a
+  data.tar.gz: bf0fa4160bcc4592e8ec04e4aa408f36797c0486fe2265ee9aee2406b152502a
 SHA512:
-  metadata.gz: '09576784450fc73c4846f7803c375542de5ed1f37bda86cd8cd8e61cf53dfa774192b8648d9b207180b9681a4e787ea0ade6211d02eedcd63a11051c694bb0a1'
-  data.tar.gz: 13219946a970eb6e476902b09971ae832b47a8cddf0ebc73ab68a079de2d7a67e50a539b8784731d67cf5037c677c811408db6e3cbb8b7eea528bec5588784a4
+  metadata.gz: 459680ca83a280070c044ada5ff57a12c960e92d6c5d4a4c27f1fed9aca27047e6eb31fef3d24697be9f5f30cb745fac450062d7e0d5cdafbb37997c41f7b91f
+  data.tar.gz: 8530622fe5dd61e41c20213b11b296964c14dd5ef7a7510a5df5e6bbe51d4dc3be6dae763bac4faa3784fea1530f4680d2fb24806ed8fc08e283595b315be553

data/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 This project *loosely tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
 
+## [0.3.2]
+- #21 add namespace to logs command
+
+## [0.3.1]
+- #20 improve sidecar support. kubes exec -c option also
+
+## [0.3.0]
+- #19 new commands: exec, logs
+- delete preview
+- show pods as part of get
+
+## [0.2.6]
+- #18 gcloud builder. change to config.builder
+
+## [0.2.5]
+- #17 cloudbuild build strategy
+
 ## [0.2.4]
 - #16 google cloudbuild support & docs: add Dockerfile for kubes as a docker entrypoint
 

data/docs/_docs/auto-context.md

@@ -22,7 +22,7 @@ You can override configs on a per-env basis with `config/env` files. Examples:
 ```ruby
 Kubes.configure do |config|
   config.repo = "222222222222.dkr.ecr.us-west-2.amazonaws.com/demo"
-  config.kubectl.context = "dev-services"
+  config.kubectl.context = "dev-cluster"
 end
 ```
 
@@ -31,7 +31,7 @@ end
 ```ruby
 Kubes.configure do |config|
   config.repo = "333333333333.dkr.ecr.us-west-2.amazonaws.com/demo"
-  config.kubectl.context = "prod-services"
+  config.kubectl.context = "prod-cluster"
 end
 ```
 
@@ -39,8 +39,8 @@ end
 
 With this setup, when you deploy with kubes, it will automatically switch the kubectl context based on `KUBES_ENV`.  Example:
 
-    KUBES_ENV=dev  kubes deploy # to dev-services context
-    KUBES_ENV=prod kubes deploy # to prod-services context
+    KUBES_ENV=dev  kubes deploy # to dev-cluster context
+    KUBES_ENV=prod kubes deploy # to prod-cluster context
 
 ## context_keep Option
 

data/docs/_docs/config/builder.md

@@ -0,0 +1,46 @@
+---
+title: Builder Strategy
+---
+
+Kubes uses the `docker` command to build the docker image by default. Kubes can also support an additional builder: gcloud.
+
+## Gcloud Builder
+
+With the gcloud builder, you do not need docker installed locally. Google CloudBuild is used to build and push the image to a GCR registry.
+
+You must set up the [gcloud cli](https://cloud.google.com/sdk/gcloud/reference/builds/submit).  Please refer to the [gcloud sdk install docs](https://cloud.google.com/sdk/install). Kubes will call out to `gcloud builds submit` to create the Docker image.
+
+## Configure
+
+You configure gcloud as the builder like so:
+
+```ruby
+Kubes.configure do |config|
+  config.repo = "gcr.io/#{ENV['GOOGLE_PROJECT']}/demo"
+  config.logger.level = "info"
+  config.builder = "gcloud" # <= changed to gcloud
+end
+```
+
+## Commands
+
+The kubes builds command will remain the same.
+
+    kubes docker build
+
+There is no need to run the push command, as the build command with the gcloud builder will always push.
+
+## Deploy
+
+The deploy commands remain the same. Example:
+
+    kubes deploy web
+
+If you want to skip the `docker build` phase of the deploy, you can run:
+
+    kubes deploy web --no-build
+
+Also, kubes apply another way to skip the docker build:
+
+    kubes apply web
+

data/docs/_docs/config/env.md

@@ -11,7 +11,7 @@ Kubes.configure do |config|
   config.repo = "111111111111.dkr.ecr.us-west-2.amazonaws.com/demo"
   config.logger.level = "info"
   # auto-switching
-  # config.kubectl.context = "dev-services"
+  # config.kubectl.context = "dev-cluster"
   # config.kubectl.context_keep = false
 end
 ```
@@ -25,7 +25,7 @@ You can override configs on a per-env basis with `config/env` files. Examples:
 ```ruby
 Kubes.configure do |config|
   config.repo = "222222222222.dkr.ecr.us-west-2.amazonaws.com/demo"
-  config.kubectl.context = "dev-services"
+  config.kubectl.context = "dev-cluster"
 end
 ```
 
@@ -34,7 +34,7 @@ end
 ```ruby
 Kubes.configure do |config|
   config.repo = "333333333333.dkr.ecr.us-west-2.amazonaws.com/demo"
-  config.kubectl.context = "prod-services"
+  config.kubectl.context = "prod-cluster"
 end
 ```
 

data/docs/_docs/dsl/resources/service.md

@@ -46,15 +46,31 @@ spec:
 
 ## DSL Methods
 
-Here's a list of more common methods:
+Here's a list of some of the methods:
+
+kubectl explain service.spec
+
+* clusterIP
+* externalIPs
+* externalName
+* externalTrafficPolicy
+* healthCheckNodePort
+* ipFamily
+* loadBalancerIP
+* loadBalancerSourceRanges
+* ports
+* publishNotReadyAddresses
+* selector
+* sessionAffinity
+* sessionAffinityConfig
+* type
+
+kubectl explain service.spec.ports
 
 * nodePort
 * port
-* portName: Note this field doesn't match the original field name. It's more qualified.
-* ports
+* portName: : Note this field doesn't match the original field name. It's more qualified.
 * protocol
-* selector
 * targetPort
-* type
 
 {% include dsl/methods.md name="service" %}

data/docs/_docs/learn/dsl/deploy.md

@@ -22,6 +22,8 @@ You'll see output like this:
     deployment.apps/demo-web created
     $
 
+Note: Showing an AWS ECR repo, but it may be different if you're using another repo like Google GCR.
+
 What did Kubes do?
 
 {% include kubes-steps.md %}

data/docs/_docs/learn/dsl/new-project.md

@@ -7,11 +7,10 @@ If you already a project with an existing Dockerfile, you can use that. If you d
     mkdir demo
     cd demo
 
-For this tutorial, we'll use an ECR repo, though any repo will work.
+{% include learn/repos.md %}
 
 Let's generate a starter project:
 
-    $ REPO=$(aws ecr describe-repositories --repository-name demo | jq -r '.repositories[].repositoryUri')
     $ kubes init --app demo --repo $REPO --type dsl
           create  .kubes/config.rb
           create  .kubes/config/env/dev.rb

data/docs/_docs/learn/yaml/deploy.md

@@ -22,6 +22,8 @@ You'll see output like this:
     deployment.apps/demo-web created
     $
 
+Note: Showing an AWS ECR repo, but it may be different if you're using another repo like Google GCR.
+
 What did Kubes do?
 
 {% include kubes-steps.md %}

data/docs/_docs/learn/yaml/new-project.md

@@ -7,11 +7,10 @@ If you already a project with an existing Dockerfile, you can use that. If you d
     mkdir demo
     cd demo
 
-For this tutorial, we'll use an ECR repo, though any repo will work.
+{% include learn/repos.md %}
 
 Let's generate a starter project:
 
-    $ REPO=$(aws ecr describe-repositories --repository-name demo | jq -r '.repositories[].repositoryUri')
     $ kubes init --app demo --repo $REPO
           create  Dockerfile
           create  .kubes/config.rb

data/docs/_includes/intro/install.md

@@ -4,7 +4,7 @@ Install kubes via RubyGems.
 
     gem install kubes
 
-Ruby 2.7 and patch variants of it is recommended.
+Ruby 2.7 and above is recommended.
 
 ## kubectl
 
@@ -13,3 +13,7 @@ Kubes calls kubectl. Kubes has been tested with kubectl v1.15+. Generally, it sh
 ## docker
 
 Kubes calls docker. Kubes has been tested with docker 18.x-ce+. Generally, it should work with most versions of docker.
+
+## gcloud
+
+If you are using the [gcloud builder](% link _docs/config/builder.md %), set up and configure the [gcloud cli](https://cloud.google.com/sdk/install).

data/docs/_includes/learn/cluster.md

@@ -1,12 +1,12 @@
-You'll need a Kubernetes cluster and a Docker repo to be able to push to. Setting up a Kubernetes cluster is a little bit out scope for this tutorial. We'll provide the docs and links though. We'll also use an AWS EKS cluster and ECR.
+You'll need a Kubernetes cluster and a Docker repo to be able to push to. Setting up a Kubernetes cluster is a little bit out scope for this tutorial. We'll provide the docs and links though. We'll provide instructions for AWS and Google.
 
-## Create an EKS cluster
+## AWS: Create an EKS cluster
 
 Here are the AWS docs to create an EKS cluster:
 
 * [Creating an Amazon EKS cluster](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html)
 
-## Create an ECR Repo
+## AWS: Create an ECR Repo
 
 Here are the AWS docs to create a repo:
 
@@ -19,4 +19,21 @@ Here are also the commands to create an ECR repo:
 
 We'll be using the `$REPO` variable for the rest of the tutorial.
 
-Note: Though we're using AWS here, Kubes works with any Cloud Provider. Please adjust your commands and the `$REPO` variable for your cloud provider.
+## Google: Create GKE Cluster
+
+Here are the Google docs to create an GKE cluster:
+
+* [Creating an Google GKE cluster](https://cloud.google.com/kubernetes-engine/docs/how-to/creating-a-regional-cluster)
+
+## Google: GCR Repo
+
+For google, you do not have to create a repo. You simply push to the right repo url.  Example:
+
+    export GOOGLE_PROJECT=project-123
+    REPO=gcr.io/$GOOGLE_PROJECT/demo
+
+## Repo Variable
+
+We'll be using the `$REPO` variable for the rest of the tutorial.
+
+Note: Though we're using AWS and Google here, Kubes works with any Cloud Provider. Please adjust your commands and the `$REPO` variable for your cloud provider.

data/docs/_includes/learn/repos.md

@@ -0,0 +1,10 @@
+For this tutorial, here are examples of AWS ECR and Google GCR repos, though any repo will work.
+
+AWS:
+
+    REPO=$(aws ecr describe-repositories --repository-name demo | jq -r '.repositories[].repositoryUri')
+
+Google:
+
+    export GOOGLE_PROJECT=project-123
+    REPO=gcr.io/$GOOGLE_PROJECT/demo

data/docs/_includes/learn/review.md

@@ -4,10 +4,10 @@ The `config.rb` is where you can configure Kubes settings.
 
 ```ruby
 Kubes.configure do |config|
-  config.repo = "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo"
+  config.repo = "112233445566.dkr.ecr.us-west-2.amazonaws.com/demo" # may be gcr.io/project-123/demo
   config.logger.level = "info"
   # auto-switching
-  # config.kubectl.context = "dev-services"
+  # config.kubectl.context = "dev-cluster"
 end
 ```
 

data/docs/_includes/sidebar.html

@@ -56,6 +56,7 @@
           <li><a href="{% link _docs/config/docker.md %}">Docker</a></li>
           <li><a href="{% link _docs/config/env.md %}">Env</a></li>
           <li><a href="{% link _docs/config/kubectl.md %}">Kubectl</a></li>
+          <li><a href="{% link _docs/config/builder.md %}">Builder</a></li>
         </ul>
       </li>
       <li><a href="{% link _docs/yaml.md %}">YAML</a></li>

data/docs/_reference/kubes-apply.md

@@ -5,11 +5,11 @@ reference: true
 
 ## Usage
 
-    kubes apply [APP] [RESOURCE]
+    kubes apply [ROLE] [RESOURCE]
 
 ## Description
 
-Apply the Kubernetes YAML files without changing them
+Apply the Kubernetes YAML files without building docker image
 
 
 ## Options

data/docs/_reference/kubes-delete.md

@@ -5,7 +5,7 @@ reference: true
 
 ## Usage
 
-    kubes delete [APP] [RESOURCE]
+    kubes delete [ROLE] [RESOURCE]
 
 ## Description
 

data/docs/_reference/kubes-deploy.md

@@ -5,7 +5,7 @@ reference: true
 
 ## Usage
 
-    kubes deploy [APP] [RESOURCE]
+    kubes deploy [ROLE] [RESOURCE]
 
 ## Description
 

data/docs/_reference/kubes-describe.md

@@ -0,0 +1,24 @@
+---
+title: kubes describe
+reference: true
+---
+
+## Usage
+
+    kubes describe [ROLE] [RESOURCE]
+
+## Description
+
+Describe Kubernetes resource using the compiled YAML files
+
+
+## Options
+
+```
+[--image=IMAGE]              # override image
+[--compile], [--no-compile]  # whether or not to compile the .kube/resources
+                             # Default: true
+[--verbose], [--no-verbose]  
+[--noop], [--no-noop]        
+```
+

data/docs/_reference/kubes-exec.md

@@ -0,0 +1,42 @@
+---
+title: kubes exec
+reference: true
+---
+
+## Usage
+
+    kubes exec
+
+## Description
+
+Exec into the latest container from the deployment
+
+The exec command finds the latest pod from the deployment and runs `kubectl exec -ti POD bash` to get you into it. It spares you from having to manually find and type it.
+
+## Examples
+
+    kubes exec
+    kubes exec sh
+    kubes exec ls -l
+
+## Multiple Deployments
+
+If you have have multiple deployments in your `.kubes/resources` then the command will use the first deployment by default. You can specify the specfic deployment with the `--name` option.  Examples:
+
+    kubes exec --name demo-web
+    kubes exec --name demo-clock
+    kubes exec --name demo-worker
+    kubes exec --name demo-web sh
+    kubes exec --name demo-web ls -l
+
+
+## Options
+
+```
+    [--compile], [--no-compile]  # whether or not to compile the .kube/resources
+                                 # Default: true
+n, [--name=NAME]                 # deployment name to use. IE: demo-web
+    [--verbose], [--no-verbose]  
+    [--noop], [--no-noop]        
+```
+

data/docs/_reference/kubes-get.md

@@ -0,0 +1,27 @@
+---
+title: kubes get
+reference: true
+---
+
+## Usage
+
+    kubes get [ROLE] [RESOURCE]
+
+## Description
+
+Get Kubernetes resource using the compiled YAML files
+
+
+## Options
+
+```
+    [--image=IMAGE]                  # override image
+    [--compile], [--no-compile]      # whether or not to compile the .kube/resources
+                                     # Default: true
+o, [--output=OUTPUT]                 # Output format: json|yaml|wide|name
+    [--show-pods], [--no-show-pods]  # Also show pods from deployments
+                                     # Default: true
+    [--verbose], [--no-verbose]      
+    [--noop], [--no-noop]            
+```
+