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.

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

Preload images into docker volume #6720

Merged
Merged
Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d506aa1
Download preloaded images tarball with --download-only flag
Feb 20, 2020
bb11bc6
Create volume of preloaded images and mount it in
Feb 20, 2020
b8bc461
Rebased on master
Feb 20, 2020
335637f
Name tarball by k8s version name
Feb 20, 2020
055e4bb
Add run to docker command
Feb 20, 2020
0e88697
Delete container once it has finished executing
Feb 20, 2020
97ea1b0
Remove preloaded base image and add makefile rule to upload prelaoded…
Feb 20, 2020
19fa296
Compress with lz4
Feb 20, 2020
b0f685c
Move all preloading code into preload package
Feb 20, 2020
5ac8520
skip transferring binaries and transferring imagse if using preloaded…
Feb 20, 2020
55dd40e
Debugging
Feb 20, 2020
86df9ff
Rebased on master
Feb 21, 2020
c99bf76
Add checksum verification
Feb 21, 2020
cc1a6f1
Delete volume if it isn't extracted properly so future runs don't try…
Feb 21, 2020
328466f
Check if preloaded volume is attached before skipping binary transfer
Feb 21, 2020
97bf128
only use preloaded volumes for docker runtime
Feb 21, 2020
dee8852
Don't require authentication to get checksum
Feb 21, 2020
8409fc3
wait to finish downloading kic artifacts before starting machine
Feb 22, 2020
aefbf2c
Rebased on master
Feb 24, 2020
6b0e942
Rebased on master
Mar 2, 2020
333caff
Merge branch 'master' of https://github.com/kubernetes/minikube into …
Mar 2, 2020
697359b
Fixed lint
Mar 2, 2020
474561d
remove unused functions
Mar 2, 2020
095b4b4
small fixes
Mar 2, 2020
742b3e4
remove transfer binaries
Mar 2, 2020
d6e94c1
remove unused functions
Mar 2, 2020
481010d
added overlay2 to preloaded images tarball name
Mar 2, 2020
4996b14
check for preloaded images before loading again
Mar 2, 2020
05a46f6
remove unnecessary PreloadedVolume
Mar 3, 2020
26de146
Add integration test for docker download only
Mar 3, 2020
5961513
Include container runtime and tarball version in preloaded tarball name
Mar 3, 2020
3d291fd
Only add necessary directories to tarball
Mar 3, 2020
5d16281
use docker command line to check if image exists, since it is much fa…
Mar 3, 2020
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
9 changes: 4 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ VERSION_BUILD ?= 3
RAW_VERSION=$(VERSION_MAJOR).$(VERSION_MINOR).${VERSION_BUILD}
VERSION ?= v$(RAW_VERSION)

KUBERNETES_VERSION ?= $(shell egrep "^var DefaultKubernetesVersion" pkg/minikube/constants/constants.go | cut -d \" -f2)
KUBERNETES_VERSION ?= $(shell egrep "DefaultKubernetesVersion =" pkg/minikube/constants/constants.go | cut -d \" -f2)

# Default to .0 for higher cache hit rates, as build increments typically don't require new ISO versions
ISO_VERSION ?= v$(VERSION_MAJOR).$(VERSION_MINOR).3
Expand Down Expand Up @@ -512,10 +512,9 @@ kic-base-image: ## builds the base image used for kic.
docker build -f ./hack/images/kicbase.Dockerfile -t $(REGISTRY)/kicbase:v$(KIC_VERSION)-snapshot --build-arg COMMIT_SHA=${VERSION}-$(COMMIT) --target base .


.PHONY: kic-preloaded-base-image
kic-preloaded-base-image: generate-preloaded-images-tar ## builds the base image used for kic.
docker rmi -f $(REGISTRY)/kicbase:v$(KIC_VERSION)-k8s-${KUBERNETES_VERSION} || true
docker build -f ./hack/images/kicbase.Dockerfile -t $(REGISTRY)/kicbase:v$(KIC_VERSION)-k8s-${KUBERNETES_VERSION} --build-arg COMMIT_SHA=${VERSION}-$(COMMIT) --build-arg KUBERNETES_VERSION=${KUBERNETES_VERSION} .
.PHONY: upload-preloaded-images-tar
upload-preloaded-images-tar: generate-preloaded-images-tar # Upload the preloaded images tar to the GCS bucket. Specify a specific kubernetes version to build via `KUBERNETES_VERSION=vx.y.z make upload-preloaded-images-tar`.
gsutil cp out/preloaded-images-k8s-${KUBERNETES_VERSION}.tar.lz4 gs://minikube-docker-volume-tarballs

.PHONY: generate-preloaded-images-tar
generate-preloaded-images-tar: out/minikube
Expand Down
11 changes: 1 addition & 10 deletions hack/images/kicbase.Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
dnsutils \
openssh-server \
docker.io \
lz4 \
&& apt-get clean -y
# disable containerd by default
RUN systemctl disable containerd
Expand Down Expand Up @@ -43,13 +44,3 @@ RUN rm -rf \
/usr/share/man/* \
/usr/share/local/* \
RUN echo "kic! Build: ${COMMIT_SHA} Time :$(date)" > "/kic.txt"


FROM busybox
ARG KUBERNETES_VERSION
COPY out/preloaded-images-k8s-$KUBERNETES_VERSION.tar /preloaded-images.tar
RUN tar xvf /preloaded-images.tar -C /

FROM base
COPY --from=1 /var/lib/docker /var/lib/docker
COPY --from=1 /var/lib/minikube/binaries /var/lib/minikube/binaries
37 changes: 13 additions & 24 deletions hack/preload-images/preload_images.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ import (
"os"
"os/exec"
"path/filepath"
"strings"

"github.com/pkg/errors"
)
Expand All @@ -40,7 +39,7 @@ var (
func init() {
flag.StringVar(&kubernetesVersion, "kubernetes-version", "", "desired kubernetes version, for example `v1.17.2`")
flag.Parse()
tarballFilename = fmt.Sprintf("preloaded-images-k8s-%s.tar", kubernetesVersion)
tarballFilename = fmt.Sprintf("preloaded-images-k8s-%s.tar.lz4", kubernetesVersion)
}

func main() {
Expand All @@ -66,42 +65,32 @@ func executePreloadImages() error {
}

func startMinikube() error {
cmd := exec.Command(minikubePath, "start", "-p", profile, "--memory", "4000", "--kubernetes-version", kubernetesVersion, "--wait=false")
cmd := exec.Command(minikubePath, "start", "-p", profile, "--memory", "4000", "--kubernetes-version", kubernetesVersion, "--wait=false", "--vm-driver=docker")
cmd.Stdout = os.Stdout
return cmd.Run()
}

func createImageTarball() error {
cmd := exec.Command(minikubePath, "ssh", "-p", profile, "--", "sudo", "tar", "cvf", tarballFilename, "/var/lib/docker", "/var/lib/minikube/binaries")
cmd := exec.Command(minikubePath, "ssh", "-p", profile, "--", "cd", "/var", "&&", "sudo", "tar", "-I", "lz4", "-cvf", tarballFilename, "./lib/docker", "./lib/minikube/binaries")
cmd.Stdout = os.Stdout
return cmd.Run()
if err := cmd.Run(); err != nil {
return errors.Wrap(err, "creating image tarball")
}
return nil
}

func copyTarballToHost() error {
sshKey, err := runCmd([]string{minikubePath, "ssh-key", "-p", profile})
if err != nil {
return errors.Wrap(err, "getting ssh-key")
}

ip, err := runCmd([]string{minikubePath, "ip", "-p", profile})
if err != nil {
return errors.Wrap(err, "getting ip")
}

dest := filepath.Join("out/", tarballFilename)
args := []string{"scp", "-o", "StrictHostKeyChecking=no", "-i", sshKey, fmt.Sprintf("docker@%s:/home/docker/%s", ip, tarballFilename), dest}
_, err = runCmd(args)
return err
cmd := exec.Command("docker", "cp", fmt.Sprintf("%s:/var/%s", profile, tarballFilename), dest)
medyagh marked this conversation as resolved.
Show resolved Hide resolved
cmd.Stdout = os.Stdout
if err := cmd.Run(); err != nil {
return errors.Wrap(err, "copying tarball to host")
}
return nil
}

func deleteMinikube() error {
cmd := exec.Command(minikubePath, "delete", "-p", profile)
cmd.Stdout = os.Stdout
return cmd.Run()
}

func runCmd(command []string) (string, error) {
cmd := exec.Command(command[0], command[1:]...)
output, err := cmd.Output()
return strings.Trim(string(output), "\n "), err
}
11 changes: 10 additions & 1 deletion pkg/drivers/kic/kic.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"os/exec"
"strconv"
"strings"
"time"

"github.com/docker/machine/libmachine/drivers"
"github.com/docker/machine/libmachine/log"
Expand Down Expand Up @@ -88,7 +89,15 @@ func (d *Driver) Create() error {
ContainerPort: constants.DockerDaemonPort,
},
)
err := oci.CreateContainerNode(params)
t := time.Now()
glog.Infof("Starting creating preloaded images volume")
volumeName, err := oci.CreatePreloadedImagesVolume(d.NodeConfig.KubernetesVersion, BaseImage)
if err != nil {
glog.Infof("Unable to create preloaded images volume: %v", err)
}
glog.Infof("Finished creating preloaded images volume in %f seconds", time.Since(t).Seconds())
params.PreloadedVolume = volumeName
err = oci.CreateContainerNode(params)
if err != nil {
return errors.Wrap(err, "create kic node")
}
Expand Down
12 changes: 8 additions & 4 deletions pkg/drivers/kic/oci/oci.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,11 +99,15 @@ func CreateContainerNode(p CreateParams) error {
runArgs = append(runArgs, "--volume", fmt.Sprintf("%s:/var:exec", hostVarVolPath))
}
if p.OCIBinary == Docker {
if err := createDockerVolume(p.Name); err != nil {
return errors.Wrapf(err, "creating volume for %s container", p.Name)
volumeName := p.PreloadedVolume
if volumeName == "" {
if err := createDockerVolume(p.Name); err != nil {
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
return errors.Wrapf(err, "creating volume for %s container", p.Name)
}
glog.Infof("Successfully created a docker volume %s", p.Name)
volumeName = p.Name
}
glog.Infof("Successfully created a docker volume %s", p.Name)
runArgs = append(runArgs, "--volume", fmt.Sprintf("%s:/var", p.Name))
runArgs = append(runArgs, "--volume", fmt.Sprintf("%s:/var", volumeName))
// setting resource limit in privileged mode is only supported by docker
// podman error: "Error: invalid configuration, cannot set resources with rootless containers not using cgroups v2 unified mode"
runArgs = append(runArgs, fmt.Sprintf("--cpus=%s", p.CPUs), fmt.Sprintf("--memory=%s", p.Memory))
Expand Down
25 changes: 13 additions & 12 deletions pkg/drivers/kic/oci/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,19 @@ const (

// CreateParams are parameters needed to create a container
type CreateParams struct {
Name string // used for container name and hostname
Image string // container image to use to create the node.
ClusterLabel string // label the containers we create using minikube so we can clean up
Role string // currently only role supported is control-plane
Mounts []Mount // volume mounts
APIServerPort int // kubernetes api server port
PortMappings []PortMapping // ports to map to container from host
CPUs string // number of cpu cores assign to container
Memory string // memory (mbs) to assign to the container
Envs map[string]string // environment variables to pass to the container
ExtraArgs []string // a list of any extra option to pass to oci binary during creation time, for example --expose 8080...
OCIBinary string // docker or podman
Name string // used for container name and hostname
Image string // container image to use to create the node.
ClusterLabel string // label the containers we create using minikube so we can clean up
Role string // currently only role supported is control-plane
Mounts []Mount // volume mounts
APIServerPort int // kubernetes api server port
PortMappings []PortMapping // ports to map to container from host
CPUs string // number of cpu cores assign to container
Memory string // memory (mbs) to assign to the container
Envs map[string]string // environment variables to pass to the container
ExtraArgs []string // a list of any extra option to pass to oci binary during creation time, for example --expose 8080...
OCIBinary string // docker or podman
PreloadedVolume string // volume of preloaded images
}

// createOpt is an option for Create
Expand Down
51 changes: 51 additions & 0 deletions pkg/drivers/kic/oci/volumes.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ import (

"github.com/golang/glog"
"github.com/pkg/errors"
"k8s.io/minikube/pkg/drivers/kic/preload"
)

// DeleteAllVolumesByLabel deletes all volumes that have a specific label
Expand Down Expand Up @@ -88,6 +89,56 @@ func allVolumesByLabel(ociBin string, label string) ([]string, error) {
return vols, err
}

// CreatePreloadedImagesVolume creates a volume with preloaded images
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
func CreatePreloadedImagesVolume(k8sVersion, baseImage string) (string, error) {
if err := PointToHostDockerDaemon(); err != nil {
return "", errors.Wrap(err, "point host docker-daemon")
}
volumeName := fmt.Sprintf("k8s-%s", k8sVersion)
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
if dockerVolumeExists(volumeName) {
return volumeName, nil
}
if err := createDockerVolume(volumeName); err != nil {
return "", errors.Wrap(err, "creating docker volume")
}
tarballPath := preload.TarballPath(k8sVersion)

if err := extractTarballToVolume(tarballPath, volumeName, baseImage); err != nil {
return "", errors.Wrap(err, "extracting tarball to volume")
}
return volumeName, nil
}

func dockerVolumeExists(name string) bool {
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
if err := PointToHostDockerDaemon(); err != nil {
return false
}
cmd := exec.Command(Docker, "volume", "ls", "-q")
out, err := cmd.CombinedOutput()
if err != nil {
return false
}
names := strings.Split(string(out), "\n")
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
for _, n := range names {
if n == name {
return true
}
}
return false
}

func extractTarballToVolume(tarballPath, volumeName, imageName string) error {
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
if err := PointToHostDockerDaemon(); err != nil {
return errors.Wrap(err, "point host docker-daemon")
}
cmd := exec.Command(Docker, "run", "--rm", "--entrypoint", "/usr/bin/tar", "-v", fmt.Sprintf("%s:/preloaded.tar:ro", tarballPath), "-v", fmt.Sprintf("%s:/extractDir", volumeName), imageName, "-I", "lz4", "-xvf", "/preloaded.tar", "-C", "/extractDir")
fmt.Println(cmd.Args)
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
if out, err := cmd.CombinedOutput(); err != nil {
return errors.Wrapf(err, "output %s", string(out))
Copy link
Member

@medyagh medyagh Mar 3, 2020

Choose a reason for hiding this comment

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

optional nit:

Wrapf(err, "extract to volume: output %s", string(out))

}
return nil
}

// createDockerVolume creates a docker volume to be attached to the container with correct labels and prefixes based on profile name
// Caution ! if volume already exists does NOT return an error and will not apply the minikube labels on it.
// TODO: this should be fixed as a part of https://github.com/kubernetes/minikube/issues/6530
Expand Down
55 changes: 55 additions & 0 deletions pkg/drivers/kic/preload/preload.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
/*
Copyright 2020 The Kubernetes Authors All rights reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package preload

import (
"fmt"
"os"
"path"

"github.com/golang/glog"
"github.com/jimmidyson/go-download"
"k8s.io/minikube/pkg/minikube/localpath"
)

// TarballPath returns the path to the preloaded tarball
func TarballPath(k8sVersion string) string {
targetDir := localpath.MakeMiniPath("cache", "preloaded-tarball")
targetFilepath := path.Join(targetDir, fmt.Sprintf("preloaded-images-k8s-%s.tar.lz4", k8sVersion))
return targetFilepath
}

// CacheTarball caches the preloaded images tarball on the host machine
func CacheTarball(k8sVersion string) error {
targetFilepath := TarballPath(k8sVersion)
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved

if _, err := os.Stat(targetFilepath); err == nil {
glog.Infof("Found %s in cache, skipping downloading", targetFilepath)
return nil
}

url := fmt.Sprintf("https://storage.googleapis.com/minikube-docker-volume-tarballs/preloaded-images-k8s-%s.tar", k8sVersion)
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
glog.Infof("Downloading %s to %s", url, targetFilepath)
return download.ToFile(url, targetFilepath, download.FileOptions{Mkdirs: download.MkdirAll})
priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
}

// UsingPreloadedVolume returns true if the preloaded tarball exists
func UsingPreloadedVolume(k8sVersion string) bool {
path := TarballPath(k8sVersion)
_, err := os.Stat(path)
return err == nil
}
29 changes: 16 additions & 13 deletions pkg/drivers/kic/types.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,26 @@ const (
// DefaultPodCIDR is The CIDR to be used for pods inside the node.
DefaultPodCIDR = "10.244.0.0/16"

// Version is the current version of kic
Version = "v0.0.5"

// BaseImage is the base image is used to spin up kic containers. it uses same base-image as kind.
BaseImage = "gcr.io/k8s-minikube/kicbase:v0.0.5@sha256:3ddd8461dfb5c3e452ccc44d87750b87a574ec23fc425da67dccc1f0c57d428a"
// OverlayImage is the cni plugin used for overlay image, created by kind.
// CNI plugin image used for kic drivers created by kind.
BaseImage = "gcr.io/k8s-minikube/kicbase:v0.0.5@sha256:3ddd8461dfb5c3e452ccc44d87750b87a574ec23fc425da67dccc1f0c57d428a" // CNI plugin image used for kic drivers created by kind.

priyawadhwa marked this conversation as resolved.
Show resolved Hide resolved
OverlayImage = "kindest/kindnetd:0.5.3"
)

// Config is configuration for the kic driver used by registry
type Config struct {
MachineName string // maps to the container name being created
CPU int // Number of CPU cores assigned to the container
Memory int // max memory in MB
StorePath string // libmachine store path
OCIBinary string // oci tool to use (docker, podman,...)
ImageDigest string // image name with sha to use for the node
Mounts []oci.Mount // mounts
APIServerPort int // kubernetes api server port inside the container
PortMappings []oci.PortMapping // container port mappings
Envs map[string]string // key,value of environment variables passed to the node
MachineName string // maps to the container name being created
CPU int // Number of CPU cores assigned to the container
Memory int // max memory in MB
StorePath string // libmachine store path
OCIBinary string // oci tool to use (docker, podman,...)
ImageDigest string // image name with sha to use for the node
Mounts []oci.Mount // mounts
APIServerPort int // kubernetes api server port inside the container
PortMappings []oci.PortMapping // container port mappings
Envs map[string]string // key,value of environment variables passed to the node
KubernetesVersion string // kubernetes version to install
}
9 changes: 7 additions & 2 deletions pkg/minikube/bootstrapper/kubeadm/kubeadm.go
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ import (
kconst "k8s.io/kubernetes/cmd/kubeadm/app/constants"
"k8s.io/minikube/pkg/drivers/kic"
"k8s.io/minikube/pkg/drivers/kic/oci"
"k8s.io/minikube/pkg/drivers/kic/preload"
"k8s.io/minikube/pkg/kapi"
"k8s.io/minikube/pkg/minikube/bootstrapper"
"k8s.io/minikube/pkg/minikube/bootstrapper/bsutil"
Expand Down Expand Up @@ -436,8 +437,12 @@ func (k *Bootstrapper) UpdateCluster(cfg config.MachineConfig) error {
glog.Warningf("unable to stop kubelet: %s command: %q output: %q", err, rr.Command(), rr.Output())
}

if err := bsutil.TransferBinaries(cfg.KubernetesConfig, k.c); err != nil {
return errors.Wrap(err, "downloading binaries")
// Skip transfer if using preloaded kic volume
skipTransfer := driver.IsKIC(cfg.Driver) && preload.UsingPreloadedVolume(cfg.KubernetesConfig.KubernetesVersion)
if !skipTransfer {
if err := bsutil.TransferBinaries(cfg.KubernetesConfig, k.c); err != nil {
return errors.Wrap(err, "downloading binaries")
}
}

var cniFile []byte
Expand Down
Loading