brandon/oam
1
0
Fork 0
mirror of https://gitea.com/mcereda/oam.git synced 2026-02-08 21:34:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: aligned docs to the template file for articles

Browse Source
This commit is contained in:
Michele Cereda
2023-07-09 16:59:55 +02:00
parent f6c023b3fb
commit 4b4d3f73b3
15 changed files with 201 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -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. In short, my private collection of notes and scripts. I use them to ease my tech life.
## Table of contents <!-- omit in toc -->
1. [License](#license)
1. [Status](#status)
1. [Support](#support)
1. [Contributing](#contributing)
1. [Sources](#sources)
## License ## License
The MIT license is used here, see [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] - [myshittycode.com]
<!-- internal references --> <!--
References
-->
<!-- In-article sections -->
[contributing]: #contributing [contributing]: #contributing
<!-- Files -->
[license]: LICENSE [license]: LICENSE
<!-- external references --> <!-- Others -->
[myshittycode.com]: https://myshittycode.com/ [myshittycode.com]: https://myshittycode.com/

10
ansible/roles/README.md
View File

@@ -2,9 +2,15 @@
> _Hey! Where is everything?_ > _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].
<!-- external references --> Have a look there!
<!--
References
-->
<!-- Others -->
[galaxy]: https://galaxy.ansible.com/mcereda [galaxy]: https://galaxy.ansible.com/mcereda
[github]: https://github.com/mcereda [github]: https://github.com/mcereda
[gitlab]: https://gitlab.com/mckie [gitlab]: https://gitlab.com/mckie

13
docker/boinc-client/README.md
View File

@@ -1,5 +1,13 @@
# Boinc client on Docker # Boinc client on Docker
## Table of contents <!-- omit in toc -->
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 ## Parameters
Parameter | Type | Default | Function Parameter | Type | Default | Function
@@ -47,5 +55,10 @@ boinccmd --acct_mgr attach https://bam.boincstats.com $USER $PASSWORD
- [Github] - [Github]
- [Docker Hub] - [Docker Hub]
<!--
References
-->
<!-- Upstream -->
[docker hub]: https://hub.docker.com/r/boinc/client [docker hub]: https://hub.docker.com/r/boinc/client
[github]: https://github.com/BOINC/boinc-client-docker [github]: https://github.com/BOINC/boinc-client-docker

14
docker/keybaseio-git-client/README.md
View File

@@ -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. Can surely be vastly improved.
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr) 1. [TL;DR](#tldr)
2. [Permissions mismatch in the binded directory](#permissions-mismatch-in-the-binded-directory) 1. [Permissions mismatch in the binded directory](#permissions-mismatch-in-the-binded-directory)
3. [Further readings](#further-readings) 1. [Further readings](#further-readings)
## TL;DR ## TL;DR
@@ -122,11 +124,17 @@ drwxr-xr-x 1 keybase keybase 304 Sep 18 08:04 repo
- [keybaseio/client] on DockerHub - [keybaseio/client] on DockerHub
- [Configure the selinux label] - [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] - [Docker and the Host Filesystem Owner Matching Problem]
<!--
References
-->
<!-- Upstream -->
[keybaseio/client]: https://hub.docker.com/r/keybaseio/client [keybaseio/client]: https://hub.docker.com/r/keybaseio/client
<!-- Others -->
[configure the selinux label]: https://docs.docker.com/storage/bind-mounts/#configure-the-selinux-label [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 [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 [docker and the host filesystem owner matching problem]: https://www.fullstaq.com/knowledge-hub/blogs/docker-and-the-host-filesystem-owner-matching-problem

9
docker/nextcloud/README.md
View File

@@ -1,7 +1,16 @@
# Nextcloud docker image # Nextcloud docker image
## Table of contents <!-- omit in toc -->
1. [Sources](#sources)
## Sources ## Sources
- [Docker Hub] - [Docker Hub]
<!--
References
-->
<!-- Upstream -->
[docker hub]: https://hub.docker.com/_/nextcloud [docker hub]: https://hub.docker.com/_/nextcloud

16
docker/pihole/README.md
View File

@@ -1,5 +1,11 @@
# Pi-hole # Pi-hole
## Table of contents <!-- omit in toc -->
1. [TL;DR](#tldr)
1. [Further readings](#further-readings)
1. [Sources](#sources)
## TL;DR ## TL;DR
```sh ```sh
@@ -21,8 +27,18 @@ docker exec pihole stat /etc/pihole/gravity.db
## Sources ## Sources
All the references in the [further readings] section, plus the following:
- [Docker Hub] - [Docker Hub]
<!--
References
-->
<!-- Upstream -->
[docker hub]: https://hub.docker.com/r/pihole/pihole [docker hub]: https://hub.docker.com/r/pihole/pihole
[documentation]: https://docs.pi-hole.net/ [documentation]: https://docs.pi-hole.net/
[github]: https://github.com/pi-hole/docker-pi-hole/ [github]: https://github.com/pi-hole/docker-pi-hole/
<!-- In-article sections -->
[further readings]: #further-readings

10
examples/kubernetes/create an admission webhook/README.md
View File

@@ -237,7 +237,11 @@ All the references in the [further readings] section, plus the following:
- [writing a very basic kubernetes mutating admission webhook] - [writing a very basic kubernetes mutating admission webhook]
- Istio's [script][certificate script] to generate a certificate signing request - Istio's [script][certificate script] to generate a certificate signing request
<!-- upstream --> <!--
References
-->
<!-- Upstream -->
[admission request]: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#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 [admission response]: https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/#response
[cert script]: create-signed-cert.sh [cert script]: create-signed-cert.sh
@@ -247,10 +251,10 @@ All the references in the [further readings] section, plus the following:
[resources]: resources.yaml [resources]: resources.yaml
[webhook.py]: webhook.py [webhook.py]: webhook.py
<!-- internal references --> <!-- In-article sections -->
[further readings]: #further-readings [further readings]: #further-readings
<!-- external references --> <!-- Others -->
[building a kubernetes mutating admission webhook]: https://didil.medium.com/building-a-kubernetes-mutating-admission-webhook-7e48729523ed [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/ [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 [diving into kubernetes mutatingadmissionwebhook]: https://medium.com/ibm-cloud/diving-into-kubernetes-mutatingadmissionwebhook-6ef3c5695f74

15
examples/kubernetes/grafana on k8s using helm.md
View File

@@ -1,5 +1,13 @@
# Grafana on Kubernetes using Helm # Grafana on Kubernetes using Helm
## Table of contents <!-- omit in toc -->
1. [Usage](#usage)
1. [Gotchas](#gotchas)
1. [Further readings](#further-readings)
## Usage
Installation: Installation:
1. add the repository: 1. add the repository:
@@ -57,5 +65,12 @@ Useful dashboards:
- Official [helm chart] - Official [helm chart]
- [Set up prometheus and ingress on kubernetes] - [Set up prometheus and ingress on kubernetes]
<!--
References
-->
<!-- Upstream -->
[helm chart]: https://github.com/grafana/helm-charts/tree/main/charts/grafana [helm chart]: https://github.com/grafana/helm-charts/tree/main/charts/grafana
<!-- Others -->
[set up prometheus and ingress on kubernetes]: https://blog.gojekengineering.com/diy-how-to-set-up-prometheus-and-ingress-on-kubernetes-d395248e2ba [set up prometheus and ingress on kubernetes]: https://blog.gojekengineering.com/diy-how-to-set-up-prometheus-and-ingress-on-kubernetes-d395248e2ba

18
examples/kubernetes/prometheus on k8s using helm.md
View File

@@ -1,5 +1,13 @@
# Prometheus on Kubernetes using Helm # Prometheus on Kubernetes using Helm
## Table of contents <!-- omit in toc -->
1. [Usage](#usage)
1. [Further readings](#further-readings)
1. [Sources](#sources)
## Usage
Installation: Installation:
```sh ```sh
@@ -43,12 +51,16 @@ All the references in the [further readings] section, plus the following:
- [Helm chart] - [Helm chart]
<!-- upstream --> <!--
References
-->
<!-- Upstream -->
[helm chart]: https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus [helm chart]: https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus
<!-- internal references --> <!-- In-article sections -->
[further readings]: #further-readings [further readings]: #further-readings
<!-- external references --> <!-- Others -->
[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 [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 [set up prometheus and ingress on kubernetes]: https://blog.gojekengineering.com/diy-how-to-set-up-prometheus-and-ingress-on-kubernetes-d395248e2ba

20
examples/terraform/enterprise/airgapped terraform enterprise on azure/README.md
View File

@@ -4,8 +4,10 @@
Stateless active/active. Stateless active/active.
## Table of contents <!-- omit in toc -->
1. [Requirements](#requirements) 1. [Requirements](#requirements)
2. [Sources](#sources) 1. [Sources](#sources)
## Requirements ## Requirements
@@ -31,15 +33,15 @@ Stateless active/active.
- Hashicorp's [Terraform Enterprise Azure Module][hashicorp/terraform-azurerm-terraform-enterprise] on GitHub - 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 - Azure's [Terraform Enterprise Azure Instance Module][azure-terraform/terraform-azurerm-terraform-enterprise-instance] on GitHub
<!-- knowledge base --> <!--
[requirements diagram]: design/images/requirements.png References
-->
<!-- hashicorp references --> <!-- Upstream -->
[terraform enterprise]: https://developer.hashicorp.com/terraform/enterprise
<!-- replicated references -->
[automated installations]: https://help.replicated.com/docs/native/customer-installations/automating/ [automated installations]: https://help.replicated.com/docs/native/customer-installations/automating/
<!-- repositories -->
[azure-terraform/terraform-azurerm-terraform-enterprise-instance]: https://github.com/Azure-Terraform/terraform-azurerm-terraform-enterprise-instance [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 [hashicorp/terraform-azurerm-terraform-enterprise]: https://github.com/hashicorp/terraform-azurerm-terraform-enterprise
[terraform enterprise]: https://developer.hashicorp.com/terraform/enterprise
<!-- Knowledge base -->
[requirements diagram]: design/images/requirements.png

30
examples/terraform/oracle cloud/connect using ssh to an instance through a bastion/README.md
View File

@@ -2,10 +2,12 @@
Simple example to create a Bastion in Oracle Cloud. Simple example to create a Bastion in Oracle Cloud.
## Table of contents <!-- omit in toc -->
1. [Requirements](#requirements) 1. [Requirements](#requirements)
2. [Connect to the instance using SSH through the bastion](#connect-to-the-instance-using-ssh-through-the-bastion) 1. [Connect to the instance using SSH through the bastion](#connect-to-the-instance-using-ssh-through-the-bastion)
3. [Further readings](#further-readings) 1. [Further readings](#further-readings)
4. [Sources](#sources) 1. [Sources](#sources)
## Requirements ## Requirements
@@ -54,18 +56,30 @@ ssh -fN bastion && ssh instance
## Further readings ## Further readings
- [Ridiculously powerful free server in the cloud]
## Sources ## 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 - [Always free resources] in Oracle Cloud
- [Oracle Cloud Infrastructure Provider documentation] - [Oracle Cloud Infrastructure Provider documentation]
- [oracle-terraform-modules/terraform-oci-compute-instance] - [oracle-terraform-modules/terraform-oci-compute-instance]
<!-- internal references --> <!--
[requirements]: design/requirements.png References
-->
<!-- external references --> <!-- Upstream -->
[always free resources]: https://docs.oracle.com/en-us/iaas/Content/FreeTier/freetier_topic-Always_Free_Resources.htm [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 [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 [oracle-terraform-modules/terraform-oci-compute-instance]: https://github.com/oracle-terraform-modules/terraform-oci-compute-instance
<!-- In-article sections -->
[further readings]: #further-readings
<!-- Files -->
[requirements]: design/requirements.png
<!-- Others -->
[ridiculously powerful free server in the cloud]: https://medium.com/codex/ridiculously-powerful-free-server-in-the-cloud-dd4da8524a9c

28
examples/terraform/oracle cloud/create a free tier ampere instance/README.md
View File

@@ -2,9 +2,11 @@
Simple example to create an Ampere VM instance in Oracle Cloud's free tier. Simple example to create an Ampere VM instance in Oracle Cloud's free tier.
## Table of contents <!-- omit in toc -->
1. [Requirements](#requirements) 1. [Requirements](#requirements)
2. [Further readings](#further-readings) 1. [Further readings](#further-readings)
3. [Sources](#sources) 1. [Sources](#sources)
## Requirements ## Requirements
@@ -20,18 +22,30 @@ A solution to this is to create a new Route Table **with** the default route abo
## Further readings ## Further readings
- [Ridiculously powerful free server in the cloud]
## Sources ## 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 - [Always free resources] in Oracle Cloud
- [Oracle Cloud Infrastructure Provider documentation] - [Oracle Cloud Infrastructure Provider documentation]
- [oracle-terraform-modules/terraform-oci-compute-instance] - [oracle-terraform-modules/terraform-oci-compute-instance]
<!-- internal references --> <!--
[requirements]: design/requirements.png References
-->
<!-- external references --> <!-- Upstream -->
[always free resources]: https://docs.oracle.com/en-us/iaas/Content/FreeTier/freetier_topic-Always_Free_Resources.htm [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 [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 [oracle-terraform-modules/terraform-oci-compute-instance]: https://github.com/oracle-terraform-modules/terraform-oci-compute-instance
<!-- In-article sections -->
[further readings]: #further-readings
<!-- Files -->
[requirements]: design/requirements.png
<!-- Others -->
[ridiculously powerful free server in the cloud]: https://medium.com/codex/ridiculously-powerful-free-server-in-the-cloud-dd4da8524a9c

12
examples/vagrant/beowulf cluster/README.md
View File

@@ -1,6 +1,10 @@
# Beowulf cluster example # Beowulf cluster example
## Requirements: ## Table of contents <!-- omit in toc -->
1. [Requirements](#requirements)
## Requirements
- VirtualBox - VirtualBox
- A host-only virtual network (`VirtualBox Host-Only Ethernet Adapter`, address space `192.168.56.0/24`) - 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' vagrant ssh -c 'mpiexec -f mpi_hosts -n 3 hostname'
``` ```
<!-- internal references --> <!--
References
-->
<!-- Files -->
[mpi_hosts.txt]: mpi_hosts.txt [mpi_hosts.txt]: mpi_hosts.txt
[ssh_config.txt]: ssh_config.txt [ssh_config.txt]: ssh_config.txt

16
little snitch/README.md
View File

@@ -1,5 +1,7 @@
# Little Snitch # Little Snitch
## Table of contents <!-- omit in toc -->
1. [Rules](#rules) 1. [Rules](#rules)
1. [Further readings](#further-readings) 1. [Further readings](#further-readings)
1. [Sources](#sources) 1. [Sources](#sources)
@@ -18,11 +20,19 @@ All the references in the [further readings] section, plus the following:
- [Commonly whitelisted domains] - [Commonly whitelisted domains]
<!-- internal references--> <!--
[full ruleset]: rules/all.lsrules References
-->
<!-- In-article sections -->
[further readings]: #further-readings [further readings]: #further-readings
<!-- Knowledge base -->
[little snitch]: ../knowledge%20base/mac%20os%20x/little%20snitch.md [little snitch]: ../knowledge%20base/mac%20os%20x/little%20snitch.md
<!-- Files -->
[full ruleset]: rules/all.lsrules
[parts]: rules/parts/ [parts]: rules/parts/
<!-- external references --> <!-- Others -->
[commonly whitelisted domains]: https://discourse.pi-hole.net/t/commonly-whitelisted-domains/212 [commonly whitelisted domains]: https://discourse.pi-hole.net/t/commonly-whitelisted-domains/212

17
terraform/README.md
View File

@@ -1,18 +1,29 @@
# Terraform # Terraform
## Table of contents <!-- omit in toc -->
1. [Modules](#modules)
1. [Examples](#examples)
## Modules ## Modules
> _Hey! Where is everything?_ > _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 ## Examples
Check them [here][examples]. Check them [here][examples].
<!-- internal references --> <!--
References
-->
<!-- Files -->
[examples]: ../examples/terraform [examples]: ../examples/terraform
<!-- external references --> <!-- Others -->
[github]: https://github.com/mcereda [github]: https://github.com/mcereda
[gitlab]: https://gitlab.com/mckie [gitlab]: https://gitlab.com/mckie