Skip to content

doc: enhancement the usage #54

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.

Sign up for GitHub

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

Merged
tungbq merged 3 commits into from
Feb 29, 2024
Merged

doc: enhancement the usage #54

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eff0acb
doc: enhancement
tungbq Feb 29, 2024
97249a6
doc: enhancement.v1
tungbq Feb 29, 2024
2ec2382
doc: enhancement.v2
tungbq Feb 29, 2024
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
38 changes: 20 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@

Before you begin, make sure you have [Docker](https://docs.docker.com/engine/install/) installed. It's also beneficial to have a basic understanding of Docker concepts.

## How to Build
## Build your own image

NOTE: If you'd refer using the official prebuilt docker image from DockerHub, you can skip this section!

**1. Clone the Repository:**

Expand Down Expand Up @@ -55,7 +57,23 @@ docker build \
-t devops-toolkit:custom .
```

**4. Run the toolkit image:**
**4. Test the toolkit 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
```

## Use the official image from Docker Hub

- To be implemented via release proccess

## Use the toolkit image

One we have the image ready, let's play with it!

- Start toolkit container

Expand All @@ -75,22 +93,6 @@ docker run --rm devops-toolkit:latest python3 --version
docker run --rm devops-toolkit:latest python3 --version
```

<!-- **5. Customize the Build (Optional):** -->

## Use the image from Docker Hub

- To be implemented

## Test the toolkit 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 Core

Built on `ubuntu:22.04` base image
Expand Down