From 346c3a9c855fe5fa0bd47ebc43af7be97751818a Mon Sep 17 00:00:00 2001 From: David Young Date: Sun, 10 Jul 2022 16:14:07 +1200 Subject: [PATCH] Update title/descriptions Signed-off-by: David Young --- manuscript/community/code-of-conduct.md | 5 ++++- manuscript/community/contribute.md | 4 ++++ manuscript/community/discord.md | 4 ++++ manuscript/community/reddit.md | 5 +++++ manuscript/docker-swarm/nodes.md | 4 ++++ manuscript/docker-swarm/shared-storage-ceph.md | 4 ++++ manuscript/docker-swarm/shared-storage-gluster.md | 4 ++++ manuscript/docker-swarm/traefik-forward-auth/dex-static.md | 2 +- manuscript/docker-swarm/traefik-forward-auth/google.md | 2 +- manuscript/docker-swarm/traefik-forward-auth/index.md | 2 +- manuscript/docker-swarm/traefik-forward-auth/keycloak.md | 2 +- manuscript/docker-swarm/traefik.md | 4 ++++ manuscript/kubernetes/ssl-certificates/secret-replicator.md | 2 +- 13 files changed, 38 insertions(+), 6 deletions(-) diff --git a/manuscript/community/code-of-conduct.md b/manuscript/community/code-of-conduct.md index 5a88c04..b7a0d5b 100644 --- a/manuscript/community/code-of-conduct.md +++ b/manuscript/community/code-of-conduct.md @@ -1,4 +1,7 @@ - +--- +title: Community Code of Conduct +description: We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. +--- # Code of Conduct Inspired by the leadership of other [great open source projects](https://www.contributor-covenant.org/adopters/), we've adopted the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/) (*below*). diff --git a/manuscript/community/contribute.md b/manuscript/community/contribute.md index 6b0172e..4a81c60 100644 --- a/manuscript/community/contribute.md +++ b/manuscript/community/contribute.md @@ -1,3 +1,7 @@ +--- +title: How to contribute to Geek Cookbook +description: Loving the geeky recipes, and looking for a way to give back / get involved. It's not all coding - here are some ideas re various ways you can be involved! +--- # Contribute ## Spread the word ❤️ diff --git a/manuscript/community/discord.md b/manuscript/community/discord.md index 52fd170..e9787e6 100644 --- a/manuscript/community/discord.md +++ b/manuscript/community/discord.md @@ -1,3 +1,7 @@ +--- +title: Funky Penguin's Discord Community +description: The most realtime and exciting way engage with our geeky community is in our Discord server! +--- # Discord The most realtime and exciting way engage with our geeky community is in our [Discord server](http://chat.funkypenguin.co.nz) diff --git a/manuscript/community/reddit.md b/manuscript/community/reddit.md index 6a31a85..3a6583e 100644 --- a/manuscript/community/reddit.md +++ b/manuscript/community/reddit.md @@ -1,3 +1,8 @@ +--- +title: Funky Penguin's Subreddit +description: If you're a redditor, jump on over to our subreddit at https://www.reddit.com/r/funkypenguin to engage / share the latest! +--- + # Reddit If you're a redditor, jump on over to our subreddit ([r/funkypenguin](https://www.reddit.com/r/funkypenguin/)), to engage / share the latest! diff --git a/manuscript/docker-swarm/nodes.md b/manuscript/docker-swarm/nodes.md index 32b1cba..1b2ec9b 100644 --- a/manuscript/docker-swarm/nodes.md +++ b/manuscript/docker-swarm/nodes.md @@ -1,3 +1,7 @@ +--- +title: Setup nodes for docker-swarm +description: Let's start building our cluster. You can use either bare-metal machines or virtual machines - the configuration would be the same. To avoid confusion, I'll be referring to these as "nodes" from now on. +--- # Nodes Let's start building our cluster. You can use either bare-metal machines or virtual machines - the configuration would be the same. To avoid confusion, I'll be referring to these as "nodes" from now on. diff --git a/manuscript/docker-swarm/shared-storage-ceph.md b/manuscript/docker-swarm/shared-storage-ceph.md index 275b03e..6dd44c8 100644 --- a/manuscript/docker-swarm/shared-storage-ceph.md +++ b/manuscript/docker-swarm/shared-storage-ceph.md @@ -1,3 +1,7 @@ +--- +title: Ceph cluster in Docker Swarm +description: Ceph provides persistent storage to your Docker Swarm cluster, supporting either rdb images for host volume mounts, or even fancy cephfs docker volumes. +--- # Shared Storage (Ceph) While Docker Swarm is great for keeping containers running (_and restarting those that fail_), it does nothing for persistent storage. This means if you actually want your containers to keep any data persistent across restarts (_hint: you do!_), you need to provide shared storage to every docker node. diff --git a/manuscript/docker-swarm/shared-storage-gluster.md b/manuscript/docker-swarm/shared-storage-gluster.md index 546ad80..65963c5 100644 --- a/manuscript/docker-swarm/shared-storage-gluster.md +++ b/manuscript/docker-swarm/shared-storage-gluster.md @@ -1,3 +1,7 @@ +--- +title: GlusterFS vs Ceph (the winner) +description: Here's why Ceph was the obvious winner in the ceph vs glusterfs comparison for our docker-swarm cluster. +--- # Shared Storage (GlusterFS) While Docker Swarm is great for keeping containers running (_and restarting those that fail_), it does nothing for persistent storage. This means if you actually want your containers to keep any data persistent across restarts (_hint: you do!_), you need to provide shared storage to every docker node. diff --git a/manuscript/docker-swarm/traefik-forward-auth/dex-static.md b/manuscript/docker-swarm/traefik-forward-auth/dex-static.md index 4434fd0..d31d694 100644 --- a/manuscript/docker-swarm/traefik-forward-auth/dex-static.md +++ b/manuscript/docker-swarm/traefik-forward-auth/dex-static.md @@ -1,6 +1,6 @@ --- title: SSO with traefik forward auth and Dex -description: Traefik forward auth needs an authentication backend, but if you don't want to use a cloud provider, you can setup your own simple backend, using Dex. +description: Traefik forward auth needs an authentication backend, but if you don't want to use a cloud provider, you can setup your own simple OIDC backend, using Dex. --- # Traefik Forward Auth for SSO with Dex (Static) diff --git a/manuscript/docker-swarm/traefik-forward-auth/google.md b/manuscript/docker-swarm/traefik-forward-auth/google.md index 51a06fe..a98a841 100644 --- a/manuscript/docker-swarm/traefik-forward-auth/google.md +++ b/manuscript/docker-swarm/traefik-forward-auth/google.md @@ -1,6 +1,6 @@ --- title: SSO with traefik forward auth with Google Oauth2 -description: Using Traefik Forward Auth, you can selectively apply SSO to your Docker services, using Google Oauth2 as your authentication backend! +description: Using Traefik Forward Auth, you can selectively apply SSO to your Docker services, using Google Oauth2 / OIDC as your authentication backend! --- # Traefik Forward Auth using Google Oauth2 for SSO diff --git a/manuscript/docker-swarm/traefik-forward-auth/index.md b/manuscript/docker-swarm/traefik-forward-auth/index.md index 60f2819..8c5feb2 100644 --- a/manuscript/docker-swarm/traefik-forward-auth/index.md +++ b/manuscript/docker-swarm/traefik-forward-auth/index.md @@ -1,6 +1,6 @@ --- title: Add SSO to Traefik with Forward Auth -description: Traefik Forward Auth protects services running in Docker with an additional layer of authentication, and can be integrated into Keycloak, Google, GitHub, etc. +description: Traefik Forward Auth protects services running in Docker with an additional layer of authentication, and can be integrated into Keycloak, Google, GitHub, etc using OIDC. --- # Traefik Forward Auth diff --git a/manuscript/docker-swarm/traefik-forward-auth/keycloak.md b/manuscript/docker-swarm/traefik-forward-auth/keycloak.md index 6f1619f..1e8c7a9 100644 --- a/manuscript/docker-swarm/traefik-forward-auth/keycloak.md +++ b/manuscript/docker-swarm/traefik-forward-auth/keycloak.md @@ -1,6 +1,6 @@ --- title: SSO with traefik forward auth with Keycloak -description: Traefik forward auth can selectively SSO your Docker services against an authentication backend, and Keycloak is a perfect, self-hosted match. +description: Traefik forward auth can selectively SSO your Docker services against an authentication backend using OIDC, and Keycloak is a perfect, self-hosted match. --- # Traefik Forward Auth with KeyCloak for SSO diff --git a/manuscript/docker-swarm/traefik.md b/manuscript/docker-swarm/traefik.md index 3f6de87..5040ca3 100644 --- a/manuscript/docker-swarm/traefik.md +++ b/manuscript/docker-swarm/traefik.md @@ -1,3 +1,7 @@ +--- +title: Traefik exposes Docker services with LetsEncrypt certificates +description: Using Traefik, we can provide secure ingress into our Docker Swarm cluster, which opens up opportunities to provide SSO to multiple services in docker swarm via OIDC / SSO, using traefik-forward-auth. +--- # Traefik The platforms we plan to run on our cloud are generally web-based, and each listening on their own unique TCP port. When a container in a swarm exposes a port, then connecting to **any** swarm member on that port will result in your request being forwarded to the appropriate host running the container. (_Docker calls this the swarm "[routing mesh](https://docs.docker.com/engine/swarm/ingress/)"_) diff --git a/manuscript/kubernetes/ssl-certificates/secret-replicator.md b/manuscript/kubernetes/ssl-certificates/secret-replicator.md index c2124d1..c2868e7 100644 --- a/manuscript/kubernetes/ssl-certificates/secret-replicator.md +++ b/manuscript/kubernetes/ssl-certificates/secret-replicator.md @@ -6,7 +6,7 @@ As explained when creating our [LetsEncrypt Wildcard certificates](/kubernetes/s * [x] A [Kubernetes cluster](/kubernetes/cluster/) * [x] [Flux deployment process](/kubernetes/deployment/flux/) bootstrapped - * [x] [secret-replicator](kubernetes/ssl-certificates/secret-replicator/) deployed to request/renew certificates + * [x] [secret-replicator](/kubernetes/ssl-certificates/secret-replicator/) deployed to request/renew certificates * [x] [LetsEncrypt Wildcard Certificates](/kubernetes/ssl-certificates/wildcard-certificate/) created in the `letsencrypt-wildcard-cert` namespace Kiwigrid's "[Secret Replicator](https://github.com/kiwigrid/secret-replicator)" is a simple controller which replicates secrets from one namespace to another.[^1]