Skip to content
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

docs: remove kind build base-image #1377

Merged
merged 1 commit into from
Feb 29, 2020
Merged

docs: remove kind build base-image #1377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion images/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

This directory contains sources for building the `kind` base "node" image.

The image can be built with `kind build base-image`.
The image can be built with `make quick`.

## Maintenance

Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/design/node-image.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ nested containers, systemd, and Kubernetes components.

This image is built on top of the ["base" image][base image].

Logic for building both can be found in [`pkg/build`][build package],
and they can be built with `kind build base-image` and `kind build node-image` respectively.
Logic for building ["node" image][node image] can be found in [`pkg/build`][build package],
and it can be built with `kind build node-image` respectively.

## Design

Expand Down
16 changes: 5 additions & 11 deletions site/content/docs/user/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,22 +234,16 @@ You may also try removing any unused data left by the Docker engine - e.g.,

### Building The Base Image

To build the `base-image` we use the `build` command:
To build the `base-image` we use the `make quick` command in `images/base` directory:
```
kind build base-image
make quick
```

If you want to specify the path to the base image source files you can use the
`--source` flag.

If `--source` is not specified, kind will attempt to automatically locate
the `images/base` base source directory.

By default, the base image will be tagged as `kindest/base:latest`.
If you want to change this, you can use the `--image` flag.
By default, the base image will be tagged as `kindest/base:$(date +v%Y%m%d)-$(git describe --always --dirty)` format.
If you want to change this, you can set `TAG` environment variable.

```
kind build base-image --image base:v0.1.0
TAG=v0.1.0 make quick
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder why we even document changing the base tag tbh ....

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lol, probably because we have the ability to pass the base image parameter when building a node image？ I also forget why there is this example here. 😂

```


Expand Down