From 6d37c54324bdf28ca7b540c4db08754fe493f24b Mon Sep 17 00:00:00 2001 From: Tung Bui Date: Thu, 29 Feb 2024 22:19:46 +0700 Subject: [PATCH] doc: add the tool versions in toolkit --- README.md | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c91f817..d5b96f1 100644 --- a/README.md +++ b/README.md @@ -14,27 +14,33 @@ Before you begin, make sure you have [Docker](https://docs.docker.com/engine/ins ## How to Build **1. Clone the Repository:** - ```bash - git clone https://github.com/tungbq/devops-toolkit.git - ``` + +```bash +git clone https://github.com/tungbq/devops-toolkit.git +``` **2. Navigate to the Repository:** - ```bash - cd devops-toolkit - ``` + +```bash +cd devops-toolkit +``` **3. Build the DevOps toolkit image:** - ```bash - docker build -t devops-toolkit:latest . - ``` +```bash +docker build -t devops-toolkit:latest . +``` **4. Run the toolkit Image:** + - Start container + ```bash docker run -it --rm devops-toolkit:latest ``` + - Check python version + ```bash docker run --rm devops-toolkit:latest python3 --version ``` @@ -42,15 +48,30 @@ docker run --rm devops-toolkit:latest python3 --version ## Use the image from Docker Hub + - To be implemented ## Test the image + +Run below command to verify newly created image + ```bash cd scripts chmod +x check_version_in_toolkit.sh .check_version_in_toolkit.sh devops-toolkit:latest ``` +## The DevOps Toolkit + +| Name | Version | Release | +| :-------- | :---------------------- | :------------------------------------------------------------------------------------------------- | +| Python | PYTHON_VERSION=3.11.3 | [Check](https://www.python.org/downloads/source/) | +| Ansible | ANSIBLE_VERSION=2.16.4 | [Check](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html) | +| Terraform | TERRAFORM_VERSION=1.7.4 | [Check](https://releases.hashicorp.com/terraform/) | +| Kubectl | KUBECTL_VERSION=1.29.2 | [Check](https://dl.k8s.io/release/stable.txt) | +| Helm | HELM_VERSION=3.14.2 | [Check](https://github.com/helm/helm/releases) | +| Awscli | AWSCLI_VERSION=2.15.24 | [Check](https://raw.githubusercontent.com/aws/aws-cli/v2/CHANGELOG.rst) | + ## Contributing - See: [CONTRIBUTING.md](./CONTRIBUTING.md)