From 94db53d0803034083a3a9b1c7a9a197c327eb6b0 Mon Sep 17 00:00:00 2001 From: Victor Agababov Date: Mon, 2 Nov 2015 15:52:56 -0800 Subject: [PATCH] Initial commit for DeploymentManager on k8s. --- .gitignore | 6 + CONTRIBUTING.md | 25 ++ LICENSE | 202 +++++++++ Makefile | 36 ++ README.md | 110 +++++ client/Makefile | 12 + client/client.go | 148 +++++++ client/test/bootstrap.yaml | 49 +++ client/test/guestbook.yaml | 28 ++ client/test/redis.jinja | 32 ++ client/test/replicatedservice.py | 200 +++++++++ docs/design/architecture.dia | Bin 0 -> 1785 bytes docs/design/architecture.png | Bin 0 -> 13472 bytes docs/design/design.md | 340 +++++++++++++++ examples/bootstrap/bootstrap.sh | 44 ++ examples/bootstrap/bootstrap.yaml | 36 ++ examples/bootstrap/replicatedservice.py | 187 ++++++++ examples/guestbook/guestbook.yaml | 15 + examples/guestbook/redis.jinja | 32 ++ examples/guestbook/replicatedservice.py | 187 ++++++++ expandybird/Dockerfile | 16 + expandybird/Makefile | 28 ++ expandybird/expander/expander.go | 237 +++++++++++ expandybird/expander/expander_test.go | 146 +++++++ expandybird/expansion/expansion.py | 372 ++++++++++++++++ expandybird/expansion/file_expander.py | 48 +++ expandybird/expansion/sandbox_loader.py | 153 +++++++ expandybird/expansion/schema_validation.py | 213 ++++++++++ .../expansion/schema_validation_utils.py | 124 ++++++ expandybird/main.go | 51 +++ expandybird/requirements.txt | 3 + expandybird/service/service.go | 91 ++++ expandybird/service/service_test.go | 222 ++++++++++ expandybird/test/ExpectedOutput.yaml | 81 ++++ expandybird/test/InvalidFileName.yaml | 22 + expandybird/test/InvalidProperty.yaml | 22 + expandybird/test/InvalidTypeName.yaml | 22 + expandybird/test/MalformedContent.yaml | 20 + expandybird/test/MissingImports.yaml | 21 + expandybird/test/MissingResourceName.yaml | 21 + expandybird/test/MissingTypeName.yaml | 21 + expandybird/test/ValidContent.yaml | 27 ++ expandybird/test/replicatedservice.py | 176 ++++++++ manager/Dockerfile | 34 ++ manager/Makefile | 22 + manager/deployments.go | 310 ++++++++++++++ manager/main.go | 73 ++++ manager/manager/deployer.go | 164 +++++++ manager/manager/deployer_test.go | 300 +++++++++++++ manager/manager/expander.go | 235 ++++++++++ manager/manager/expander_test.go | 351 +++++++++++++++ manager/manager/manager.go | 255 +++++++++++ manager/manager/manager_test.go | 400 ++++++++++++++++++ manager/manager/typeresolver.go | 172 ++++++++ manager/manager/typeresolver_test.go | 264 ++++++++++++ manager/manager/types.go | 165 ++++++++ manager/repository/repository.go | 248 +++++++++++ manager/repository/repository_test.go | 332 +++++++++++++++ resourcifier/Dockerfile | 54 +++ resourcifier/Makefile | 21 + resourcifier/configurations.go | 292 +++++++++++++ resourcifier/configurator/configurator.go | 153 +++++++ resourcifier/main.go | 73 ++++ util/httpclient.go | 153 +++++++ util/httpclient_test.go | 160 +++++++ util/httputil.go | 202 +++++++++ version/version.go | 23 + 67 files changed, 8282 insertions(+) create mode 100644 .gitignore create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 Makefile create mode 100644 README.md create mode 100644 client/Makefile create mode 100644 client/client.go create mode 100644 client/test/bootstrap.yaml create mode 100644 client/test/guestbook.yaml create mode 100644 client/test/redis.jinja create mode 100644 client/test/replicatedservice.py create mode 100644 docs/design/architecture.dia create mode 100644 docs/design/architecture.png create mode 100644 docs/design/design.md create mode 100755 examples/bootstrap/bootstrap.sh create mode 100644 examples/bootstrap/bootstrap.yaml create mode 100644 examples/bootstrap/replicatedservice.py create mode 100644 examples/guestbook/guestbook.yaml create mode 100644 examples/guestbook/redis.jinja create mode 100644 examples/guestbook/replicatedservice.py create mode 100644 expandybird/Dockerfile create mode 100644 expandybird/Makefile create mode 100644 expandybird/expander/expander.go create mode 100644 expandybird/expander/expander_test.go create mode 100755 expandybird/expansion/expansion.py create mode 100644 expandybird/expansion/file_expander.py create mode 100644 expandybird/expansion/sandbox_loader.py create mode 100644 expandybird/expansion/schema_validation.py create mode 100644 expandybird/expansion/schema_validation_utils.py create mode 100644 expandybird/main.go create mode 100644 expandybird/requirements.txt create mode 100644 expandybird/service/service.go create mode 100644 expandybird/service/service_test.go create mode 100644 expandybird/test/ExpectedOutput.yaml create mode 100644 expandybird/test/InvalidFileName.yaml create mode 100644 expandybird/test/InvalidProperty.yaml create mode 100644 expandybird/test/InvalidTypeName.yaml create mode 100644 expandybird/test/MalformedContent.yaml create mode 100644 expandybird/test/MissingImports.yaml create mode 100644 expandybird/test/MissingResourceName.yaml create mode 100644 expandybird/test/MissingTypeName.yaml create mode 100644 expandybird/test/ValidContent.yaml create mode 100644 expandybird/test/replicatedservice.py create mode 100644 manager/Dockerfile create mode 100644 manager/Makefile create mode 100644 manager/deployments.go create mode 100644 manager/main.go create mode 100644 manager/manager/deployer.go create mode 100644 manager/manager/deployer_test.go create mode 100644 manager/manager/expander.go create mode 100644 manager/manager/expander_test.go create mode 100644 manager/manager/manager.go create mode 100644 manager/manager/manager_test.go create mode 100644 manager/manager/typeresolver.go create mode 100644 manager/manager/typeresolver_test.go create mode 100644 manager/manager/types.go create mode 100644 manager/repository/repository.go create mode 100644 manager/repository/repository_test.go create mode 100644 resourcifier/Dockerfile create mode 100644 resourcifier/Makefile create mode 100644 resourcifier/configurations.go create mode 100644 resourcifier/configurator/configurator.go create mode 100644 resourcifier/main.go create mode 100644 util/httpclient.go create mode 100644 util/httpclient_test.go create mode 100644 util/httputil.go create mode 100644 version/version.go diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..c55c24e6b --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +expandybird/pkg/* +expandybird/expansion/*.pyc +resourcifier/pkg/* +resourcifier/bin/* +manager/pkg/* + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..8d486278c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# Contributing guidelines + +## How to become a contributor and submit your own code + +### Contributor License Agreements + +We'd love to accept your patches! Before we can take them, we have to jump a couple of legal hurdles. + +Please fill out either the individual or corporate Contributor License Agreement (CLA). + + * If you are an individual writing original source code and you're sure you own the intellectual property, then you'll need to sign an [individual CLA](http://code.google.com/legal/individual-cla-v1.0.html). + * If you work for a company that wants to allow you to contribute your work, then you'll need to sign a [corporate CLA](http://code.google.com/legal/corporate-cla-v1.0.html). + +Follow either of the two links above to access the appropriate CLA and instructions for how to sign and return it. Once we receive it, we'll be able to accept your pull requests. + +***NOTE***: Only original source code from you and other people that have signed the CLA can be accepted into the main repository. + +### Contributing A Patch + +1. Submit an issue describing your proposed change to the repo in question. +1. The repo owner will respond to your issue promptly. +1. If your proposed change is accepted, and you haven't already done so, sign a Contributor License Agreement (see details above). +1. Fork the desired repo, develop and test your code changes. +1. Submit a pull request. + diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..d64569567 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + 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 + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. diff --git a/Makefile b/Makefile new file mode 100644 index 000000000..b5a5ed6a1 --- /dev/null +++ b/Makefile @@ -0,0 +1,36 @@ +SUBDIRS := expandybird/. resourcifier/. manager/. client/. +TARGETS := all build test push container clean + +SUBDIRS_TARGETS := \ + $(foreach t,$(TARGETS),$(addsuffix $t,$(SUBDIRS))) + +GO_DEPS := util/... version/... expandybird/... resourcifier/... manager/... client/... + +.PHONY : all build test clean $(TARGETS) $(SUBDIRS_TARGETS) .project .docker + +all: build + +clean: + go clean -v $(GO_DEPS) + +test: build + -go test -v $(GO_DEPS) + +build: + go get -v $(GO_DEPS) + go install -v $(GO_DEPS) + +push: container + +container: .project .docker + +.project: + @if [[ -z "${PROJECT}" ]]; then echo "PROJECT variable must be set"; exit 1; fi + +.docker: + @if [[ -z `which docker` ]] || ! docker version &> /dev/null; then echo "docker is not installed correctly"; exit 1; fi + +$(TARGETS) : % : $(addsuffix %,$(SUBDIRS)) + +$(SUBDIRS_TARGETS) : + $(MAKE) -C $(@D) $(@F:.%=%) diff --git a/README.md b/README.md new file mode 100644 index 000000000..c8d34e3e3 --- /dev/null +++ b/README.md @@ -0,0 +1,110 @@ +# Deployment Manager + +Deployment Manager lets you define and deploy simple declarative configuration +for your Kubernetes resources. + +You can also use Python or [Jinja](http://jinja.pocoo.org/) to create powerful +parameterizable abstract types called **Templates**. You can create general +abstract building blocks to reuse, like a +[Replicated Service](examples/guestbook/replicatedservice.py), or create +more concrete types like a [Redis cluster](examples/guestbook/redis.jinja). + +You can find more examples of Templates and configurations in our +[examples](examples). + +Deployment Manager uses the same concepts and languages as +[Google Cloud Deployment Manager](https://cloud.google.com/deployment-manager/overview), +but works directly within your Kubernetes cluster. + + +## Getting started + +For the following steps, it is assumed that you have a Kubernetes cluster up +and running, and that you can run kubectl commands against it. It is also +assumed that you're working with a clone of the repository installed in the src +folder of your GOPATH, and that your PATH contains $GOPATH/bin, per convention. + +Since Deployment Manager uses Python and will be running locally on your +machine, you will first need to make sure the necessary Python packages are +installed. This assumes that you have already installed the pip package +management system on your machine. + +``` +pip install -r expandybird/requirements.txt +``` + +Next, you'll build and install the binaries, and bootstrap Deployment Manager +into the cluster. Finally, you'll deploy an example application on the +cluster using Deployment Manager. + +### Building and installing the binaries + +In this step, you're going to build and install the Deployment Manager binaries. +You can do this by running make in the repository root. + +``` +make +``` + +### Bootstrapping Deployment Manager + +In this step, you're going to bootstrap Deployment Manager into the cluster. + +Next, start the three Deployment Manager binaries on localhost using the supplied +bootstrap script. + +``` +./examples/bootstrap/bootstrap.sh +``` + +The script starts the following binaries: +* manager (frontend service) running on port 8080 +* expandybird (expands templates) running on port 8081 +* resourcifier (reifies primitive Kubernetes resources) running on port 8082 + +It also starts kubectl proxy on port 8001. + +Next, use the Deployment Manager running on localhost to deploy itself onto the +cluster using the supplied command line tool and template. + +``` +client --name test --service=http://localhost:8080 examples/bootstrap/bootstrap.yaml +``` + +You should now have Deployment Manager running on your cluster, and it should be +visible using kubectl (kubectl get pod,rc,service). + +### Deploying your first application (Guestbook) + +In this step, you're going to deploy the canonical guestbook example to your +Kubernetes cluster. + +``` +client --name guestbook --service=http://localhost:8001/api/v1/proxy/namespaces/default/services/manager-service:manager examples/guestbook/guestbook.yaml +``` + +You should now have guestbook up and running. To verify, get the list of services +running on the cluster: + +``` +kubectl get service +``` + +You should see frontend-service running. If your cluster supports external +load balancing, it will have an external IP assigned to it, and you should be +able to navigate to it to see the guestbook in action. + +## Building the container images + +This project runs Deployment Manager on Kubernetes as three replicated services. +By default, prebuilt images stored in Google Container Registry are used to create +them. However, you can build your own container images and push them to your own +project in the registry. + +To build and push your own images to Google Container Registry, first set the +environment variable PROJECT to the name of a project known to gcloud. Then, run +the following command: + +``` +make push +``` diff --git a/client/Makefile b/client/Makefile new file mode 100644 index 000000000..ccbb326fb --- /dev/null +++ b/client/Makefile @@ -0,0 +1,12 @@ +# Makefile for the Docker image gcr.io/$(PROJECT)/expandybird +# MAINTAINER: Jack Greenfield +# If you update this image please check the tag value before pushing. + +.PHONY : all build test push container clean + +test: client + client --action=expand test/guestbook.yaml test/replicatedservice.py test/redis.jinja > /dev/null + +client: + go get -v ./... + go install -v ./... diff --git a/client/client.go b/client/client.go new file mode 100644 index 000000000..3da071dce --- /dev/null +++ b/client/client.go @@ -0,0 +1,148 @@ +/* +Copyright 2015 The Kubernetes Authors All rights reserved. +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. +*/ + +package main + +import ( + "expandybird/expander" + + "bytes" + "encoding/json" + "flag" + "fmt" + "io" + "io/ioutil" + "log" + "net/http" + "os" + "strings" + "time" +) + +var ( + action = flag.String("action", "deploy", "expand | deploy | list | get | delete | update") + name = flag.String("name", "", "Name of template or deployment") + service = flag.String("service", "http://localhost:8080", "URL for deployment manager") + binary = flag.String("binary", "../expandybird/expansion/expansion.py", + "Path to template expansion binary") +) + +var usage = func() { + message := "usage: %s [] (name | (