Update Helm docs

ohsu-comp-bio · Nov 6, 2024 · 2a8ea02 · 2a8ea02
1 parent 20ae455
commit 2a8ea02
Show file tree

Hide file tree

Showing 9 changed files with 71 additions and 39 deletions.
diff --git a/docs/css/funnel.css b/docs/css/funnel.css
@@ -243,3 +243,23 @@ pre {
   color: #aaa;
   font-style: normal;
 }
+
+.code-block-header {
+  background-color: #404040;
+  display: flex;
+  justify-content: space-between;
+  align-items: center;
+  font-size: smaller;
+  color: darkgray;
+  padding: 0.2em 1em 0.2em 1em;
+}
+.copy-code-button {
+  background: none;
+  border: none;
+  color: inherit;
+  cursor: pointer;
+  font-size: 1em;
+}
+.copy-code-button:focus {
+  outline: none;
+}
diff --git a/docs/css/monokai-sublime.css b/docs/css/monokai-sublime.css
@@ -50,7 +50,7 @@ Monokai Sublime style. Derived from Monokai by noformnocontent http://nn.mit-lic
 .hljs-selector-tag,
 .hljs-name,
 .hljs-attr {
-  color: #f92672;
+  color: #bababa;
 }
 
 .hljs-symbol,

diff --git a/docs/download/index.html b/docs/download/index.html
@@ -13,7 +13,8 @@
 
 
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/poole.css">
-  <link rel="stylesheet" href="http://localhost:1313/funnel/css/darcula.css">
+
+  <link rel="stylesheet" href="http://localhost:1313/funnel/css/nord.css">
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/syntax.css">
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/theme.css">
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/funnel.css">
@@ -27,6 +28,9 @@
   <script>hljs.initHighlightingOnLoad();</script>
 
 
+  <script src="http://localhost:1313/funnel/js/copybutton.js"></script>
+
+
   <link href="http://localhost:1313/funnel/pagefind/pagefind-ui.css" rel="stylesheet">
   <script src="http://localhost:1313/funnel/pagefind/pagefind-ui.js"></script>
   <script>
@@ -381,9 +385,9 @@ <h3>Download 0.11.1-rc.5</h3>
 Funnel requires <a href="https://docker.io">Docker</a>.<br>
 Funnel is beta quality. APIs might break, bugs exist, data might be lost.</p>
 <h3 id="homebrew">Homebrew</h3>
-<pre tabindex="0"><code>brew tap ohsu-comp-bio/formula
-brew install [email protected]
-</code></pre><h3>Build the lastest development version <i class="optional">optional</i></h3>
+<div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-sh" data-lang="sh"><span style="display:flex;"><span>brew tap ohsu-comp-bio/formula
+</span></span><span style="display:flex;"><span>brew install [email protected]
+</span></span></code></pre></div><h3>Build the lastest development version <i class="optional">optional</i></h3>
 <p>In order to build the latest code, run:</p>
 <div class="highlight"><pre tabindex="0" style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-shell" data-lang="shell"><span style="display:flex;"><span>$ git clone https://github.com/ohsu-comp-bio/funnel.git
 </span></span><span style="display:flex;"><span>$ cd funnel

diff --git a/docs/funnel-config-examples/default-config.yaml b/docs/funnel-config-examples/default-config.yaml
@@ -3,7 +3,7 @@
 Database: boltdb
 
 # The name of the active compute backend
-# Available backends: local, htcondor, slurm, pbs, gridengine, manual, aws-batch
+# Available backends: local, htcondor, slurm, pbs, gridengine, manual, aws-batch, kubernetes
 Compute: local
 
 # The name of the active event writer backend(s).

diff --git a/docs/index.html b/docs/index.html
@@ -15,7 +15,8 @@
 
 
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/poole.css">
-  <link rel="stylesheet" href="http://localhost:1313/funnel/css/darcula.css">
+
+  <link rel="stylesheet" href="http://localhost:1313/funnel/css/nord.css">
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/syntax.css">
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/theme.css">
   <link rel="stylesheet" href="http://localhost:1313/funnel/css/funnel.css">
@@ -29,6 +30,9 @@
   <script>hljs.initHighlightingOnLoad();</script>
 
 
+  <script src="http://localhost:1313/funnel/js/copybutton.js"></script>
+
+
   <link href="http://localhost:1313/funnel/pagefind/pagefind-ui.css" rel="stylesheet">
   <script src="http://localhost:1313/funnel/pagefind/pagefind-ui.js"></script>
   <script>

diff --git a/docs/index.xml b/docs/index.xml
diff --git a/server/server.go b/server/server.go
@@ -102,6 +102,11 @@ func customErrorHandler(ctx context.Context, mux *runtime.ServeMux, marshaler ru
 	w.Write(jErrBytes)
 }
 
+func healthHandler(w http.ResponseWriter, r *http.Request) {
+	w.WriteHeader(http.StatusOK)
+	w.Write([]byte("OK"))
+}
+
 type JSONError struct {
 	Error string `json:"error"`
 }
@@ -158,6 +163,7 @@ func (s *Server) Serve(pctx context.Context) error {
 	mux.Handle("/favicon.ico", dashfs)
 	mux.Handle("/manifest.json", dashfs)
 	mux.Handle("/health.html", dashfs)
+	mux.HandleFunc("/healthz", healthHandler)
 	mux.Handle("/static/", dashfs)
 	mux.Handle("/metrics", promhttp.Handler())
 

diff --git a/website/content/docs/compute/kubernetes.md b/website/content/docs/compute/kubernetes.md
@@ -6,20 +6,9 @@ menu:
     weight: 20
 ---
 
-> Funnel's Kubernetes support is in active development and may involve frequent updates 🚧
+> Funnel on Kubernetes is in active development and may involve frequent updates 🚧
 
-# Overview
-
-This guide will take you through the process of setting up Funnel as a kubernetes service.
-
-Kuberenetes Resources:
-- [Service](https://kubernetes.io/docs/concepts/services-networking/service/)
-- [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)
-- [ConfigMap](https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/)
-- [Roles and RoleBindings](https://kubernetes.io/docs/reference/access-authn-authz/rbac/#default-roles-and-role-bindings)
-- [Job](https://kubernetes.io/docs/concepts/workloads/controllers/jobs-run-to-completion/)
-
-# Deploying
+# Quick Start
 
 ## 1. Deploying with Helm ⚡️
 
@@ -97,15 +86,24 @@ kubectl apply -f funnel-deployment.yml
 kubectl port-forward service/funnel 8000:8000
 ```
 
-Now you can access the funnel server locally. Verify by running:
+Now the funnel server can be accessed as if it were running locally. This can be verified by listing all tasks, which will return an empty JSON list:
 
 ```sh
 funnel task list
+# {}
 ```
 
-Now try running a task:
+A task can then be submitted following the [standard workflow](../../tasks):
 
 ```sh
-funnel examples hello-world > hello.json
-funnel task create hello.json
+funnel examples hello-world > hello-world.json
+
+funnel task create hello-world.json
+# <Task ID>
 ```
+
+# Additional Resources 📚
+
+- [Helm Charts](https://github.com/ohsu-comp-bio/funnel/tree/feature/k8s-github-actions/deployments/kubernetes/helm/funnel)
+
+- [Helm Repo](https://ohsu-comp-bio.github.io/helm-charts)
diff --git a/website/static/funnel-config-examples/default-config.yaml b/website/static/funnel-config-examples/default-config.yaml
@@ -3,7 +3,7 @@
 Database: boltdb
 
 # The name of the active compute backend
-# Available backends: local, htcondor, slurm, pbs, gridengine, manual, aws-batch
+# Available backends: local, htcondor, slurm, pbs, gridengine, manual, aws-batch, kubernetes
 Compute: local
 
 # The name of the active event writer backend(s).