Skip to content

Commit

Permalink
usage: create doc to guide user build custom version of the toolkit (#53
Browse files Browse the repository at this point in the history
)
  • Loading branch information
tungbq authored Feb 29, 2024
2 parents b621c87 + a3ef430 commit 5012846
Showing 1 changed file with 36 additions and 4 deletions.
40 changes: 36 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,49 @@ cd devops-toolkit

**3. Build the DevOps toolkit image:**

- Build with the default versions

```bash
docker build -t devops-toolkit:latest .
```

**4. Run the toolkit Image:**
- Build with single custom version

```bash
docker build \
--build-arg TERRAFORM_VERSION=1.7.0 \
-t devops-toolkit:custom .
```

- Start container
- Build with multiple custom versions

```bash
docker build \
--build-arg UBUNTU_VERSION=22.04 \
--build-arg PYTHON_VERSION=3.11.3 \
--build-arg ANSIBLE_VERSION=2.16.3 \
--build-arg TERRAFORM_VERSION=1.7.0 \
--build-arg KUBECTL_VERSION=1.29.2 \
--build-arg HELM_VERSION=3.14.2 \
--build-arg AWSCLI_VERSION=2.15.24 \
-t devops-toolkit:custom .
```

**4. Run the toolkit image:**

- Start toolkit container

```bash
docker run -it --rm devops-toolkit:latest
```

- Check python version
- Run python command to check version

```bash
docker run --rm devops-toolkit:latest python3 --version
```

- Run ansible command to check version

```bash
docker run --rm devops-toolkit:latest python3 --version
Expand All @@ -51,7 +81,7 @@ docker run --rm devops-toolkit:latest python3 --version

- To be implemented

## Test the image
## Test the toolkit image

Run below command to verify newly created image

Expand All @@ -74,6 +104,8 @@ Built on `ubuntu:22.04` base image
| 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) |

And more tools to be implemented...

## Contributing

- See: [CONTRIBUTING.md](./CONTRIBUTING.md)
Expand Down

0 comments on commit 5012846

Please sign in to comment.