brandon/oam
1
0
Fork 0
mirror of https://gitea.com/mcereda/oam.git synced 2026-02-28 05:54:24 +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

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]
- 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 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
<!-- internal references -->
<!-- In-article sections -->
[further readings]: #further-readings
<!-- external references -->
<!-- Others -->
[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

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

@@ -1,5 +1,13 @@
# Grafana on Kubernetes using Helm
## Table of contents <!-- omit in toc -->
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]
<!--
References
-->
<!-- Upstream -->
[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

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

@@ -1,5 +1,13 @@
# Prometheus on Kubernetes using Helm
## Table of contents <!-- omit in toc -->
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]
<!-- upstream -->
<!--
References
-->
<!-- Upstream -->
[helm chart]: https://github.com/prometheus-community/helm-charts/tree/main/charts/prometheus
<!-- internal references -->
<!-- In-article sections -->
[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
[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.
## Table of contents <!-- omit in toc -->
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
<!-- knowledge base -->
[requirements diagram]: design/images/requirements.png
<!--
References
-->
<!-- hashicorp references -->
[terraform enterprise]: https://developer.hashicorp.com/terraform/enterprise
<!-- replicated references -->
<!-- Upstream -->
[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
[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.
## Table of contents <!-- omit in toc -->
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]
<!-- 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
[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
<!-- 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.
## Table of contents <!-- omit in toc -->
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]
<!-- 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
[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
<!-- 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
## Requirements:
## Table of contents <!-- omit in toc -->
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'
```
<!-- internal references -->
<!--
References
-->
<!-- Files -->
[mpi_hosts.txt]: mpi_hosts.txt
[ssh_config.txt]: ssh_config.txt