Skip to content

Commit 8b72795

Browse files
authored
Merge pull request kubernetes#125536 from this-is-yaash/documentation-enhance
enhanced the docker build documentation for readability and clarity
2 parents 9d9b6fb + ef474a7 commit 8b72795

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

build/README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,26 @@ You must install and configure Google Cloud SDK if you want to upload your relea
1818

1919
## Overview
2020

21-
While it is possible to build Kubernetes using a local golang installation, we have a build process that runs in a Docker container. This simplifies initial set up and provides for a very consistent build and test environment.
21+
You can build Kubernetes in two environments:
22+
1. **Local `Go`** Environment, and
23+
2. **Docker Container** Environment
24+
25+
Building Kubernetes in a Docker container **simplifies the initial set-up** and provides a very consistent build and test environment.
26+
27+
## Clone the Repository
28+
Before you start building Kubernetes, make sure to clone the repository using the following command:
29+
```bash
30+
git clone https://github.com/kubernetes/kubernetes.git
31+
```
32+
Navigate to Kubernetes directory before executing scripts files:
33+
```bash
34+
cd kubernetes
35+
```
2236

2337
## Key scripts
38+
**Note:** Ensure you run all the scripts from the Kubernetes root directory.
2439

25-
The following scripts are found in the [`build/`](.) directory. Note that all scripts must be run from the Kubernetes root directory.
40+
The following scripts are found in the [`build/`](.) directory.
2641

2742
* [`build/run.sh`](run.sh): Run a command in a build docker container. Common invocations:
2843
* `build/run.sh make`: Build just linux binaries in the container. Pass options and packages as necessary.

0 commit comments

Comments
 (0)