From 74a34fd995ac85057d177f3648e923d6b59cbb96 Mon Sep 17 00:00:00 2001 From: Devin Buhl Date: Tue, 24 Aug 2021 09:25:02 -0400 Subject: [PATCH] chore: update readme with OS prep --- README.md | 111 +++++++++++++++++++++++++++--------------------------- 1 file changed, 55 insertions(+), 56 deletions(-) diff --git a/README.md b/README.md index e8ed14f1..88827a9e 100644 --- a/README.md +++ b/README.md @@ -19,14 +19,14 @@ The following components will be installed in your [k3s](https://k3s.io/) cluste Feel free to read up on any of these technologies before you get started to be more familiar with them. -- [flannel](https://github.com/flannel-io/flannel) -- [local-path-provisioner](https://github.com/rancher/local-path-provisioner) -- [flux](https://toolkit.fluxcd.io/) -- [metallb](https://metallb.universe.tf/) -- [cert-manager](https://cert-manager.io/) with Cloudflare DNS challenge -- [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) -- [homer](https://github.com/bastienwirtz/homer) -- [system-upgrade-controller](https://github.com/rancher/system-upgrade-controller) +- [flannel](https://github.com/flannel-io/flannel) - default CNI provided by k3s +- [local-path-provisioner](https://github.com/rancher/local-path-provisioner) - default storage class provided by k3s +- [flux](https://toolkit.fluxcd.io/) - GitOps tool for deploying manifests from the `cluster` directory +- [metallb](https://metallb.universe.tf/) - bare metal load balancer +- [cert-manager](https://cert-manager.io/) - SSL certificates - with Cloudflare DNS challenge +- [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) - ingress controller +- [hajimari](https://github.com/toboshii/hajimari) - start page with ingress discovery +- [system-upgrade-controller](https://github.com/rancher/system-upgrade-controller) - upgrade k3s ## :memo:  Prerequisites @@ -34,24 +34,43 @@ Feel free to read up on any of these technologies before you get started to be m Already provisioned Bare metal or VMs with any modern operating system like Ubuntu, Debian or CentOS. +If coming from a fresh install of Linux make sure you do the following steps. + +- Enable packet forwarding on the hosts and increase max_user_watches + +```sh +cat <=1.18.0-0 -# ✔ Kubernetes 1.20.5+k3s1 >=1.16.0-0 +# ✔ kubectl 1.21.4 >=1.18.0-0 +# ✔ Kubernetes 1.21.4+k3s1 >=1.16.0-0 # ✔ prerequisites checks passed ``` @@ -290,28 +309,7 @@ git push kubectl --kubeconfig=./kubeconfig apply --kustomize=./cluster/base/flux-system # namespace/flux-system configured # customresourcedefinition.apiextensions.k8s.io/alerts.notification.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/buckets.source.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/gitrepositories.source.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/helmcharts.source.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/helmreleases.helm.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/helmrepositories.source.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/kustomizations.kustomize.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/providers.notification.toolkit.fluxcd.io created -# customresourcedefinition.apiextensions.k8s.io/receivers.notification.toolkit.fluxcd.io created -# serviceaccount/helm-controller created -# serviceaccount/kustomize-controller created -# serviceaccount/notification-controller created -# serviceaccount/source-controller created -# clusterrole.rbac.authorization.k8s.io/crd-controller-flux-system created -# clusterrolebinding.rbac.authorization.k8s.io/cluster-reconciler-flux-system created -# clusterrolebinding.rbac.authorization.k8s.io/crd-controller-flux-system created -# service/notification-controller created -# service/source-controller created -# service/webhook-receiver created -# deployment.apps/helm-controller created -# deployment.apps/kustomize-controller created -# deployment.apps/notification-controller created -# deployment.apps/source-controller created +# ... # unable to recognize "./cluster/base/flux-system": no matches for kind "Kustomization" in version "kustomize.toolkit.fluxcd.io/v1beta1" # unable to recognize "./cluster/base/flux-system": no matches for kind "GitRepository" in version "source.toolkit.fluxcd.io/v1beta1" # unable to recognize "./cluster/base/flux-system": no matches for kind "HelmRepository" in version "source.toolkit.fluxcd.io/v1beta1" @@ -393,9 +391,9 @@ Show the health of your `HelmRelease`s ```sh flux --kubeconfig=./kubeconfig get helmrelease -A # NAMESPACE NAME READY MESSAGE REVISION SUSPENDED -# cert-manager cert-manager True Release reconciliation succeeded v1.3.0 False -# default homer True Release reconciliation succeeded 4.2.0 False -# networking ingress-nginx True Release reconciliation succeeded 3.29.0 False +# cert-manager cert-manager True Release reconciliation succeeded v1.5.2 False +# default hajimari True Release reconciliation succeeded 1.1.1 False +# networking ingress-nginx True Release reconciliation succeeded 3.30.0 False ``` Show the health of your `HelmRepository`s @@ -404,6 +402,7 @@ Show the health of your `HelmRepository`s flux --kubeconfig=./kubeconfig get sources helm -A # NAMESPACE NAME READY MESSAGE REVISION SUSPENDED # flux-system bitnami-charts True Fetched revision: 0ec3a3335ff991c45735866feb1c0830c4ed85cf 0ec3a3335ff991c45735866feb1c0830c4ed85cf False +# flux-system hajimari-charts True Fetched revision: 1b24af9c5a1e3da91618d597f58f46a57c70dc13 1b24af9c5a1e3da91618d597f58f46a57c70dc13 False # flux-system ingress-nginx-charts True Fetched revision: 45669a3117fc93acc09a00e9fb9b4445e8990722 45669a3117fc93acc09a00e9fb9b4445e8990722 False # flux-system jetstack-charts True Fetched revision: 7bad937cc82a012c9ee7d7a472d7bd66b48dc471 7bad937cc82a012c9ee7d7a472d7bd66b48dc471 False # flux-system k8s-at-home-charts True Fetched revision: 1b24af9c5a1e3da91618d597f58f46a57c70dc13 1b24af9c5a1e3da91618d597f58f46a57c70dc13 False