wiki-cafe
/
wiki-farm-docker
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
wiki-farm-docker/examples/k8s/README.md

57 lines
1.3 KiB
Markdown
Raw Normal View History

Add help to remember how to start all the things
2019-12-25 20:08:08 +00:00
# Wiki Farm in Kubernetes
There are easier ways to get started with federated wiki. Here we are
using wiki to drive some learning about kubernetes.
Start an insecure wiki under simple.localtest.me Bootstrapping a simpler development environment
2020-01-12 22:30:42 +00:00
# We're using MacOS, Docker Desktop, and k3d
Add help to remember how to start all the things
2019-12-25 20:08:08 +00:00
change domain names in kubernetes example to use localhost Now that both chrome and firefox understand *.localhost domains we can remove our suggestion of using localtest.me subdomains. Also update the brew install instructions now that brew cask install is deprecated in favor of brew install --cask My favorite improvement is finding a way to use yaml block labels and references to reduce the duplication in the ingress config. I suppose the last important thing to mention about this changes is that k3d seems to have switched from traefik to nginx for its ingress loadbalancer. We no longer need the traefik annotation.
2021-01-10 23:02:45 +00:00
brew install --cask docker
Start an insecure wiki under simple.localtest.me Bootstrapping a simpler development environment
2020-01-12 22:30:42 +00:00
brew install k3d
Simplify persistence configuration & expose macos folders We now map ~/.wiki-k8s in MacOS into the .wiki folder inside the container and similarly with MacOS ~/workspace/fedwiki First, when we create the k3d cluster, we include directives that are passed through to docker to mount the MacOS directories into the kubernetes host. Second, we use hostPath volumes in the kubernetes deployment config. These will work great for the primary use case of a local wiki. Deployments to remote kubernetes clusters will want to do this with the PersistentVolumeClaim that was removed with this change. One luxury of using hostPath and the legacy_security is that we no longer require an init container.
2020-01-13 02:29:41 +00:00
mkdir -p ~/.wiki-k8s ~/workspace/fedwiki
k3d create \
Ensure localhost is included in k8s cluster TLS cert See explanation here: https://github.com/rancher/k3d/issues/143\#issuecomment-552634281 --server-arg passes the --tls-san=... argument through to k3s server. Docs for that arg are here: https://rancher.com/docs/k3s/latest/en/installation/install-options/
2020-01-19 22:13:24 +00:00
--server-arg --tls-san="127.0.0.1" \
Simplify persistence configuration & expose macos folders We now map ~/.wiki-k8s in MacOS into the .wiki folder inside the container and similarly with MacOS ~/workspace/fedwiki First, when we create the k3d cluster, we include directives that are passed through to docker to mount the MacOS directories into the kubernetes host. Second, we use hostPath volumes in the kubernetes deployment config. These will work great for the primary use case of a local wiki. Deployments to remote kubernetes clusters will want to do this with the PersistentVolumeClaim that was removed with this change. One luxury of using hostPath and the legacy_security is that we no longer require an init container.
2020-01-13 02:29:41 +00:00
--publish 80:80 \
-v "$HOME/.wiki-k8s:/macos/.wiki-k8s" \
-v "$HOME/workspace/fedwiki:/macos/fedwiki" \
--name wiki
Add help to remember how to start all the things
2019-12-25 20:08:08 +00:00
Provide example farm configuration for friends security plugin
2020-01-19 22:22:03 +00:00
# example ~/.wiki-k8s/config.json
{
"admin": "any memorable password",
"autoseed": true,
"farm": true,
"cookieSecret": "any random string",
"secure_cookie": false,
"security_type": "friends",
"wikiDomains": {
change domain names in kubernetes example to use localhost Now that both chrome and firefox understand *.localhost domains we can remove our suggestion of using localtest.me subdomains. Also update the brew install instructions now that brew cask install is deprecated in favor of brew install --cask My favorite improvement is finding a way to use yaml block labels and references to reduce the duplication in the ingress config. I suppose the last important thing to mention about this changes is that k3d seems to have switched from traefik to nginx for its ingress loadbalancer. We no longer need the traefik annotation.
2021-01-10 23:02:45 +00:00
"localhost": {
"id": "/home/node/.wiki/localhost.owner.json"
},
"example.com": {
"id": "/home/node/.wiki/example.com.owner.json"
Provide example farm configuration for friends security plugin
2020-01-19 22:22:03 +00:00
}
}
}
change domain names in kubernetes example to use localhost Now that both chrome and firefox understand *.localhost domains we can remove our suggestion of using localtest.me subdomains. Also update the brew install instructions now that brew cask install is deprecated in favor of brew install --cask My favorite improvement is finding a way to use yaml block labels and references to reduce the duplication in the ingress config. I suppose the last important thing to mention about this changes is that k3d seems to have switched from traefik to nginx for its ingress loadbalancer. We no longer need the traefik annotation.
2021-01-10 23:02:45 +00:00
# example ~/.wiki-k8s/localhost.owner.json
Provide example farm configuration for friends security plugin
2020-01-19 22:22:03 +00:00
`.friend.secret` must match the `.admin` field from `config.json`
{
"name": "The Owner",
"friend": {
"secret": "any memorable password"
}
}
Add help to remember how to start all the things
2019-12-25 20:08:08 +00:00
# Deploy Wiki
moved example k8s deployment .yaml to deploy.wiki.do
2021-01-18 07:10:15 +00:00
kubectl apply -f http://deploy.wiki.do/assets/wiki/wiki.yaml
Add help to remember how to start all the things
2019-12-25 20:08:08 +00:00
# Play with the wiki
change domain names in kubernetes example to use localhost Now that both chrome and firefox understand *.localhost domains we can remove our suggestion of using localtest.me subdomains. Also update the brew install instructions now that brew cask install is deprecated in favor of brew install --cask My favorite improvement is finding a way to use yaml block labels and references to reduce the duplication in the ingress config. I suppose the last important thing to mention about this changes is that k3d seems to have switched from traefik to nginx for its ingress loadbalancer. We no longer need the traefik annotation.
2021-01-10 23:02:45 +00:00
open http://wiki.localhost