Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

The k8s cookbook has been deprecated

The k8s cookbook has been deprecated and is no longer being maintained by its authors. Use of the k8s cookbook is no longer recommended. You may find that the kubernetes cookbook is a suitable alternative.

RSS

k8s (2) Versions 0.3.0

Manipulate Kubernetes resources

Berkshelf/Librarian
Policyfile
Knife
cookbook 'k8s', '= 0.3.0'
cookbook 'k8s', '= 0.3.0', :supermarket
knife cookbook site install k8s
knife cookbook site download k8s
README
Dependencies
Quality

k8s

Resources for deploying various Kubernetes entities, these resources are designed to be ran on the kubernetes master but can be ran anywhere that has access to a kubernetes api by changing the ['k8s']['master']['ip'] attribute. These resources utilize the kubeclient ruby gem and run against the v1beta1 api.

Currently supported resources:

  • Kubernetes Pod (kube_pod)
  • Kubernetes Replication Controller (kube_replication_controller)
  • Kubernetes Service (kube_service)

Prerequisites

To use these resources you should already have a kubernetes cluster built out and able to hit the api. If your master is not accepting api requests on its external ip, try changing the bind address on your kubernetes configs.

Attributes

  • ['k8s']['master']['ip'] - the address used when contacting the kubernetes api
  • ['k8s']['master']['port'] - the port that will be used whe contacting the kubernetes api
  • ['k8s']['client_version'] - the version of the kubeclient gem to install

Libraries

The resources in this cookbook are built off of the K8s::Client helper library, to include this library add include K8s::Client to your recipe.

Recipes

default.rb

Installs the kubeclient ruby gem for interacting with the Kubernetes api

install.rb

Installs the needed packages for kubernetes - currently only supported on RHEL 7

master.rb

Ensures the needed services are started/enabled for a kubernetes master

node.rb

Ensures the needed services are started/enabled for a kubernetes node/minion

Resources and Providers

Kubernetes Pod (kube_pod)

Manage a standalone Kubernetes pod, there is no redundancy in a pod and is simply used to specify a group of containers to be jointly deployed on a host.

Actions
  • create - default. ensures the pod is created
  • destroy - ensures the pod does not exist
Attribute Parameters
  • id - name attribute. The identifier used when managing the pod
  • containers - required a hash of container information that will be used when creating the pod
  • volumes - a hash of volume information used when specifying storage for containers
  • labels - specify the labels that will be added to the pod
Examples
kube_pod "my-pod" do
  containers({
    name: 'pod-member',
    image: 'my/image'
  })
  labels "aww=yiss"
  action [:destroy,:create]
end

Kubernetes Replication Controller (kube_replication_controller)

Replication controllers are used to maintain a consistent amount of a pod at any given time using selector labels

Actions
  • create - default. ensures the replication controller is created
  • destroy - ensures the replication controller does not exist
Attribute Parameters
  • id - name attribute. The identifier used when managing the replication controller
  • containers - required a hash of container information that will be used when the replication controller needs to generate new pods
  • volumes - a hash of volume information used in generating new pods
  • selector - how the replication controller will ensure that enough replicas exist
  • pod_labels - specify the labels added to the indivial pods that are spawned off
  • labels - specify the labels that will be added to the replication controller
Examples
kube_replication_controller "master-controller" do
  containers({
    name: 'redis-master',
    image: 'dockerfile/redis'
  })
  replicas 2
  selector 'role' => 'master','app' => 'redis'
  labels ['aww=yiss','motha-freakin=breadcrumbs']
  action [:destroy,:create]
end

Kubernetes Service (kube_service)

Deploy a Kubernetes service, which can be used as a basic container load balancer that routes traffic based on selector labels

Actions
  • create - default. ensure the service exists
  • destroy - ensure the service does not exist
Attribute Parameters
  • id - name attribute. The identifier used when managing the service
  • port - required the port that the service will listen on for traffic
  • container_port - what port the service will route to on the selected containers defaults to the port that the service is listening on
  • selector - labels that the service will use when choosing containers to route traffic to
  • labels - labels that will be added to the service
Examples
kube_service "backend-service" do
  port 8005
  selector 'role' => 'backend'
end

Containers and Volumes

The syntax used when specifing containers and volumes is specific to the kubernetes api, for examples on what these can/should look like please see the kubernetes documentation/examples.

Labels

Theres a bit of magic in the helper library that allows you to specify labels as either a hash 'this' => 'that', 'app' => 'redis', an array of labels ['this=that','app=redis'], or a comma delimited string 'this=that,app=redis'. All three will be treated as the same thing when writing your resources.

License and Author

Copyright 2015, Chef Software, 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.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Foodcritic Metric
            

0.3.0 failed this metric

FC009: Resource attribute not recognised: /tmp/cook/6c36bfadd0f2d1400a639442/k8s/recipes/default.rb:19