chore: Add scaffold files.

Author: technosophos

.gitignore

@@ -0,0 +1,2 @@
+rootfs/bin/boot
+vendor/*

CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changlog for PROJECTNAME
+
+This is a placeholder for a markdown-formatted changelog.

CONTRIBUTING.md

@@ -0,0 +1,5 @@
+# How to Contribute
+
+This project is part of Deis. You can find the latest contribution
+guidelines [at the Deis project](https://github.com/deis/deis/blob/master/CONTRIBUTING.md).
+

DCO

@@ -0,0 +1,36 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+    this project or the open source license(s) involved.

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2015 Engine Yard, 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.

MAINTAINERS.md

@@ -0,0 +1,4 @@
+# Deis Maintainers
+
+This project is part of Deis. The official maintainers documentation is
+located [in the main project](https://github.com/deis/deis/blob/master/MAINTAINERS.md).

Makefile

@@ -1,18 +1,68 @@
-include ../includes.mk
+# Short name: Short name, following [a-zA-Z_], used all over the place.
+# Some uses for short name:
+# - Docker image name
+# - Kubernetes service, rc, pod, secret, volume names
+SHORT_NAME := example
 
-repo_path = github.com/deis/deis/pkg
+# Enable vendor/ directory support.
+export GO15VENDOREXPERIMENT=1
 
-GO_PACKAGES = prettyprint time
-GO_PACKAGES_REPO_PATH = $(addprefix $(repo_path)/,$(GO_PACKAGES))
+# SemVer with build information is defined in the SemVer 2 spec, but Docker
+# doesn't allow +, so we use -.
+VERSION := 0.0.1-$(shell date "+%Y%m%d%H%M%S")
 
-test: test-style test-unit
+# Common flags passed into Go's linker.
+LDFLAGS := "-s -X main.version=${VERSION}"
 
-test-style:
-# display output, then check
-	$(GOFMT) $(GO_PACKAGES)
-	@$(GOFMT) $(GO_PACKAGES) | read; if [ $$? == 0 ]; then echo "gofmt check failed."; exit 1; fi
-	$(GOVET) $(GO_PACKAGES_REPO_PATH)
-	$(GOLINT) ./...
+# Docker Root FS
+BINDIR := ./rootfs
 
-test-unit:
-	$(GOTEST) ./...
+# Legacy support for DEV_REGISTRY, plus new support for DEIS_REGISTRY.
+DEV_REGISTRY ?= $(eval docker-machine ip deis):5000
+DEIS_REGISTY ?= ${DEV_REGISTRY}
+
+# Kubernetes-specific information for RC, Service, and Image.
+RC := manifests/deis-${SHORT_NAME}-rc.yaml
+SVC := manifests/deis-${SHORT_NAME}-service.yaml
+IMAGE := ${DEIS_REGISTRY}/deis/${SHORT_NAME}:${VERSION}
+
+all:
+	@echo "Use a Makefile to control top-level building of the project."
+
+# This illustrates a two-stage Docker build. docker-compile runs inside of
+# the Docker environment. Other alternatives are cross-compiling, doing
+# the build as a `docker build`.
+build:
+	mkdir -p ${BINDIR}/bin
+	docker run --rm -v ${PWD}:/app -w /app golang:1.5.1 make docker-compile
+
+# For cases where build is run inside of a container.
+docker-compile:
+	go build -o ${BINDIR}/bin/boot -a -installsuffix cgo -ldflags ${LDFLAGS} boot.go
+
+# For cases where we're building from local
+# We also alter the RC file to set the image name.
+docker-build:
+	docker build --rm -t ${IMAGE} rootfs
+	perl -pi -e "s|[a-z0-9.:]+\/deis\/${SHORT_NAME}:[0-9a-z-.]+|${IMAGE}|g" ${RC}
+
+# Push to a registry that Kubernetes can access.
+docker-push:
+	docker push ${IMAGE}
+
+# Deploy is a Kubernetes-oriented target
+deploy: kube-service kube-rc
+
+# Some things, like services, have to be deployed before pods. This is an
+# example target. Others could perhaps include kube-secret, kube-volume, etc.
+kube-service:
+	kubectl create -f ${SVC}
+
+# When possible, we deploy with RCs.
+kube-rc:
+	kubectl create -f ${RC}
+
+kube-clean:
+	kubectl delete rc deis-example
+
+.PHONY: all build docker-compile kube-up kube-down deploy

README.md

@@ -0,0 +1,61 @@
+# Prototype Component Repo
+
+This repo is a prototype for what a Deis component's Git repository
+should look like.
+
+A Deis component is...
+
+- An isolated piece of functionality (e.g. a microservice)
+- That can be packaged into a container (via `docker build`)
+- And can be run inside of Kubernetes
+
+Typically, Deis components are written in Go.
+
+## Practical Usage
+
+If you want to experiment with creating a new repo using this framework,
+try something like this:
+
+```
+$ mkdir my_project
+$ cd my_project
+$ curl -fsSL https://github.com/technosophos/prototype-repo/archive/master.tar.gz | tar -zxv --strip-components 1
+```
+
+## First-Class Kubernetes
+
+Every component must define the appropriate Kubernetes files.
+Preferably, components should use *Replication Controllers* over pods,
+and use *Services* for autodiscovery.
+
+*Labels* should be used for versioning components and also for
+identifying components as part of Deis.
+
+*Secrets* should be used for storing small bits of shared information,
+and their contents may be set at startup time.
+
+All Kubernetes definitions should be placed in the `manifests/` directory.
+
+The _Makefile_ should have targets that use `kubectl` to load
+definitions into Kubernetes.
+
+## Dockerfiles are for Running
+
+Source code should be built either outside of Docker or in a special
+Docker build phase.
+
+A separate Dockerfile should be used for building the image. That
+Dockerfile should always be placed inside of the `rootfs` directory, and
+should manage the final image size appropriately.
+
+(See the Makefile for one possible way of doing a Docker build phase)
+
+## RootFS
+
+All files that are to be packaged into the container should be written
+to the `rootfs/` folder.
+
+## Extended Testing
+
+Along with unit tests, Deis values functional and integration testing.
+These tests should go in the `_tests` folder.

_docs/README.md

@@ -0,0 +1,10 @@
+# Project Docs
+
+Documentation for the project should be stored in the `_docs` directory.
+Since the directory is protected from Go, undecorated code samples can
+also be dropped inside of this directory.
+
+We need to decide on whether we'll continue using RST or switch to
+Markdown.
+
+I believe we are leaning toward MkDocs: http://www.mkdocs.org/

_tests/README.md

@@ -0,0 +1,6 @@
+# Tests
+
+This directory is used for functional tests.
+
+The directory is prefixed with an underscore (`_tests`) to prevent Go
+tools from automatically running Go code found in this directory.