diff --git a/cluster/README.md b/cluster/README.md new file mode 100644 index 00000000..40416b9c --- /dev/null +++ b/cluster/README.md @@ -0,0 +1,7 @@ +Cluster Docs Home +================= + +Documentation relating to our Kubernetes cluster(s). + +For information about the physical DC infrastructure, see [//dc](/dc/). + diff --git a/cluster/doc/admin.md b/cluster/doc/admin.md index 1dfb50a9..097e749d 100644 --- a/cluster/doc/admin.md +++ b/cluster/doc/admin.md @@ -1,31 +1,8 @@ -HSCloud Clusters -================ - -Admin documentation. For user documentation, see [//cluster/doc/user.md](/cluster/doc/user.md). +Cluster Admin Docs +================== Current cluster: `k0.hswaw.net` -Persistent Storage (waw2) -------------------------- - -HDDs on bc01n0{1-3}. 3TB total capacity. Don't use this as this pool should go -away soon (the disks are slow, the network is slow and the RAID controllers -lie). Use ceph-waw3 instead. - -The following storage classes use this cluster: - - - `waw-hdd-paranoid-1` - 3 replicas - - `waw-hdd-redundant-1` - erasure coded 2.1 - - `waw-hdd-yolo-1` - unreplicated (you _will_ lose your data) - - `waw-hdd-redundant-1-object` - erasure coded 2.1 object store - -Rados Gateway (S3) is available at https://object.ceph-waw2.hswaw.net/. To -create a user, ask an admin. - -PersistentVolumes currently bound to PersistentVolumeClaims get automatically -backed up (hourly for the next 48 hours, then once every 4 weeks, then once -every month for a year). - Persistent Storage (waw3) ------------------------- diff --git a/cluster/doc/site.html b/cluster/doc/site.html new file mode 100644 index 00000000..22a1bb84 --- /dev/null +++ b/cluster/doc/site.html @@ -0,0 +1,13 @@ +{{ define "header" }} +hackdoc://cluster +Hackerspace Cluster Docs +{{ end }} + +{{ define "topbar" }} +Home +User Docs +Admin Docs +{{ end }} + +{{ define "sidebar" }} +{{ end }} diff --git a/cluster/doc/user.md b/cluster/doc/user.md index 6dd6938a..f04e7dbb 100644 --- a/cluster/doc/user.md +++ b/cluster/doc/user.md @@ -1,5 +1,5 @@ -Warsaw Hackerspace Kubernetes Clusters -====================================== +Cluster User Docs +================= End-user^Whacker documentation. diff --git a/cluster/hackdoc.toml b/cluster/hackdoc.toml new file mode 100644 index 00000000..af7f8b8b --- /dev/null +++ b/cluster/hackdoc.toml @@ -0,0 +1,5 @@ +[template.default] +sources = [ + "//devtools/hackdoc/tpl/base.html", + "//cluster/doc/site.html", +] diff --git a/dc/README.md b/dc/README.md index 6ee4c21c..cf4287a7 100644 --- a/dc/README.md +++ b/dc/README.md @@ -1,4 +1,16 @@ -hscloud/dc -========== +DC Docs Home +============ -Software and systems related to DC operations and provisioning. +Software, systems and hardware related to DC operations and provisioning. + +Software +-------- + + - [arista-proxy](arista-proxy/), a gRPC proxy to Arista's JSON-RPC. + - [cmc-proxy](cmc-proxy/), a gRPC proxy to the Dell M1000E Chassic Management Controller. + - [m6220-proxy](m6220-proxy/), a gRPC proxy to the Dell M6220 switch. + +Hardware +-------- + + - [hbj11](hbj11/), a JBOD SATA passthrough card for Dell M610 servers. diff --git a/dc/arista-proxy/README.md b/dc/arista-proxy/README.md index 60368dc8..56e29791 100644 --- a/dc/arista-proxy/README.md +++ b/dc/arista-proxy/README.md @@ -5,40 +5,15 @@ Our Arista 7148S does not support gRPC/OpenConfig, so we have to make our own da The schema is supposed to be 1:1 mapped to the JSON-RPC EAPI. This is just a dumb proxy. -Getting and Building --------------------- +Building +-------- - go get -d -u code.hackerspace.pl/q3k/arista-proxy - go generate code.hackerspace.pl/q3k/arista-proxy/proto - go build code.hackerspace.pl/q3k/arista-proxy - -Debug Status Page ------------------ - -The `debug_address` flag controls spawning an HTTP server useful for debugging. You can use it to inspect gRPC request and view general status information of the proxy. + $ bazel build //dc/arista-proxy Flags ----- - ./arista-proxy -help - Usage of ./arista-proxy: - -alsologtostderr - log to standard error as well as files -arista_api string Arista remote endpoint (default "http://admin:password@1.2.3.4:80/command-api") - -debug_address string - Debug HTTP listen address, or empty to disable (default "127.0.0.1:42000") - -listen_address string - gRPC listen address (default "127.0.0.1:43001") - -log_backtrace_at value - when logging hits line file:N, emit a stack trace - -log_dir string - If non-empty, write log files in this directory - -logtostderr - log to standard error instead of files - -stderrthreshold value - logs at or above this threshold go to stderr - -v value - log level for V logs - -vmodule value - comma-separated list of pattern=N settings for file-filtered logging + +For standard flags (eg. listen, logs, ...) run with -help. diff --git a/dc/doc/site.html b/dc/doc/site.html new file mode 100644 index 00000000..cce37675 --- /dev/null +++ b/dc/doc/site.html @@ -0,0 +1,12 @@ +{{ define "header" }} +hackdoc://dc +Hackerspace Datacenter Docs +{{ end }} + +{{ define "topbar" }} +Home +HBJ11 +{{ end }} + +{{ define "sidebar" }} +{{ end }} diff --git a/dc/hackdoc.toml b/dc/hackdoc.toml new file mode 100644 index 00000000..81eb7c5a --- /dev/null +++ b/dc/hackdoc.toml @@ -0,0 +1,5 @@ +[template.default] +sources = [ + "//devtools/hackdoc/tpl/base.html", + "//dc/doc/site.html", +] diff --git a/devtools/hackdoc/tpl/base.html b/devtools/hackdoc/tpl/base.html index 5fd861ad..8b93b391 100644 --- a/devtools/hackdoc/tpl/base.html +++ b/devtools/hackdoc/tpl/base.html @@ -3,9 +3,358 @@ hackdoc:{{ .Title }} - {{ template "head" . }} + - {{ template "body" . }} +
+
+
+
+ {{ template "header" . }} +
+
+
+ {{ template "topbar" . }} +
+ +
+ + {{ .Rendered }} +
+
+
diff --git a/devtools/hackdoc/tpl/default.html b/devtools/hackdoc/tpl/default.html index 6e1434e4..24439bbb 100644 --- a/devtools/hackdoc/tpl/default.html +++ b/devtools/hackdoc/tpl/default.html @@ -1,280 +1,14 @@ -{{ define "head" }} - +{{ define "header" }} +hackdoc:// +HSCloud Docs {{ end }} -{{ define "body" }} -
-
-
-
- hackdoc: - {{ range .PathParts }} - {{ if ne .Path "" }} - {{ .Label }} - {{ else }} - {{ .Label }} - {{ end }} - {{ end }} - shortcuts: root, cluster docs, codelabs -
- {{ .Rendered }} -
- -
-
+ +{{ define "topbar" }} +Home +Cluster +DC +Codelabs +{{ end }} + +{{ define "sidebar" }} {{ end }}