infra/home-cluster
2
0 Fork 0
Code Issues Pull Requests 40 Actions Packages Projects Releases Wiki Activity

Small typo / grammar fix in README (#300)

Browse Source
This commit is contained in:
Nicky van Meurs authored and GitHub committed 2022-04-30 09:13:27 -04:00
1 parent 8fa29a86b9
commit b61b3cb76c
1 file changed
+13 -9
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -9
View File
@@ -93,16 +93,20 @@ After pre-commit is installed on your machine run:
```sh ```sh
task pre-commit:init task pre-commit:init
``` ```
**Remember to run this on each new clone of the repository for it to have effect.** **Remember to run this on each new clone of the repository for it to have effect.**
Commands are of interest, for learning purposes: Commands are of interest, for learning purposes:
This command makes it so pre-commit runs on `git commit`, and also installs environments per the config file. This command makes it so pre-commit runs on `git commit`, and also installs environments per the config file.
```
```sh
pre-commit install --install-hooks pre-commit install --install-hooks
``` ```
This command checks for new versions of hooks, though it will occasionally make mistakes, so verify its results. This command checks for new versions of hooks, though it will occasionally make mistakes, so verify its results.
```
```sh
pre-commit autoupdate pre-commit autoupdate
``` ```
@@ -135,7 +139,7 @@ cluster
└── traefik └── traefik
``` ```
## 🚀 Lets go! ## 🚀 Lets go
Very first step will be to create a new repository by clicking the **Use this template** button on this page. Very first step will be to create a new repository by clicking the **Use this template** button on this page.
@@ -197,7 +201,7 @@ In order to use Terraform and `cert-manager` with the Cloudflare DNS challenge y
📍 Nodes are not security hardened by default, you can do this with [dev-sec/ansible-collection-hardening](https://github.com/dev-sec/ansible-collection-hardening) or something similar. 📍 Nodes are not security hardened by default, you can do this with [dev-sec/ansible-collection-hardening](https://github.com/dev-sec/ansible-collection-hardening) or something similar.
1. Ensure you are able to SSH into you nodes from your workstation with using your private ssh key. This is how Ansible is able to connect to your remote nodes. [How to configure SSH key-based authentication](https://www.digitalocean.com/community/tutorials/how-to-configure-ssh-key-based-authentication-on-a-linux-server) 1. Ensure you are able to SSH into your nodes from your workstation using your private ssh key. This is how Ansible is able to connect to your remote nodes.
2. Install the deps by running `task ansible:deps` 2. Install the deps by running `task ansible:deps`
@@ -349,11 +353,11 @@ The world is your cluster and the first thing you might want to do is to have st
In no particular order, here are some popular storage related items you could install and use in your cluster: In no particular order, here are some popular storage related items you could install and use in your cluster:
* [rook-ceph](https://github.com/rook/rook) - [rook-ceph](https://github.com/rook/rook)
* [nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner) - [nfs-subdir-external-provisioner](https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner)
* [democratic-csi](https://github.com/democratic-csi/democratic-csi) - [democratic-csi](https://github.com/democratic-csi/democratic-csi)
* [csi-driver-nfs](https://github.com/kubernetes-csi/csi-driver-nfs) - [csi-driver-nfs](https://github.com/kubernetes-csi/csi-driver-nfs)
* [longhorn](https://github.com/longhorn/longhorn) - [longhorn](https://github.com/longhorn/longhorn)
Community member @Whazor created [this website](https://whazor.github.io/k8s-at-home-search/) as a means to search Helm Releases across GitHub. You may use it as a means to get ideas on how to configure an applications' Helm values. Community member @Whazor created [this website](https://whazor.github.io/k8s-at-home-search/) as a means to search Helm Releases across GitHub. You may use it as a means to get ideas on how to configure an applications' Helm values.