kubes 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5115dab9c9c9e52678c67ba1c6a956ffe9369961555d6393e8ad0ca40868fdd
-  data.tar.gz: 6f04422236a9df6a5833633c0fdc2b1bc49d31786c0fd1f1f599a75a7b7771eb
+  metadata.gz: f6a93c63c1e8d4aeea46969a491b3065c97e9a1a290bfd871286e794c35cb0d6
+  data.tar.gz: d8dbb91a1214bf8c42a5c9dd1e591dfcf6c41ffee6feb36af0af2f7b3a519ebd
 SHA512:
-  metadata.gz: c60e4d318db13f130929e1e554b93594f23cfda75b3a2e6974f395b1c1440734077bd85d9e11f0460371f62d8810e402db493c7fdf86b3f823ca8eb8810bb32e
-  data.tar.gz: b344b7af0da2964097d564407402cac1b880d134b1d213f1a40deb0234e661c7e08dc15fa3005fcfd4ba6f714d4262f5bd25c17fc876c545d0fac41898cb2a86
+  metadata.gz: dfc13591d144fb99837297c4c766354ceed410df631e505e54517e9759b9b44b03ce9adb7738db167b55c877d7f47bbd644f1bb832df38c4213651243fcbe668
+  data.tar.gz: 9ed84b118c29ec8531407f4b069840d1c576eb6f120f58ead3a8560242af44b62ca3b6339f4949a5433c64fc966003d65f2871134b0ed17984cc2f461b9537bd

data/.dockerignore

@@ -0,0 +1,4 @@
+.git
+pkg
+docs
+spec

data/CHANGELOG.md

@@ -1,8 +1,25 @@
-# Change Log
+# Changelog
 
 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.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
+
+## [0.2.3]
+- #15 use kubernetes default deployment strategy instead
+
 ## [0.2.2]
 - #14 init template updates, dockerfile_port helper
 

data/Dockerfile

@@ -0,0 +1,14 @@
+FROM ruby:2.7-alpine
+
+RUN apk add --no-cache docker
+RUN apk add --no-cache build-base ruby ruby-dev
+
+RUN wget https://storage.googleapis.com/kubernetes-release/release/v1.18.6/bin/linux/amd64/kubectl
+RUN chmod u+x kubectl && mv kubectl /bin/kubectl
+
+WORKDIR /app
+ADD . /app
+RUN bundle install
+RUN rake install
+
+ENTRYPOINT ["/usr/local/bundle/bin/kubes"]

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/ci/cloudbuild.md

@@ -0,0 +1,69 @@
+---
+title: CloudBuild
+---
+
+To build kubes as a Docker image entrypoint for [Google CloudBuild Custom Builder](https://cloud.google.com/cloud-build/docs/configuring-builds/use-community-and-custom-builders).
+
+    git clone http://github.com/boltops-tools/kubes
+    cd kubes
+    gcloud builds submit --tag gcr.io/$GOOGLE_PROJECT/kubes
+
+Be sure to set GOOGLE_PROJECT to your own project id.
+
+## Example Codebuild YAML
+
+cloudbuild.yaml:
+
+```yaml
+steps:
+# Simply calling kubectl version with the CLOUDSDK_* vars will auth to the GKE cluster. Unsure why.
+- name: gcr.io/cloud-builders/kubectl
+  args: ['version']
+  env:
+  - 'CLOUDSDK_COMPUTE_REGION=$_GCP_REGION'
+  - 'CLOUDSDK_CONTAINER_CLUSTER=$_GKE_CLUSTER'
+- name: 'gcr.io/$PROJECT_ID/kubes'
+  args: ["deploy"]
+  env:
+  - 'GOOGLE_PROJECT=$PROJECT_ID' # .kubes/config.rb: config.repo
+  - 'KUBES_ENV=$_KUBES_ENV'
+  - 'KUBES_EXTRA=$_KUBES_EXTRA'
+
+substitutions:
+  _GCP_REGION: us-central1
+  _GKE_CLUSTER: dev-cluster
+  _KUBES_ENV: dev
+  _KUBES_EXTRA: ''
+options:
+    substitution_option: 'ALLOW_LOOSE'
+```
+
+## Run CloudBuild
+
+Run cloudbuild with:
+
+    gcloud builds submit --config cloudbuild.yaml
+
+Example with output:
+
+    $ gcloud builds submit --config cloudbuild.yaml
+    Starting Step #1
+    Step #1: => docker build -t gcr.io/tung-275700/demo:kubes-2020-07-25T21-13-59 -f Dockerfile .
+    Step #1: Pushed gcr.io/tung-275700/demo:kubes-2020-07-25T21-13-59 docker image.
+    Step #1: Docker push took 2s.
+    Step #1: Compiled  .kubes/resources files to .kubes/output
+    Step #1: Deploying kubes resources
+    Step #1: => kubectl apply -f .kubes/output/shared/namespace.yaml
+    Step #1: namespace/demo unchanged
+    Step #1: => kubectl apply -f .kubes/output/web/service.yaml
+    Step #1: service/web unchanged
+    Step #1: => kubectl apply -f .kubes/output/web/deployment.yaml
+    Step #1: deployment.apps/web configured
+    $
+
+## Create Extra Environments
+
+If you are using the [with_extra helper]({% link _docs/extra-env.md %}), you can create additional environments of the same app like so:
+
+    gcloud builds submit --config cloudbuild.yaml --substitutions=_KUBES_EXTRA=2
+    gcloud builds submit --config cloudbuild.yaml --substitutions=_KUBES_EXTRA=3

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/deployment.md

@@ -34,11 +34,6 @@ spec:
   selector:
     matchLabels:
       app: demo
-  strategy:
-    rollingUpdate:
-      maxSurge: 25
-      maxUnavailable: 25
-    type: RollingUpdate
   template:
     metadata:
       labels:

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

@@ -50,7 +50,7 @@ Note, the behavior of the from is an *or* since the namespaceSelector and podSel
 
 ## Example 2
 
-If you need more control over the ingress selectors you can use the from method. He's an example:
+If you need more control over the ingress selectors, you can use the `from` method. Here's an example:
 
 .kubes/resources/web/network_policy.rb
 

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/helpers.md

@@ -8,8 +8,8 @@ Helper | Description
 --- | ---
 built_image | Method refers to the latest Docker image built by Kubes. This spares you from having to update the image manually in the deployment resource.
 dockerfile_port	| Exposed port extracted from the Dockerfile of the project.
-extra | The `KUBES_ENV` value.
-with_extra | Appends the `KUBES_ENV` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
+extra | The `KUBES_EXTRA` value.
+with_extra | Appends the `KUBES_EXTRA` value to a string if it's set. It's covered in the [Extra Env Docs]({% link _docs/extra-env.md %}).
 
 Here's also the source code with the helpers: [helpers.rb](https://github.com/boltops-tools/kubes/blob/master/lib/kubes/compiler/shared/helpers.rb).
 

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,7 +7,7 @@ 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:
 

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

@@ -37,11 +37,6 @@ spec:
   selector:
     matchLabels:
       role: web
-  strategy:
-    rollingUpdate:
-      maxSurge: 25
-      maxUnavailable: 25
-    type: RollingUpdate
   template:
     metadata:
       labels:

data/docs/_docs/yaml.md

@@ -30,11 +30,6 @@ spec:
   selector:
     matchLabels:
       app: demo
-  strategy:
-    rollingUpdate:
-      maxSurge: 25
-      maxUnavailable: 25
-    type: RollingUpdate
   template:
     metadata:
       labels:

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
 ```