diff --git a/README.md b/README.md index 9972a57..0b9ae47 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,14 @@ A.K.A. _Operations, administration and management_ or _operations, administratio In short, my private collection of notes and scripts. I use them to ease my tech life. +## Table of contents + +1. [License](#license) +1. [Status](#status) +1. [Support](#support) +1. [Contributing](#contributing) +1. [Sources](#sources) + ## License The MIT license is used here, see [LICENSE]. @@ -26,9 +34,15 @@ I might accept suggestions, though. Use the repository's hosting platform's tool - [myshittycode.com] - + + + [contributing]: #contributing + + [license]: LICENSE - + [myshittycode.com]: https://myshittycode.com/ diff --git a/ansible/roles/README.md b/ansible/roles/README.md index a5a8c55..599c7ef 100644 --- a/ansible/roles/README.md +++ b/ansible/roles/README.md @@ -2,9 +2,15 @@ > _Hey! Where is everything?_ -All working roles I created are either private, or made public through [Ansible Galaxy][galaxy] and repositories on [GitHub] or [GitLab]. Please have a look there. +All working roles I created are either private, or made public through [Ansible Galaxy][galaxy] and repositories on [GitHub] or [GitLab]. - +Have a look there! + + + + [galaxy]: https://galaxy.ansible.com/mcereda [github]: https://github.com/mcereda [gitlab]: https://gitlab.com/mckie diff --git a/docker/boinc-client/README.md b/docker/boinc-client/README.md index 7aecdc1..65f8ef6 100644 --- a/docker/boinc-client/README.md +++ b/docker/boinc-client/README.md @@ -1,5 +1,13 @@ # Boinc client on Docker +## Table of contents + +1. [Parameters](#parameters) +1. [Docker Compose](#docker-compose) +1. [Attach to an account manager](#attach-to-an-account-manager) +1. [TODO](#todo) +1. [Sources](#sources) + ## Parameters Parameter | Type | Default | Function @@ -47,5 +55,10 @@ boinccmd --acct_mgr attach https://bam.boincstats.com $USER $PASSWORD - [Github] - [Docker Hub] + + + [docker hub]: https://hub.docker.com/r/boinc/client [github]: https://github.com/BOINC/boinc-client-docker diff --git a/docker/keybaseio-git-client/README.md b/docker/keybaseio-git-client/README.md index 91efbdf..e796a45 100644 --- a/docker/keybaseio-git-client/README.md +++ b/docker/keybaseio-git-client/README.md @@ -4,9 +4,11 @@ The image gets `git` so I can use it to manage my repositories on keybase.io. Can surely be vastly improved. +## Table of contents + 1. [TL;DR](#tldr) -2. [Permissions mismatch in the binded directory](#permissions-mismatch-in-the-binded-directory) -3. [Further readings](#further-readings) +1. [Permissions mismatch in the binded directory](#permissions-mismatch-in-the-binded-directory) +1. [Further readings](#further-readings) ## TL;DR @@ -122,11 +124,17 @@ drwxr-xr-x 1 keybase keybase 304 Sep 18 08:04 repo - [keybaseio/client] on DockerHub - [Configure the selinux label] -- [How to create docker volume device/host path] (not used but interesting) +- [How to create docker volume device/host path] (not used, but interesting) - [Docker and the Host Filesystem Owner Matching Problem] + + + [keybaseio/client]: https://hub.docker.com/r/keybaseio/client + [configure the selinux label]: https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label [how to create docker volume device/host path]: https://stackoverflow.com/questions/49950326/how-to-create-docker-volume-device-host-path#49952217 [docker and the host filesystem owner matching problem]: https://www.fullstaq.com/knowledge-hub/blogs/docker-and-the-host-filesystem-owner-matching-problem diff --git a/docker/nextcloud/README.md b/docker/nextcloud/README.md index a6f5665..f288836 100644 --- a/docker/nextcloud/README.md +++ b/docker/nextcloud/README.md @@ -1,7 +1,16 @@ # Nextcloud docker image +## Table of contents + +1. [Sources](#sources) + ## Sources - [Docker Hub] + + + [docker hub]: https://hub.docker.com/_/nextcloud diff --git a/docker/pihole/README.md b/docker/pihole/README.md index 8e06ff6..032d47a 100644 --- a/docker/pihole/README.md +++ b/docker/pihole/README.md @@ -1,5 +1,11 @@ # Pi-hole +## Table of contents + +1. [TL;DR](#tldr) +1. [Further readings](#further-readings) +1. [Sources](#sources) + ## TL;DR ```sh @@ -21,8 +27,18 @@ docker exec pihole stat /etc/pihole/gravity.db ## Sources +All the references in the [further readings] section, plus the following: + - [Docker Hub] + + + [docker hub]: https://hub.docker.com/r/pihole/pihole [documentation]: https://docs.pi-hole.net/ [github]: https://github.com/pi-hole/docker-pi-hole/ + + +[further readings]: #further-readings diff --git a/examples/kubernetes/create an admission webhook/README.md b/examples/kubernetes/create an admission webhook/README.md index 5e58371..599c80e 100644 --- a/examples/kubernetes/create an admission webhook/README.md +++ b/examples/kubernetes/create an admission webhook/README.md @@ -237,7 +237,11 @@ All the references in the [further readings] section, plus the following: - [writing a very basic kubernetes mutating admission webhook] - Istio's [script][certificate script] to generate a certificate signing request - + + + [admission request]: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#request [admission response]: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#response [cert script]: create-signed-cert.sh @@ -247,10 +251,10 @@ All the references in the [further readings] section, plus the following: [resources]: resources.yaml [webhook.py]: webhook.py - + [further readings]: #further-readings - + [building a kubernetes mutating admission webhook]: https://didil.medium.com/building-a-kubernetes-mutating-admission-webhook-7e48729523ed [creating your own admission controller]: https://docs.giantswarm.io/guides/creating-your-own-admission-controller/ [diving into kubernetes mutatingadmissionwebhook]: https://medium.com/ibm-cloud/diving-into-kubernetes-mutatingadmissionwebhook-6ef3c5695f74 diff --git a/examples/kubernetes/grafana on k8s using helm.md b/examples/kubernetes/grafana on k8s using helm.md index 3e866b5..704d73c 100644 --- a/examples/kubernetes/grafana on k8s using helm.md +++ b/examples/kubernetes/grafana on k8s using helm.md @@ -1,5 +1,13 @@ # Grafana on Kubernetes using Helm +## Table of contents + +1. [Usage](#usage) +1. [Gotchas](#gotchas) +1. [Further readings](#further-readings) + +## Usage + Installation: 1. add the repository: @@ -57,5 +65,12 @@ Useful dashboards: - Official [helm chart] - [Set up prometheus and ingress on kubernetes] + + + [helm chart]: https://github.com/grafana/helm-charts/tree/main/charts/grafana + + [set up prometheus and ingress on kubernetes]: https://blog.gojekengineering.com/diy-how-to-set-up-prometheus-and-ingress-on-kubernetes-d395248e2ba diff --git a/examples/kubernetes/prometheus on k8s using helm.md b/examples/kubernetes/prometheus on k8s using helm.md index b55638a..c9a3596 100644 --- a/examples/kubernetes/prometheus on k8s using helm.md +++ b/examples/kubernetes/prometheus on k8s using helm.md @@ -1,5 +1,13 @@ # Prometheus on Kubernetes using Helm +## Table of contents + +1. [Usage](#usage) +1. [Further readings](#further-readings) +1. [Sources](#sources) + +## Usage + Installation: ```sh @@ -43,12 +51,16 @@ All the references in the [further readings] section, plus the following: - [Helm chart] - + + + [helm chart]: https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus - + [further readings]: #further-readings - + [install prometheus and grafana with helm 3 on a local machine vm]: https://dev.to/ko_kamlesh/install-prometheus-grafana-with-helm-3-on-local-machine-vm-1kgj [set up prometheus and ingress on kubernetes]: https://blog.gojekengineering.com/diy-how-to-set-up-prometheus-and-ingress-on-kubernetes-d395248e2ba diff --git a/examples/terraform/enterprise/airgapped terraform enterprise on azure/README.md b/examples/terraform/enterprise/airgapped terraform enterprise on azure/README.md index 8d98234..24d50c8 100644 --- a/examples/terraform/enterprise/airgapped terraform enterprise on azure/README.md +++ b/examples/terraform/enterprise/airgapped terraform enterprise on azure/README.md @@ -4,8 +4,10 @@ Stateless active/active. +## Table of contents + 1. [Requirements](#requirements) -2. [Sources](#sources) +1. [Sources](#sources) ## Requirements @@ -31,15 +33,15 @@ Stateless active/active. - Hashicorp's [Terraform Enterprise Azure Module][hashicorp/terraform-azurerm-terraform-enterprise] on GitHub - Azure's [Terraform Enterprise Azure Instance Module][azure-terraform/terraform-azurerm-terraform-enterprise-instance] on GitHub - -[requirements diagram]: design/images/requirements.png + - -[terraform enterprise]: https://developer.hashicorp.com/terraform/enterprise - - + [automated installations]: https://help.replicated.com/docs/native/customer-installations/automating/ - - [azure-terraform/terraform-azurerm-terraform-enterprise-instance]: https://github.com/Azure-Terraform/terraform-azurerm-terraform-enterprise-instance [hashicorp/terraform-azurerm-terraform-enterprise]: https://github.com/hashicorp/terraform-azurerm-terraform-enterprise +[terraform enterprise]: https://developer.hashicorp.com/terraform/enterprise + + +[requirements diagram]: design/images/requirements.png diff --git a/examples/terraform/oracle cloud/connect using ssh to an instance through a bastion/README.md b/examples/terraform/oracle cloud/connect using ssh to an instance through a bastion/README.md index 57e7f7c..b21ca2e 100644 --- a/examples/terraform/oracle cloud/connect using ssh to an instance through a bastion/README.md +++ b/examples/terraform/oracle cloud/connect using ssh to an instance through a bastion/README.md @@ -2,10 +2,12 @@ Simple example to create a Bastion in Oracle Cloud. +## Table of contents + 1. [Requirements](#requirements) -2. [Connect to the instance using SSH through the bastion](#connect-to-the-instance-using-ssh-through-the-bastion) -3. [Further readings](#further-readings) -4. [Sources](#sources) +1. [Connect to the instance using SSH through the bastion](#connect-to-the-instance-using-ssh-through-the-bastion) +1. [Further readings](#further-readings) +1. [Sources](#sources) ## Requirements @@ -54,18 +56,30 @@ ssh -fN bastion && ssh instance ## Further readings +- [Ridiculously powerful free server in the cloud] + ## Sources -- [Ridiculously powerful free server in the cloud] +All the references in the [further readings] section, plus the following: + - [Always free resources] in Oracle Cloud - [Oracle Cloud Infrastructure Provider documentation] - [oracle-terraform-modules/terraform-oci-compute-instance] - -[requirements]: design/requirements.png + - + [always free resources]: https://docs.oracle.com/en-us/iaas/Content/FreeTier/freetier_topic-Always_Free_Resources.htm [oracle cloud infrastructure provider documentation]: https://registry.terraform.io/providers/oracle/oci/latest/docs -[ridiculously powerful free server in the cloud]: https://medium.com/codex/ridiculously-powerful-free-server-in-the-cloud-dd4da8524a9c [oracle-terraform-modules/terraform-oci-compute-instance]: https://github.com/oracle-terraform-modules/terraform-oci-compute-instance + + +[further readings]: #further-readings + + +[requirements]: design/requirements.png + + +[ridiculously powerful free server in the cloud]: https://medium.com/codex/ridiculously-powerful-free-server-in-the-cloud-dd4da8524a9c diff --git a/examples/terraform/oracle cloud/create a free tier ampere instance/README.md b/examples/terraform/oracle cloud/create a free tier ampere instance/README.md index 767e695..41ed27c 100644 --- a/examples/terraform/oracle cloud/create a free tier ampere instance/README.md +++ b/examples/terraform/oracle cloud/create a free tier ampere instance/README.md @@ -2,9 +2,11 @@ Simple example to create an Ampere VM instance in Oracle Cloud's free tier. +## Table of contents + 1. [Requirements](#requirements) -2. [Further readings](#further-readings) -3. [Sources](#sources) +1. [Further readings](#further-readings) +1. [Sources](#sources) ## Requirements @@ -20,18 +22,30 @@ A solution to this is to create a new Route Table **with** the default route abo ## Further readings +- [Ridiculously powerful free server in the cloud] + ## Sources -- [Ridiculously powerful free server in the cloud] +All the references in the [further readings] section, plus the following: + - [Always free resources] in Oracle Cloud - [Oracle Cloud Infrastructure Provider documentation] - [oracle-terraform-modules/terraform-oci-compute-instance] - -[requirements]: design/requirements.png + - + [always free resources]: https://docs.oracle.com/en-us/iaas/Content/FreeTier/freetier_topic-Always_Free_Resources.htm [oracle cloud infrastructure provider documentation]: https://registry.terraform.io/providers/oracle/oci/latest/docs -[ridiculously powerful free server in the cloud]: https://medium.com/codex/ridiculously-powerful-free-server-in-the-cloud-dd4da8524a9c [oracle-terraform-modules/terraform-oci-compute-instance]: https://github.com/oracle-terraform-modules/terraform-oci-compute-instance + + +[further readings]: #further-readings + + +[requirements]: design/requirements.png + + +[ridiculously powerful free server in the cloud]: https://medium.com/codex/ridiculously-powerful-free-server-in-the-cloud-dd4da8524a9c diff --git a/examples/vagrant/beowulf cluster/README.md b/examples/vagrant/beowulf cluster/README.md index b8fc8aa..17b2f73 100644 --- a/examples/vagrant/beowulf cluster/README.md +++ b/examples/vagrant/beowulf cluster/README.md @@ -1,6 +1,10 @@ # Beowulf cluster example -## Requirements: +## Table of contents + +1. [Requirements](#requirements) + +## Requirements - VirtualBox - A host-only virtual network (`VirtualBox Host-Only Ethernet Adapter`, address space `192.168.56.0/24`) @@ -19,6 +23,10 @@ When up, execute the command below and enjoy: vagrant ssh -c 'mpiexec -f mpi_hosts -n 3 hostname' ``` - + + + [mpi_hosts.txt]: mpi_hosts.txt [ssh_config.txt]: ssh_config.txt diff --git a/little snitch/README.md b/little snitch/README.md index 7bbf87f..9bd267a 100644 --- a/little snitch/README.md +++ b/little snitch/README.md @@ -1,5 +1,7 @@ # Little Snitch +## Table of contents + 1. [Rules](#rules) 1. [Further readings](#further-readings) 1. [Sources](#sources) @@ -18,11 +20,19 @@ All the references in the [further readings] section, plus the following: - [Commonly whitelisted domains] - -[full ruleset]: rules/all.lsrules + + + [further readings]: #further-readings + + [little snitch]: ../knowledge%20base/mac%20os%20x/little%20snitch.md + + +[full ruleset]: rules/all.lsrules [parts]: rules/parts/ - + [commonly whitelisted domains]: https://discourse.pi-hole.net/t/commonly-whitelisted-domains/212 diff --git a/terraform/README.md b/terraform/README.md index d56455b..553a5dd 100644 --- a/terraform/README.md +++ b/terraform/README.md @@ -1,18 +1,29 @@ # Terraform +## Table of contents + +1. [Modules](#modules) +1. [Examples](#examples) + ## Modules > _Hey! Where is everything?_ -All working modules I created are either private, or made public through repositories on [GitHub] or [GitLab]. Please have a look there. +All working modules I created are either private, or made public through repositories on [GitHub] or [GitLab]. + +Have a look there! ## Examples Check them [here][examples]. - + + + [examples]: ../examples/terraform - + [github]: https://github.com/mcereda [gitlab]: https://gitlab.com/mckie