Skip to content

Commit

Permalink
Add a new builder for tarballs and released artifacts
Browse files Browse the repository at this point in the history
Signed-off-by: Davanum Srinivas <davanum@gmail.com>

Co-authored-by: Antonio Ojea <antonio.ojea.garcia@gmail.com>
  • Loading branch information
dims and aojea committed May 21, 2024
1 parent ead292a commit b197196
Show file tree
Hide file tree
Showing 8 changed files with 434 additions and 21 deletions.
98 changes: 88 additions & 10 deletions pkg/build/nodeimage/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,14 @@ limitations under the License.
package nodeimage

import (
"fmt"
"net/url"
"os"
"runtime"

"sigs.k8s.io/kind/pkg/build/nodeimage/internal/kube"
"sigs.k8s.io/kind/pkg/errors"
"sigs.k8s.io/kind/pkg/internal/version"
"sigs.k8s.io/kind/pkg/log"
)

Expand All @@ -46,26 +50,100 @@ func Build(options ...Option) error {
ctx.logger.Warnf("unsupported architecture %q", ctx.arch)
}

// locate sources if no kubernetes source was specified
if ctx.kubeRoot == "" {
kubeRoot, err := kube.FindSource()
if ctx.buildType == "" {
ctx.buildType = detectBuildType(ctx.kubeParam)
if ctx.buildType != "" {
ctx.logger.V(0).Infof("Detected build type: %q", ctx.buildType)
}
}

if ctx.buildType == "url" {
ctx.logger.V(0).Infof("Building using URL: %q", ctx.kubeParam)
builder, err := kube.NewURLBuilder(ctx.logger, ctx.kubeParam)
if err != nil {
return errors.Wrap(err, "error finding kuberoot")
return err
}
ctx.builder = builder
}

if ctx.buildType == "file" {
ctx.logger.V(0).Infof("Building using local file: %q", ctx.kubeParam)
if info, err := os.Stat(ctx.kubeParam); err == nil && info.Mode().IsRegular() {
builder, err := kube.NewTarballBuilder(ctx.logger, ctx.kubeParam)
if err != nil {
return err
}
ctx.builder = builder
}
ctx.kubeRoot = kubeRoot
}

// initialize bits
builder, err := kube.NewDockerBuilder(ctx.logger, ctx.kubeRoot, ctx.arch)
if err != nil {
return err
if ctx.buildType == "release" {
ctx.logger.V(0).Infof("Building using release %q artifacts", ctx.kubeParam)
kubever, err := version.ParseSemantic(ctx.kubeParam)
if err == nil {
builder, err := kube.NewReleaseBuilder(ctx.logger, "v"+kubever.String(), ctx.arch)
if err != nil {
return err
}
ctx.builder = builder
} else {
if _, err := os.Stat(ctx.kubeParam); err != nil {
ctx.logger.V(0).Infof("%s is not a valid kubernetes version", ctx.kubeParam)
return fmt.Errorf("%s is not a valid kubernetes version", ctx.kubeParam)
}
}
}

if ctx.builder == nil {
// locate sources if no kubernetes source was specified
if ctx.kubeParam == "" {
kubeRoot, err := kube.FindSource()
if err != nil {
return errors.Wrap(err, "error finding kuberoot")
}
ctx.kubeParam = kubeRoot
}
ctx.logger.V(0).Infof("Building using source: %q", ctx.kubeParam)

// initialize bits
builder, err := kube.NewDockerBuilder(ctx.logger, ctx.kubeParam, ctx.arch)
if err != nil {
return err
}
ctx.builder = builder
}
ctx.builder = builder

// do the actual build
return ctx.Build()
}

// detectBuildType detect the type of build required based on the param passed in the following order
// url: if the param is a valid http or https url
// file: if the param refers to an existing regular file
// source: if the param refers to an existing directory
// release: if the param is a semantic version expression (does this require the v preprended?
func detectBuildType(param string) string {
u, err := url.ParseRequestURI(param)
if err == nil {
if u.Scheme == "http" || u.Scheme == "https" {
return "url"
}
}
if info, err := os.Stat(param); err == nil {
if info.Mode().IsRegular() {
return "file"
}
if info.Mode().IsDir() {
return "source"
}
}
_, err = version.ParseSemantic(param)
if err == nil {
return "release"
}
return ""
}

func supportedArch(arch string) bool {
switch arch {
default:
Expand Down
3 changes: 2 additions & 1 deletion pkg/build/nodeimage/buildcontext.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,8 @@ type buildContext struct {
baseImage string
logger log.Logger
arch string
kubeRoot string
buildType string
kubeParam string
// non-option fields
builder kube.Builder
}
Expand Down
154 changes: 154 additions & 0 deletions pkg/build/nodeimage/internal/kube/builder_remote.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
/*
Copyright 2018 The Kubernetes Authors.
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 kube

import (
"context"
"fmt"
"io"
"net"
"net/http"
"os"
"path/filepath"
"strings"
"time"

"sigs.k8s.io/kind/pkg/log"
)

type remoteBuilder struct {
version string
logger log.Logger
url string
}

var _ Builder = &remoteBuilder{}

func NewURLBuilder(logger log.Logger, url string) (Builder, error) {
return &remoteBuilder{
version: "",
logger: logger,
url: url,
}, nil
}

func NewReleaseBuilder(logger log.Logger, version, arch string) (Builder, error) {
url := "https://dl.k8s.io/" + version + "/kubernetes-server-linux-" + arch + ".tar.gz"
return &remoteBuilder{
version: version,
logger: logger,
url: url,
}, nil
}

// Build implements Bits.Build
func (b *remoteBuilder) Build() (Bits, error) {

tmpDir, err := os.MkdirTemp(os.TempDir(), "k8s-tar-extract-")
if err != nil {
return nil, fmt.Errorf("error creating temporary directory for tar extraction: %w", err)
}

tgzFile := filepath.Join(tmpDir, "kubernetes-"+b.version+"-server-linux-amd64.tar.gz")
err = b.downloadURL(b.url, tgzFile)
if err != nil {
return nil, fmt.Errorf("error downloading file: %w", err)
}

err = extractTarball(tgzFile, tmpDir, b.logger)
if err != nil {
return nil, fmt.Errorf("error extracting tgz file: %w", err)
}

binDir := filepath.Join(tmpDir, "kubernetes/server/bin")
contents, err := os.ReadFile(filepath.Join(binDir, "kube-apiserver.docker_tag"))
if err != nil {
return nil, err
}
sourceVersionRaw := strings.TrimSpace(string(contents))
return &bits{
binaryPaths: []string{
filepath.Join(binDir, "kubeadm"),
filepath.Join(binDir, "kubelet"),
filepath.Join(binDir, "kubectl"),
},
imagePaths: []string{
filepath.Join(binDir, "kube-apiserver.tar"),
filepath.Join(binDir, "kube-controller-manager.tar"),
filepath.Join(binDir, "kube-scheduler.tar"),
filepath.Join(binDir, "kube-proxy.tar"),
},
version: sourceVersionRaw,
}, nil
}

func (b *remoteBuilder) downloadURL(url string, destPath string) error {
output, err := os.Create(destPath)
if err != nil {
return fmt.Errorf("error creating file for download %q: %v", destPath, err)
}
defer output.Close()

b.logger.V(0).Infof("Downloading %q", url)

// Create a client with custom timeouts
// to avoid idle downloads to hang the program
httpClient := &http.Client{
Transport: &http.Transport{
Proxy: http.ProxyFromEnvironment,
DialContext: (&net.Dialer{
Timeout: 30 * time.Second,
KeepAlive: 30 * time.Second,
}).DialContext,
TLSHandshakeTimeout: 10 * time.Second,
ResponseHeaderTimeout: 30 * time.Second,
IdleConnTimeout: 30 * time.Second,
},
}

// this will stop slow downloads after 10 minutes
// and interrupt reading of the Response.Body
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Minute)
defer cancel()

req, err := http.NewRequestWithContext(ctx, http.MethodGet, url, nil)
if err != nil {
return fmt.Errorf("cannot create request: %v", err)
}

response, err := httpClient.Do(req)
if err != nil {
return fmt.Errorf("error doing HTTP fetch of %q: %v", url, err)
}
defer response.Body.Close()

if response.StatusCode >= 400 {
return fmt.Errorf("error response from %q: HTTP %v", url, response.StatusCode)
}

start := time.Now()
defer func() {
b.logger.V(2).Infof("Copying %q to %q took %q", url, destPath, time.Since(start))
}()

// TODO: we should add some sort of progress indicator
_, err = io.Copy(output, response.Body)
if err != nil {
return fmt.Errorf("error downloading HTTP content from %q: %v", url, err)
}
return nil
}
79 changes: 79 additions & 0 deletions pkg/build/nodeimage/internal/kube/builder_tarball.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
/*
Copyright 2018 The Kubernetes Authors.
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 kube

import (
"fmt"
"os"
"path/filepath"
"sigs.k8s.io/kind/pkg/log"
"strings"
)

// TODO(bentheelder): plumb through arch

// directoryBuilder implements Bits for a local docker-ized make / bash build
type directoryBuilder struct {
tarballPath string
logger log.Logger
}

var _ Builder = &directoryBuilder{}

// NewTarballBuilder returns a new Bits backed by the docker-ized build,
// given kubeRoot, the path to the kubernetes source directory
func NewTarballBuilder(logger log.Logger, tarballPath string) (Builder, error) {
return &directoryBuilder{
tarballPath: tarballPath,
logger: logger,
}, nil
}

// Build implements Bits.Build
func (b *directoryBuilder) Build() (Bits, error) {
tmpDir, err := os.MkdirTemp(os.TempDir(), "k8s-tar-extract-")
if err != nil {
return nil, fmt.Errorf("error creating temporary directory for tar extraction: %w", err)
}

b.logger.V(0).Infof("Extracting %q", b.tarballPath)
err = extractTarball(b.tarballPath, tmpDir, b.logger)
if err != nil {
return nil, fmt.Errorf("error extracting tar file: %w", err)
}

binDir := filepath.Join(tmpDir, "kubernetes/server/bin")
contents, err := os.ReadFile(filepath.Join(binDir, "kube-apiserver.docker_tag"))
if err != nil {
return nil, err
}
sourceVersionRaw := strings.TrimSpace(string(contents))
return &bits{
binaryPaths: []string{
filepath.Join(binDir, "kubeadm"),
filepath.Join(binDir, "kubelet"),
filepath.Join(binDir, "kubectl"),
},
imagePaths: []string{
filepath.Join(binDir, "kube-apiserver.tar"),
filepath.Join(binDir, "kube-controller-manager.tar"),
filepath.Join(binDir, "kube-scheduler.tar"),
filepath.Join(binDir, "kube-proxy.tar"),
},
version: sourceVersionRaw,
}, nil
}
Loading

0 comments on commit b197196

Please sign in to comment.