kubernetes
/
examples
mirror of https://github.com/kubernetes/examples.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add Phabricator example 

Summary: Add phabricator example

Reviewers: davidopp

Reviewed By: davidopp

Subscribers: #kubernetes

Projects: #kubernetes

Differential Revision: http://107.178.210.6/D5
This commit is contained in:
Filip Grzadkowski 2015-03-10 16:22:52 +01:00
parent 8cc1a3cbf7
commit 7716b56521
11 changed files with 354 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

196
phabricator/README.md Normal file
View File

@ -0,0 +1,196 @@
## Phabricator example
This example shows how to build a simple multi-tier web application using Kubernetes and Docker.
The example combines a web frontend and an external service that provides MySQL database. We use CloudSQL on Google Cloud Platform in this example, but in principle any approach to running MySQL should work.
### Step Zero: Prerequisites
This example assumes that you have a basic understanding of kubernetes services and that you have forked the repository and [turned up a Kubernetes cluster](https://github.com/GoogleCloudPlatform/kubernetes#contents):
```shell
$ cd kubernetes
$ hack/dev-build-and-up.sh
```
### Step One: Set up Cloud SQL instance
Follow the [official instructions](https://cloud.google.com/sql/docs/getting-started) to set up Cloud SQL instance.
In the remaining part of this example we will assume that your instance is named "phabricator-db", has IP 173.194.242.66 and the password is "1234".
### Step Two: Turn up the phabricator
To start Phabricator server use the file `examples/phabricator/phabricator-controller.json` which describes a replication controller with a single pod running an Apache server with Phabricator PHP source:
```js
{
"id": "phabricator-controller",
"kind": "ReplicationController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 1,
"replicaSelector": {"name": "phabricator"},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "phabricator-pod",
"containers": [{
"name": "phabricator",
"image": "kubernetes/example-php-phabricator",
"env": [
{"name": "MYSQL_SERVICE_IP", "value": "173.194.242.66"},
{"name": "MYSQL_SERVICE_PORT", "value": "3306"},
{"name": "MYSQL_PASSWORD", "value": "1234"},
],
"ports": [{"name": "http-server", "containerPort": 80}],
"imagePullPolicy": "Always"
}]
}
},
"labels": { "name": "phabricator" }
}
},
"labels": {"name": "phabricator"}
}
```
Create the phabricator pod in your Kubernetes cluster by running:
```shell
$ cluster/kubectl.sh create -f examples/phabricator/phabricator-controller.json
```
Once that's up you can list the pods in the cluster, to verify that it is running:
```shell
cluster/kubectl.sh get pods
```
You'll see a single phabricator pod. It will also display the machine that the pod is running on once it gets placed (may take up to thirty seconds):
```
POD IP CONTAINER(S) IMAGE(S) HOST LABELS STATUS
phabricator-controller-02qp4 10.244.1.34 phabricator fgrzadkowski/phabricator kubernetes-minion-2.c.myproject.internal/130.211.141.151 name=phabricator
```
If you ssh to that machine, you can run `docker ps` to see the actual pod:
```shell
me@workstation$ gcloud compute ssh --zone us-central1-b kubernetes-minion-2
$ sudo docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
54983bc33494 fgrzadkowski/phabricator:latest "/run.sh" 2 hours ago Up 2 hours k8s_phabricator.d6b45054_phabricator-controller-02qp4.default.api_eafb1e53-b6a9-11e4-b1ae-42010af05ea6_01c2c4ca
```
(Note that initial `docker pull` may take a few minutes, depending on network conditions. During this time, the `get pods` command will return `Pending` because the container has not yet started )
### Step Three: Authenticate phabricator in Cloud SQL
If you read logs of the phabricator container you will notice the following error message:
```bash
$ cluster/kubectl.sh log phabricator-controller-02qp4
[...]
Raw MySQL Error: Attempt to connect to root@173.194.252.142 failed with error
#2013: Lost connection to MySQL server at 'reading initial communication
packet', system error: 0.
```
This is because the host on which this container is running is not authorized in Cloud SQL. To fix this run:
```bash
gcloud sql instances patch phabricator-db --authorized-networks 130.211.141.151
```
To automate this process and make sure that a proper host is authorized even if pod is rescheduled to a new machine we need a separate pod that periodically lists pods and authorizes hosts. Use the file `examples/phabricator/authenticator-controller.json`:
```js
{
"id": "authenticator-controller",
"kind": "ReplicationController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 1,
"replicaSelector": {"name": "authenticator"},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "authenticator-pod",
"containers": [{
"name": "authenticator",
"image": "kubernetes/example-cloudsql-authenticator",
"env": [
{"name": "SELECTOR", "value": "name=phabricator"},
{"name": "CLOUDSQL_DB", "value": "phabricator-db"}
],
"imagePullPolicy": "Always"
}],
}
},
"labels": { "name": "authenticator" }
}
},
"labels": {"name": "authenticator"}
}
```
To create the pod run:
```shell
$ cluster/kubectl.sh create -f examples/phabricator/authenticator-controller.json
```
### Step Four: Turn up the phabricator service
A Kubernetes 'service' is a named load balancer that proxies traffic to one or more containers. The services in a Kubernetes cluster are discoverable inside other containers via *environment variables*. Services find the containers to load balance based on pod labels. These environment variables are typically referenced in application code, shell scripts, or other places where one node needs to talk to another in a distributed system. You should catch up on [kubernetes services](https://github.com/GoogleCloudPlatform/kubernetes/blob/master/docs/services.md) before proceeding.
The pod that you created in Step One has the label `name=phabricator`. The selector field of the service determines which pods will receive the traffic sent to the service. Since we are setting up a service for an external application we also need to request external static IP address (otherwise it will be assigned dynamically):
```shell
$ gcloud compute addresses create phabricator --region us-central1
Created [https://www.googleapis.com/compute/v1/projects/myproject/regions/us-central1/addresses/phabricator].
NAME REGION ADDRESS STATUS
phabricator us-central1 107.178.210.6 RESERVED
```
Use the file `examples/phabricator/phabricator-service.json`:
```js
{
"apiVersion": "v1beta1",
"kind": "Service",
"id": "phabricator",
"port": 80,
"containerPort": "http-server",
"selector": { "name": "phabricator" },
"createExternalLoadBalancer": true,
"publicIPs": ["107.178.210.6"]
}
```
To create the service run:
```shell
$ cluster/kubectl.sh create -f examples/phabricator/phabricator-service.json
phabricator
```
Note that it will also create an external load balancer so that we can access it from outside. You may need to open the firewall for port 80 using the [console][cloud-console] or the `gcloud` tool. The following command will allow traffic from any source to instances tagged `kubernetes-minion`:
```shell
$ gcloud compute firewall-rules create phabricator-node-80 --allow=tcp:80 --target-tags kubernetes-minion
```
### Step Six: Cleanup
To turn down a Kubernetes cluster:
```shell
$ cluster/kube-down.sh
```

28
phabricator/authenticator-controller.json Normal file
View File

@ -0,0 +1,28 @@
{
"id": "authenticator-controller",
"kind": "ReplicationController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 1,
"replicaSelector": {"name": "authenticator"},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "authenticator-pod",
"containers": [{
"name": "authenticator",
"image": "fgrzadkowski/example-cloudsql-authenticator",
"env": [
{"name": "SELECTOR", "value": "name=phabricator"},
{"name": "CLOUDSQL_DB", "value": "phabricator-db"}
],
"imagePullPolicy": "Always"
}],
}
},
"labels": { "name": "authenticator" }
}
},
"labels": {"name": "authenticator"}
}

8
phabricator/cloudsql-authenticator/Dockerfile Normal file
View File

@ -0,0 +1,8 @@
FROM google/cloud-sdk
RUN apt-get update && apt-get install -y curl
ADD run.sh /run.sh
RUN chmod a+x /*.sh
CMD ["/run.sh"]

15
phabricator/cloudsql-authenticator/run.sh Executable file
View File

@ -0,0 +1,15 @@
#!/bin/bash
# TODO: This loop updates authorized networks even if nothing has changed. It
# should only send updates if something changes. We should be able to do
# this by comparing pod creation time with the last scan time.
while true; do
hostport="${KUBERNETES_RO_SERVICE_HOST}:${KUBERNETES_RO_SERVICE_PORT}"
path="api/v1beta1/pods"
query="labels=$SELECTOR"
ips_json=`curl ${hostport}/${path}?${query} 2>/dev/null | grep hostIP`
ips=`echo $ips_json | cut -d'"' -f 4 | sed 's/,$//'`
echo "Adding IPs $ips"
gcloud sql instances patch $CLOUDSQL_DB --authorized-networks $ips
sleep 10
done

30
phabricator/phabricator-controller.json Normal file
View File

@ -0,0 +1,30 @@
{
"id": "phabricator-controller",
"kind": "ReplicationController",
"apiVersion": "v1beta1",
"desiredState": {
"replicas": 1,
"replicaSelector": {"name": "phabricator"},
"podTemplate": {
"desiredState": {
"manifest": {
"version": "v1beta1",
"id": "phabricator-pod",
"containers": [{
"name": "phabricator",
"image": "fgrzadkowski/example-php-phabricator",
"env": [
{"name": "MYSQL_SERVICE_IP", "value": "173.194.242.66"},
{"name": "MYSQL_SERVICE_PORT", "value": "3306"},
{"name": "MYSQL_PASSWORD", "value": "1234"},
],
"ports": [{"name": "http-server", "containerPort": 80}],
"imagePullPolicy": "Always"
}]
}
},
"labels": { "name": "phabricator" }
}
},
"labels": {"name": "phabricator"}
}

10
phabricator/phabricator-service.json Normal file
View File

@ -0,0 +1,10 @@
{
"apiVersion": "v1beta1",
"kind": "Service",
"id": "phabricator",
"port": 80,
"containerPort": "http-server",
"selector": { "name": "phabricator" },
"createExternalLoadBalancer": true,
"publicIPs": ["107.178.210.6"]
}

12
phabricator/php-phabricator/000-default.conf Normal file
View File

@ -0,0 +1,12 @@
<Directory /home/www-data/phabricator/webroot>
Require all granted
</Directory>
<VirtualHost *>
DocumentRoot /home/www-data/phabricator/webroot
RewriteEngine on
RewriteRule ^/rsrc/(.*) - [L,QSA]
RewriteRule ^/favicon.ico - [L,QSA]
RewriteRule ^(.*)$ /index.php?__path__=$1 [B,L,QSA]
</VirtualHost>

26
phabricator/php-phabricator/Dockerfile Normal file
View File

@ -0,0 +1,26 @@
FROM ubuntu:14.04
# Install all the required packages.
RUN apt-get update
RUN apt-get -y install \
git apache2 dpkg-dev python-pygments \
php5 php5-mysql php5-gd php5-dev php5-curl php-apc php5-cli php5-json php5-xhprof
RUN a2enmod rewrite
RUN apt-get source php5
RUN (cd `ls -1F | grep '^php5-.*/$'`/ext/pcntl && phpize && ./configure && make && sudo make install)
# Load code source.
RUN mkdir /home/www-data
RUN cd /home/www-data && git clone https://github.com/phacility/libphutil.git
RUN cd /home/www-data && git clone https://github.com/phacility/arcanist.git
RUN cd /home/www-data && git clone https://github.com/phacility/phabricator.git
RUN chown -R www-data /home/www-data
RUN chgrp -R www-data /home/www-data
ADD 000-default.conf /etc/apache2/sites-available/000-default.conf
ADD run.sh /run.sh
RUN chmod a+x /*.sh
# Run Apache2.
EXPOSE 80
CMD ["/run.sh"]

14
phabricator/php-phabricator/run.sh Executable file
View File

@ -0,0 +1,14 @@
#!/bin/bash
echo "MySQL host IP ${MYSQL_SERVICE_IP} port ${MYSQL_SERVICE_PORT}."
/home/www-data/phabricator/bin/config set mysql.host $MYSQL_SERVICE_IP
/home/www-data/phabricator/bin/config set mysql.port $MYSQL_SERVICE_PORT
/home/www-data/phabricator/bin/config set mysql.pass $MYSQL_PASSWORD
echo "Running storage upgrade"
/home/www-data/phabricator/bin/storage --force upgrade || exit 1
source /etc/apache2/envvars
echo "Starting Apache2"
apache2 -D FOREGROUND

7
phabricator/setup.sh Executable file
View File

@ -0,0 +1,7 @@
#!/bin/bash
echo "Create Phabricator replication controller" && kubectl create -f phabricator-controller.json
echo "Create Phabricator service" && kubectl create -f phabricator-service.json
echo "Create Authenticator replication controller" && kubectl create -f authenticator-controller.json
echo "Create firewall rule" && gcloud compute firewall-rules create phabricator-node-80 --allow=tcp:80 --target-tags kubernetes-minion

8
phabricator/teardown.sh Executable file
View File

@ -0,0 +1,8 @@
#!/bin/bash
echo "Deleting Authenticator replication controller" && kubectl stop rc authenticator-controller
echo "Deleting Phabricator service" && kubectl delete -f phabricator-service.json
echo "Deleting Phabricator replication controller" && kubectl stop rc phabricator-controller
echo "Delete firewall rule" && gcloud compute firewall-rules delete -q phabricator-node-80