-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
✨ Add Kubetest2 provider #3855
Closed
Closed
✨ Add Kubetest2 provider #3855
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
# See the OWNERS docs at https://go.k8s.io/owners for information on OWNERS files. | ||
# See the OWNERS_ALIASES file at https://github.com/kubernetes-sigs/cluster-api/blob/master/OWNERS_ALIASES for a list of members for each alias. | ||
|
||
approvers: | ||
- cluster-api-admins | ||
- cluster-api-maintainers | ||
- benmoss | ||
- elmiko | ||
- randomvariable | ||
|
||
reviewers: | ||
- cluster-api-maintainers | ||
- cluster-api-reviewers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Kubetest2 Cluster API Deployer | ||
|
||
This component of [kubetest2](https://github.com/kubernetes-sigs/kubetest2) is | ||
responsible for test cluster lifecycles for clusters deployed with Cluster API. | ||
|
||
Users can use this project along with kubetest2 testers to run [Kubernetes | ||
e2e tests](https://github.com/kubernetes/kubernetes/tree/master/test/e2e) | ||
against CAPI-backed clusters. | ||
|
||
## Installation | ||
``` | ||
GO111MODULE=on go get sigs.k8s.io/cluster-api/test/kubetest2-capi@latest | ||
``` | ||
|
||
## Usage | ||
|
||
As an example, to deploy with CAPD: | ||
|
||
``` | ||
export KIND_EXPERIMENTAL_DOCKER_NETWORK=bridge | ||
kubetest2 capi --provider docker --kubernetes-version 1.19.1 --up --down | ||
``` | ||
|
||
Currently this provider does not fully support the kubetest2 `--build` feature. | ||
It is possible to build and deploy only with the [CAPD | ||
provider](../infrastructure/docker), since CAPD takes advantage of the node | ||
images that Kind builds. As an example of how this can be done: | ||
|
||
```bash | ||
kubeRoot=$HOME/workspace/kubernetes | ||
|
||
pushd $kubeRoot | ||
export KUBE_GIT_VERSION=$(hack/print-workspace-status.sh | grep gitVersion | cut -d' ' -f2 | cut -d'+' -f1) | ||
export KUBERNETES_VERSION=$KUBE_GIT_VERSION | ||
popd | ||
export KIND_EXPERIMENTAL_DOCKER_NETWORK=bridge | ||
cat <<EOF | kubetest2 capi \ | ||
--provider docker \ | ||
--flavor development \ | ||
--up \ | ||
--kube-root $kubeRoot \ | ||
--build \ | ||
--image-name "kindest/node:$KUBE_GIT_VERSION" \ | ||
--config=- | ||
kind: Cluster | ||
apiVersion: kind.x-k8s.io/v1alpha4 | ||
nodes: | ||
- role: control-plane | ||
extraMounts: | ||
- hostPath: /var/run/docker.sock | ||
containerPath: /var/run/docker.sock | ||
EOF | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,240 @@ | ||
/* | ||
Copyright 2020 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 deployer implements the kubetest2 capi deployer | ||
package deployer | ||
|
||
import ( | ||
"context" | ||
"io/ioutil" | ||
"os" | ||
"os/exec" | ||
"path" | ||
"strings" | ||
"time" | ||
|
||
"github.com/spf13/pflag" | ||
kinddeployer "sigs.k8s.io/kubetest2/kubetest2-kind/deployer" | ||
"sigs.k8s.io/kubetest2/pkg/process" | ||
"sigs.k8s.io/kubetest2/pkg/types" | ||
) | ||
|
||
// Name is the name of the deployer | ||
const Name = "capi" | ||
|
||
// New implements deployer.New for capi | ||
func New(opts types.Options) (types.Deployer, *pflag.FlagSet) { | ||
kind, flags := kinddeployer.New(opts) | ||
d := &deployer{ | ||
kind: kind, | ||
commonOptions: opts, | ||
} | ||
bindFlags(d, flags) | ||
return d, flags | ||
} | ||
|
||
// assert that New implements types.NewDeployer | ||
var _ types.NewDeployer = New | ||
|
||
type deployer struct { | ||
// generic parts | ||
commonOptions types.Options | ||
kind types.Deployer | ||
// capi specific details | ||
provider string | ||
initProviders []string | ||
kubernetesVersion string | ||
controlPlaneCount string | ||
workerCount string | ||
flavor string | ||
useExistingCluster bool | ||
cniManifest string | ||
kubecfgPath string | ||
upTimeout string | ||
workloadClusterName string | ||
} | ||
|
||
func (d *deployer) Kubeconfig() (string, error) { | ||
if d.kubecfgPath != "" { | ||
return d.kubecfgPath, nil | ||
} | ||
|
||
tmpdir, err := ioutil.TempDir("", "kubetest2-capi") | ||
if err != nil { | ||
return "", err | ||
} | ||
d.kubecfgPath = path.Join(tmpdir, "kubeconfig.yaml") | ||
args := []string{ | ||
"get", "kubeconfig", d.workloadClusterName, | ||
} | ||
clusterctl := exec.Command("clusterctl", args...) | ||
lines, err := clusterctl.Output() | ||
if err != nil { | ||
return "", err | ||
} | ||
if err := ioutil.WriteFile(d.kubecfgPath, lines, 0600); err != nil { | ||
return "", err | ||
} | ||
|
||
return d.kubecfgPath, nil | ||
} | ||
|
||
// helper used to create & bind a flagset to the deployer | ||
func bindFlags(d *deployer, flags *pflag.FlagSet) { | ||
flags.StringVar( | ||
&d.provider, "provider", "", "--provider flag for clusterctl", | ||
) | ||
flags.StringArrayVar( | ||
&d.initProviders, "init-providers", []string{}, "additional --provider arguments for init. will be initialized in addition to the provider set with --provider", | ||
) | ||
flags.StringVar( | ||
&d.kubernetesVersion, "kubernetes-version", "", "--kubernetes-version flag for clusterctl", | ||
) | ||
flags.StringVar( | ||
&d.controlPlaneCount, "control-plane-machine-count", "1", "--control-plane-machine-count flag for clusterctl", | ||
) | ||
flags.StringVar( | ||
&d.workerCount, "worker-machine-count", "1", "--worker-machine-count flag for clusterctl", | ||
) | ||
flags.StringVar( | ||
&d.flavor, "flavor", "", "--flavor flag for clusterctl", | ||
) | ||
flags.BoolVar( | ||
&d.useExistingCluster, "use-existing-cluster", false, "use the existing, currently targeted cluster as the management cluster", | ||
) | ||
flags.StringVar( | ||
&d.upTimeout, "up-timeout", "30m", "maximum time allotted for the --up command to complete", | ||
) | ||
flags.StringVar( | ||
&d.cniManifest, "cni-manifest", "", "automatically install this CNI manifest when the cluster becomes available", | ||
) | ||
flags.StringVar( | ||
&d.workloadClusterName, "workload-cluster-name", "capi-workload-cluster", "the workload cluster name", | ||
) | ||
} | ||
|
||
// assert that deployer implements types.DeployerWithKubeconfig | ||
var _ types.DeployerWithKubeconfig = &deployer{} | ||
|
||
// Deployer implementation methods below | ||
|
||
func (d *deployer) Up() error { | ||
upTimeout, err := time.ParseDuration(d.upTimeout) | ||
if err != nil { | ||
return err | ||
} | ||
ctx, cancel := context.WithTimeout(context.Background(), upTimeout) | ||
defer cancel() | ||
|
||
if !d.useExistingCluster { | ||
if err := d.kind.Up(); err != nil { | ||
return err | ||
} | ||
} | ||
|
||
println("Up: installing Cluster API\n") | ||
initProviders := append(d.initProviders, d.provider) | ||
args := []string{"init", "--infrastructure", strings.Join(initProviders, ",")} | ||
if err := process.ExecJUnitContext(ctx, "clusterctl", args, os.Environ()); err != nil { | ||
return err | ||
} | ||
|
||
println("Up: waiting for CAPI to start\n") | ||
args = []string{"wait", "--for=condition=Available", "--all", "--all-namespaces", "deployment", "--timeout=-1m"} | ||
if err := process.ExecJUnitContext(ctx, "kubectl", args, os.Environ()); err != nil { | ||
return err | ||
} | ||
|
||
args = []string{ | ||
"config", | ||
"cluster", d.workloadClusterName, | ||
"--infrastructure", d.provider, | ||
"--kubernetes-version", d.kubernetesVersion, | ||
"--worker-machine-count", d.workerCount, | ||
"--control-plane-machine-count", d.controlPlaneCount, | ||
"--flavor", d.flavor, | ||
} | ||
|
||
clusterctl := exec.CommandContext(ctx, "clusterctl", args...) | ||
clusterctl.Stderr = os.Stderr | ||
stdout, err := clusterctl.StdoutPipe() | ||
if err != nil { | ||
return err | ||
} | ||
|
||
kubectl := exec.CommandContext(ctx, "kubectl", "apply", "-f", "-") | ||
kubectl.Stdin = stdout | ||
kubectl.Stdout = os.Stdout | ||
kubectl.Stderr = os.Stderr | ||
|
||
if err := clusterctl.Start(); err != nil { | ||
return err | ||
} | ||
if err := kubectl.Start(); err != nil { | ||
return err | ||
} | ||
if err := clusterctl.Wait(); err != nil { | ||
return err | ||
} | ||
if err := kubectl.Wait(); err != nil { | ||
return err | ||
} | ||
|
||
println("Up: waiting for cluster to become ready\n") | ||
args = []string{"wait", "--for=condition=Ready", "cluster/" + d.workloadClusterName, "--timeout=-1m"} | ||
if err := process.ExecJUnitContext(ctx, "kubectl", args, os.Environ()); err != nil { | ||
return err | ||
} | ||
if d.cniManifest != "" { | ||
println("Up: installing CNI\n") | ||
kubeconfig, err := d.Kubeconfig() | ||
if err != nil { | ||
return err | ||
} | ||
args = []string{"--kubeconfig", kubeconfig, "apply", "-f", d.cniManifest} | ||
if err := process.ExecJUnitContext(ctx, "kubectl", args, os.Environ()); err != nil { | ||
return err | ||
} | ||
args = []string{"--kubeconfig", kubeconfig, "wait", "--for=condition=Available", "--all", "--all-namespaces", "deployment", "--timeout=-1m"} | ||
if err := process.ExecJUnitContext(ctx, "kubectl", args, os.Environ()); err != nil { | ||
return err | ||
} | ||
} | ||
|
||
return nil | ||
} | ||
|
||
func (d *deployer) Down() error { | ||
println("Down: deleting workload cluster...\n") | ||
args := []string{"delete", "--ignore-not-found", "--wait", "cluster", d.workloadClusterName} | ||
if err := process.ExecJUnit("kubectl", args, os.Environ()); err != nil { | ||
return err | ||
} | ||
|
||
return d.kind.Down() | ||
} | ||
|
||
func (d *deployer) IsUp() (bool, error) { | ||
panic("Not implemented") | ||
} | ||
|
||
func (d *deployer) DumpClusterLogs() error { | ||
panic("Not implemented") | ||
} | ||
|
||
func (d *deployer) Build() error { | ||
return d.kind.Build() | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
module sigs.k8s.io/cluster-api/test/kubetest2-capi | ||
|
||
go 1.15 | ||
|
||
require ( | ||
github.com/google/uuid v1.1.2 // indirect | ||
github.com/spf13/cobra v1.1.1 // indirect | ||
github.com/spf13/pflag v1.0.5 | ||
sigs.k8s.io/kubetest2 v0.0.0-20201023214501-6beb03da0855 | ||
) |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i think it would be nice to add a paragraph here about building locally using
go build
in the kubetest2-capi directory. i know it won't make a big difference once this is deployed, but for developers i think it's nice to give a little extra direction on how to get started with just the code.