/formulas-aws

Ritchie CLI formulas to create a Kubernetes Cluster on AWS through one command line 🤖 🛠

Primary LanguageGoApache License 2.0Apache-2.0

Security Pipeline Terraform Security Scan

Formulas AWS

title

📚 Documentation

This repository contains Ritchie formulas which can be executed by the ritchie-cli.

📦 Use Formulas

To import this repository, you need Ritchie CLI installed

Then, you can use the rit add repo command manually, or execute the command line below directly on your terminal (since CLI version 2.8.0):

rit add repo --provider="Github" --name="formulas-aws" --repoUrl="https://github.com/GuillaumeFalourd/formulas-aws" --priority=1

Finally, you can check if the repository has been imported correctly by executing the rit list repo command.

🆙 How to give priority

The commons repository installed through the rit init command of Ritchie CLI has duplicated commands with the formulas-aws repository.

You have to set priority 0 for the formulas-aws repository, and set priority 1 for the commons repository, for the rit aws create cluster command to work.

This can be achieved through the rit set repo-priority command.

🔎 What you'll find in this repository

Rit aws create cluster

⚠️ Caution

This repository is a DEMO to show what is possible to perform using Ritchie CLI.

The formula's templates use specific and sometimes latest providers versions (for aws, terraform, helm, kubernetes, etc...).

Therefore, the pipeline created by the formula may not work without updating the versions compatibility in the future.

If that happens, the recommendation is to fork the repo and update the templates' versions.

⚙️ How does it work?

Youtube Video

Youtube video

1 - Execute the rit aws create clustercommand:

2 - Check the code on your repository:

Repository ritchie-tdc-recife

3 - Wait for the pipeline to run on circleci:

4 - Check your cluster on AWS:

🗃 Sample repositories used for demonstrations:

♻️ Contribute to the repository

🆕 Creating formulas

  1. Fork and clone the repository
  2. Create a branch: git checkout -b <branch_name>
  3. Check the step by step of how to create formulas on Ritchie
  4. Add your formulas to the repository and commit your implementation: git commit -m '<commit_message>
  5. Push your branch: git push origin <project_name>/<location>
  6. Open a pull request on the repository for analysis.

🆒 Updating Formulas

  1. Fork and clone the repository
  2. Create a branch: git checkout -b <branch_name>
  3. Add the cloned repository to your workspaces (rit add workspace) with a highest priority (for example: 1).
  4. Check the step by step of how to implement formulas on Ritchie and commit your implementation: git commit -m '<commit_message>
  5. Push your branch: git push origin <project_name>/<location>
  6. Open a pull request on the repository for analysis.