Skip to content

Commit d3c5bfd

Browse files
committed
doc: Kubernetes HOWTO
Add reference material.
1 parent b741b64 commit d3c5bfd

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

ocfweb/docs/docs/staff/procedures/deploying-services.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ OCF.
1010

1111
## Getting started
1212
This `HOWTO` will focus on one of the OCF's simplest services:
13-
[templates][templates]. Templates is service used internally by OCF staff
13+
[Templates][templates]. Templates is service used internally by OCF staff
1414
serving 'copy-pasteable' email templates. Right now you should use [[git|doc
1515
staff/backend/git]] to `clone` your repo. Now let's get the templates repo.
1616

@@ -299,6 +299,22 @@ the Kubernetes masters (wait about 30 minutes) your service will be accessible,
299299
with TLS, at `<myapp>.ocf.berkeley.edu`. Congratulations!
300300

301301

302+
## Reference Material
303+
304+
The best way to get services up-and-running is to read code for existing services.
305+
306+
[templates][templates-deploy]: The simplest possible deployment. `nginx` server with static content.
307+
308+
[kanboard][kanboard-deploy]: Project management software that makes use of `ldap` and mounts `nfs`.
309+
310+
[mastodon][mastodon-deploy] (Advanced): Applies custom patches, uses `ldap`, mounts `nfs`, has pods for `redis`, `sidekiq`, and `http-streaming`.
311+
312+
[kafka][kafka-deploy] (Advanced): Runs a `kafka` cluster inside of Kubernetes.
313+
302314
[templates]: https://templates.ocf.berkeley.edu
303315
[dockerhub]: https://hub.docker.com
304316
[puppet]: https://github.com/ocf/puppet/tree/master/modules/ocf_kubernetes/files/persistent-volume-nfs
317+
[templates-deploy]: https://github.com/ocf/templates/tree/master/kubernetes
318+
[kanboard-deploy]: https://github.com/ocf/kanboard/tree/master/kubernetes
319+
[mastodon-deploy]: https://github.com/ocf/mastodon/tree/master/kubernetes
320+
[kafka-deploy]: https://github.com/ocf/kafka/tree/master/kubernetes

0 commit comments

Comments
 (0)