Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc | Reorganize menu, sections and part of the content #173

Merged
merged 20 commits into from
Apr 27, 2023
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
af0d76d
Rename 'First Steps', create 'Concepts' and 'Reference', move around …
diego-ojeda-binbash Apr 15, 2023
1f20c67
Move Features into AWS Ref Arch and consolidate that under the same d…
diego-ojeda-binbash Apr 16, 2023
4ee7649
Move around features between AWS and EKS, and several other refactors
diego-ojeda-binbash Apr 17, 2023
ed4e1b9
Refactor ansible ref arch
diego-ojeda-binbash Apr 17, 2023
5ee4e84
Fix links and a few other updates
diego-ojeda-binbash Apr 21, 2023
3bbea8c
Fix broken links
diego-ojeda-binbash Apr 23, 2023
ecac2aa
Add early troubleshooting credentials page
diego-ojeda-binbash Apr 24, 2023
4a6aadc
Fix conflicts
diego-ojeda-binbash Apr 24, 2023
c2bfb3f
Add EKS upgrade steps
diego-ojeda-binbash Apr 24, 2023
718d5e4
Fix lists
diego-ojeda-binbash Apr 24, 2023
c2347b4
Update cluster upgrade steps a bit
diego-ojeda-binbash Apr 25, 2023
67bc29c
Refactor the add-new-account page and several other small updates
diego-ojeda-binbash Apr 26, 2023
a4f6495
Improve troubleshooting section a bit
diego-ojeda-binbash Apr 27, 2023
8756526
Add ArgoCD page and split CI/CD index in different pages
diego-ojeda-binbash Apr 27, 2023
c5dfd41
Put back the admonitions in the AWS features page
diego-ojeda-binbash Apr 27, 2023
1e182da
Fix link to 2023 roadmap
diego-ojeda-binbash Apr 27, 2023
15dbd09
Update docs/concepts/what-is-leverage.md
diego-ojeda-binbash Apr 27, 2023
79276d2
Update docs/concepts/our-tech-stack.md
diego-ojeda-binbash Apr 27, 2023
56c8044
Update docs/concepts/index.md
diego-ojeda-binbash Apr 27, 2023
136279b
Update docs/try-leverage/add-aws-accounts.md
diego-ojeda-binbash Apr 27, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
template: overrides/main.html
---

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

# Concepts

## Welcome!
Welcome to Leverage's documentation! Here you will find the concepts you need to understand to work with our stack, the steps to try Leverage for yourself, and extensive documentation about every aspect of our solution.
diego-ojeda-binbash marked this conversation as resolved.
Show resolved Hide resolved

## Getting Started
Feel free to explore the following pages to know more about Leverage.

- [x] :books: See [**What is Leverage**](/concepts/what-is-leverage/) to fully understand what Leverage is.
- [x] :books: See [**Why Leverage**](/concepts/why-leverage/) to help you decide whether Leverage is the right tool for you.
- [x] :books: See [**What can Leverage do for you**](/concepts/what-leverage-can-do-for-you/) to understand more about the capabilities of Leverage.
- [x] :books: See [**Our Tech Stack**](/concepts/our-tech-stack/) to learn about our design choices for the technology stack.
9 changes: 9 additions & 0 deletions docs/concepts/next-steps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Next Steps
Now that you know the basic concepts about Leverage feel free to [give it a try](/try-leverage/) or check out the [User Guide](/user-guide/) section to go deeper into the implementation details. Links down below:

## Learn More
:books: See [**Try Leverage**](/try-leverage/) to take the tutorial that will help you deploy a basic AWS Landing Zone via Leverage.

:books: See [**User Guide**](/user-guide/) to take the comprehensive route to learn more about Leverage.

:books: See [**Work with us**](/work-with-us/) if you want to join us or know more about the team behind Leverage.
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
## Why we choose our tech stack
# Our Tech Stack
Leverage was built around the [AWS Well Architected Framework](https://aws.amazon.com/architecture/well-architected/) and it uses a stack that includes [Terraform](https://www.terraform.io/), [Ansible](https://www.ansible.com/), [Helm](https://helm.sh/) and other tools.

We are also adopters and supporters of Kubernetes and the Cloud Native movement, which you should become self-evident as you keep exploring our technology stack.
diego-ojeda-binbash marked this conversation as resolved.
Show resolved Hide resolved
Franr marked this conversation as resolved.
Show resolved Hide resolved

## Why did we choose our tech stack?

??? info "Why AWS❓"
Amazon Web Services (AWS) is the world’s most comprehensive and broadly adopted
Expand Down Expand Up @@ -77,7 +82,7 @@

:books: **Read More**

- [How it works: AWS Organizations](../../features/organization/organization/)
- [How it works: AWS Organizations](/user-guide/organization/organization/)
- [AWS Organizations](https://aws.amazon.com/organizations/)

??? info "Why AIM and roles❓"
Expand All @@ -92,7 +97,7 @@

:books: **Read More**

- [How it works: AWS IAM](../../features/identities/identities/)
- [How it works: AWS IAM](/user-guide/identities/identities/)
- [AWS Identity and Access Management (IAM)](https://aws.amazon.com/iam/)

??? info "Security | Why Web Application Firewall (WAF), Cloud Trail, Config, Guarduty❓"
Expand All @@ -107,7 +112,7 @@

:books: **Read More**

- [How it works: AWS Security](../../features/security/services/)
- [How it works: AWS Security](/user-guide/security/services/)
- [AWS Cloud Security](https://aws.amazon.com/security/)

??? info "Why VPC❓"
Expand All @@ -120,7 +125,7 @@

:books: **Read More**

- [How it works: AWS Networking](../../features/network/vpc-topology)
- [How it works: AWS Networking](/user-guide/network/vpc-topology)
- [AWS Virtual Private Cloud](https://aws.amazon.com/vpc)

??? info "Why Kubernetes (K8s) & AWS EKS❓"
Expand All @@ -143,7 +148,7 @@

:books: **Read More**

- [How it works: AWS EKS](../../features/compute/k8s-eks/)
- [How it works: AWS EKS](/user-guide/compute/k8s-eks/)
- [AWS EKS](https://aws.amazon.com/eks)
- [Kubernetes](https://kubernetes.io/)

Expand All @@ -161,7 +166,7 @@

:books: **Read More**

- [How it works: AWS Storage](../../features/storage/storage)
- [How it works: AWS Storage](/user-guide/storage/storage)
- [AWS S3](https://aws.amazon.com/s3)

??? info "Why RDS❓"
Expand All @@ -180,7 +185,7 @@

:books: **Read More**

- [How it works: AWS Databases](../../features/database/database/)
- [How it works: AWS Databases](/user-guide/database/database/)
- [AWS RDS](https://aws.amazon.com/rds)

??? info "Why Hashicorp Vault❓"
Expand All @@ -206,12 +211,5 @@

:books: **Read More**

- [How it works: Secrets](../../features/secrets/secrets/)
- [How it works: Secrets](/user-guide/secrets/secrets/)
- [Hashicorp Vault Project](https://www.vaultproject.io/)







19 changes: 19 additions & 0 deletions docs/concepts/what-is-leverage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# What is Leverage?
Leverage was made of a significant amount of knowledge, acquired through several years of experience, turned into an ecosystem of code, tools and workflows that enables you to build the AWS infrastructure for your applications and services quickly and securely.
diego-ojeda-binbash marked this conversation as resolved.
Show resolved Hide resolved

Since all the code and modules are already built, we can get you up and running **up to 10x faster** :rocket:
than a consulting company -- :white_check_mark: *typically in just a few weeks!* -- and on top of code that is thoroughly documented, tested, and has been proven in production at dozens of other project deployments.

## Core Components
Our focus is on creating reusable, high quality ![leverage-aws](/assets/images/icons/aws-emojipack/General_AWScloud.png "AWS"){: style="width:30px"} Cloud Infrastructure code, through our core components:

- [x] [**Reference Architecture**](/user-guide/ref-architecture-aws/overview/): Designed under optimal configs for the most popular modern web and mobile applications needs. Its design is fully based on the
[**AWS Well Architected Framework**](/work-with-us/support/#aws-well-architected-review).

- [x] [**Infrastructure as Code (IaC) Library**](/user-guide/infra-as-code-library/overview/): A collection of reusable, tested, production-ready E2E AWS Cloud infrastructure as code solutions, leveraged by modules written in: *Terraform, Ansible, Helm charts, Dockerfiles and Makefiles*.

- [x] [**Leverage CLI**](/user-guide/leverage-cli/overview/): projects' command line tool. Provides the means to interact and deploy Leverage Reference Architecture on AWS and if needed it allows you to define custom tasks to run.

## Video Presentation
Check out this **intro video** :octicons-video-16: that explains what Leverage is in less than 5 minutes:
<iframe width="560" height="315" src="https://www.youtube.com/embed/-vb9Qtz6mLs" title="Leverage Intro Video" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Original file line number Diff line number Diff line change
@@ -1,23 +1,7 @@
# Why Leverage?
# What can Leverage do for you?
Still not convinced? Check out the following sections which describe what Leverage can bring on the table depending on your role in a company.

## The problem
![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).
</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).
</figcaption>

### The problem & our solution intro video
<iframe width="560" height="315" src="https://www.youtube.com/embed/-vb9Qtz6mLs" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

## Why Leverage for CIOs, CTOs and VPs of Engineering?
## Leverage for CIOs, CTOs and VPs of Engineering

??? question "**Accelerate development and optimize costs**"
Annual cost savings are a new standard and best practice. Profits are being targeted to business development,
Expand Down Expand Up @@ -70,7 +54,7 @@
The `Leverage CLI` allows to build repeatable and immutable infrastructure. So your cloud development, staging and
production environments will consistently be the same.

## Why Leverage for DevOps Engineers, Cloud Architects and Software Engineers?
## Leverage for DevOps Engineers, Cloud Architects and Software Engineers

??? question "**Provisioning infrastructure as code (Iac)**"
Instead of manually provisioning infrastructure, the real benefits of cloud adoption come from orchestrating
Expand Down
21 changes: 21 additions & 0 deletions docs/concepts/why-leverage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Why Leverage?
By implementing our **Reference Architecture for AWS** and the **Infrastructure as Code (IaC) Library** via Leverage CLI, you will get your entire Cloud Native Application Infrastructure deployed in only a few weeks.

!!! info "Did you know?"
You can roll out Leverage by yourself or we can implement it for you! :muscle:

## The problem and our solution

### What are the problems you might be facing?
![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).
</figcaption>

### What is 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).
</figcaption>
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
Loading