mirror of https://github.com/k3s-io/k3s
Derek Nola
1 year ago
3 changed files with 408 additions and 112 deletions
@ -0,0 +1,77 @@ |
|||||||
|
ENV['VAGRANT_NO_PARALLEL'] = 'no' |
||||||
|
NODE_ROLES = (ENV['E2E_NODE_ROLES'] || |
||||||
|
["server-0", "server-1", "server-2"]) |
||||||
|
NODE_BOXES = (ENV['E2E_NODE_BOXES'] || |
||||||
|
['generic/ubuntu2004', 'generic/ubuntu2004', 'generic/ubuntu2004']) |
||||||
|
GITHUB_BRANCH = (ENV['E2E_GITHUB_BRANCH'] || "master") |
||||||
|
RELEASE_VERSION = (ENV['E2E_RELEASE_VERSION'] || "") |
||||||
|
GOCOVER = (ENV['E2E_GOCOVER'] || "") |
||||||
|
NODE_CPUS = (ENV['E2E_NODE_CPUS'] || 2).to_i |
||||||
|
NODE_MEMORY = (ENV['E2E_NODE_MEMORY'] || 2048).to_i |
||||||
|
# Virtualbox >= 6.1.28 require `/etc/vbox/network.conf` for expanded private networks |
||||||
|
NETWORK_PREFIX = "10.10.10" |
||||||
|
install_type = "" |
||||||
|
|
||||||
|
def provision(vm, role, role_num, node_num) |
||||||
|
vm.box = NODE_BOXES[node_num] |
||||||
|
vm.hostname = role |
||||||
|
# An expanded netmask is required to allow VM<-->VM communication, virtualbox defaults to /32 |
||||||
|
vm.network "private_network", ip: "#{NETWORK_PREFIX}.#{100+node_num}", netmask: "255.255.255.0" |
||||||
|
|
||||||
|
vagrant_defaults = '../vagrantdefaults.rb' |
||||||
|
load vagrant_defaults if File.exists?(vagrant_defaults) |
||||||
|
|
||||||
|
defaultOSConfigure(vm) |
||||||
|
addCoverageDir(vm, role, GOCOVER) |
||||||
|
install_type = getInstallType(vm, RELEASE_VERSION, GITHUB_BRANCH) |
||||||
|
|
||||||
|
vm.provision "shell", inline: "ping -c 2 k3s.io" |
||||||
|
|
||||||
|
|
||||||
|
if role.include?("server") && role_num == 0 |
||||||
|
vm.provision 'k3s-install', type: 'k3s', run: 'once' do |k3s| |
||||||
|
k3s.args = %W[server --cluster-init --node-external-ip=#{NETWORK_PREFIX}.100 --flannel-iface=eth1 --secrets-encryption] |
||||||
|
k3s.env = %W[K3S_KUBECONFIG_MODE=0644 K3S_TOKEN=vagrant #{install_type}] |
||||||
|
k3s.config_mode = '0644' # side-step https://github.com/k3s-io/k3s/issues/4321 |
||||||
|
end |
||||||
|
elsif role.include?("server") && role_num != 0 |
||||||
|
vm.provision 'k3s-install', type: 'k3s', run: 'once' do |k3s| |
||||||
|
k3s.args = %W[server --server https://#{NETWORK_PREFIX}.100:6443 --flannel-iface=eth1 --secrets-encryption] |
||||||
|
k3s.env = %W[K3S_KUBECONFIG_MODE=0644 K3S_TOKEN=vagrant #{install_type}] |
||||||
|
k3s.config_mode = '0644' # side-step https://github.com/k3s-io/k3s/issues/4321 |
||||||
|
end |
||||||
|
end |
||||||
|
if vm.box.to_s.include?("microos") |
||||||
|
vm.provision 'k3s-reload', type: 'reload', run: 'once' |
||||||
|
end |
||||||
|
end |
||||||
|
|
||||||
|
Vagrant.configure("2") do |config| |
||||||
|
config.vagrant.plugins = ["vagrant-k3s", "vagrant-reload"] |
||||||
|
# Default provider is libvirt, virtualbox is only provided as a backup |
||||||
|
config.vm.provider "libvirt" do |v| |
||||||
|
v.cpus = NODE_CPUS |
||||||
|
v.memory = NODE_MEMORY |
||||||
|
end |
||||||
|
config.vm.provider "virtualbox" do |v| |
||||||
|
v.cpus = NODE_CPUS |
||||||
|
v.memory = NODE_MEMORY |
||||||
|
end |
||||||
|
|
||||||
|
if NODE_ROLES.kind_of?(String) |
||||||
|
NODE_ROLES = NODE_ROLES.split(" ", -1) |
||||||
|
end |
||||||
|
if NODE_BOXES.kind_of?(String) |
||||||
|
NODE_BOXES = NODE_BOXES.split(" ", -1) |
||||||
|
end |
||||||
|
|
||||||
|
# Must iterate on the index, vagrant does not understand iterating |
||||||
|
# over the node roles themselves |
||||||
|
NODE_ROLES.length.times do |i| |
||||||
|
name = NODE_ROLES[i] |
||||||
|
role_num = name.split("-", -1).pop.to_i |
||||||
|
config.vm.define name do |node| |
||||||
|
provision(node.vm, name, role_num, i) |
||||||
|
end |
||||||
|
end |
||||||
|
end |
||||||
@ -0,0 +1,316 @@ |
|||||||
|
package secretsencryption |
||||||
|
|
||||||
|
import ( |
||||||
|
"flag" |
||||||
|
"fmt" |
||||||
|
"os" |
||||||
|
"strings" |
||||||
|
"testing" |
||||||
|
|
||||||
|
"github.com/k3s-io/k3s/tests/e2e" |
||||||
|
. "github.com/onsi/ginkgo/v2" |
||||||
|
. "github.com/onsi/gomega" |
||||||
|
) |
||||||
|
|
||||||
|
// Valid nodeOS: generic/ubuntu2004, opensuse/Leap-15.3.x86_64
|
||||||
|
var nodeOS = flag.String("nodeOS", "generic/ubuntu2004", "VM operating system") |
||||||
|
var serverCount = flag.Int("serverCount", 3, "number of server nodes") |
||||||
|
var hardened = flag.Bool("hardened", false, "true or false") |
||||||
|
var ci = flag.Bool("ci", false, "running on CI") |
||||||
|
var local = flag.Bool("local", false, "deploy a locally built K3s binary") |
||||||
|
|
||||||
|
// Environment Variables Info:
|
||||||
|
// E2E_RELEASE_VERSION=v1.23.1+k3s2 or nil for latest commit from master
|
||||||
|
|
||||||
|
func Test_E2ESecretsEncryption(t *testing.T) { |
||||||
|
RegisterFailHandler(Fail) |
||||||
|
flag.Parse() |
||||||
|
suiteConfig, reporterConfig := GinkgoConfiguration() |
||||||
|
RunSpecs(t, "Secrets Encryption Test Suite", suiteConfig, reporterConfig) |
||||||
|
} |
||||||
|
|
||||||
|
var ( |
||||||
|
kubeConfigFile string |
||||||
|
serverNodeNames []string |
||||||
|
) |
||||||
|
|
||||||
|
var _ = ReportAfterEach(e2e.GenReport) |
||||||
|
|
||||||
|
var _ = Describe("Verify Secrets Encryption Rotation", Ordered, func() { |
||||||
|
Context("Secrets Keys are rotated:", func() { |
||||||
|
It("Starts up with no issues", func() { |
||||||
|
var err error |
||||||
|
if *local { |
||||||
|
serverNodeNames, _, err = e2e.CreateLocalCluster(*nodeOS, *serverCount, 0) |
||||||
|
} else { |
||||||
|
serverNodeNames, _, err = e2e.CreateCluster(*nodeOS, *serverCount, 0) |
||||||
|
} |
||||||
|
Expect(err).NotTo(HaveOccurred(), e2e.GetVagrantLog(err)) |
||||||
|
fmt.Println("CLUSTER CONFIG") |
||||||
|
fmt.Println("OS:", *nodeOS) |
||||||
|
fmt.Println("Server Nodes:", serverNodeNames) |
||||||
|
kubeConfigFile, err = e2e.GenKubeConfigFile(serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred()) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Checks node and pod status", func() { |
||||||
|
fmt.Printf("\nFetching node status\n") |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
nodes, err := e2e.ParseNodes(kubeConfigFile, false) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
for _, node := range nodes { |
||||||
|
g.Expect(node.Status).Should(Equal("Ready")) |
||||||
|
} |
||||||
|
}, "620s", "5s").Should(Succeed()) |
||||||
|
_, _ = e2e.ParseNodes(kubeConfigFile, true) |
||||||
|
|
||||||
|
fmt.Printf("\nFetching pods status\n") |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
pods, err := e2e.ParsePods(kubeConfigFile, false) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
for _, pod := range pods { |
||||||
|
if strings.Contains(pod.Name, "helm-install") { |
||||||
|
g.Expect(pod.Status).Should(Equal("Completed"), pod.Name) |
||||||
|
} else { |
||||||
|
g.Expect(pod.Status).Should(Equal("Running"), pod.Name) |
||||||
|
} |
||||||
|
} |
||||||
|
}, "620s", "5s").Should(Succeed()) |
||||||
|
_, _ = e2e.ParsePods(kubeConfigFile, true) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Deploys several secrets", func() { |
||||||
|
_, err := e2e.DeployWorkload("secrets.yaml", kubeConfigFile, *hardened) |
||||||
|
Expect(err).NotTo(HaveOccurred(), "Secrets not deployed") |
||||||
|
}) |
||||||
|
|
||||||
|
It("Verifies encryption start stage", func() { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
for _, nodeName := range serverNodeNames { |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
Expect(err).NotTo(HaveOccurred()) |
||||||
|
Expect(res).Should(ContainSubstring("Encryption Status: Enabled")) |
||||||
|
Expect(res).Should(ContainSubstring("Current Rotation Stage: start")) |
||||||
|
Expect(res).Should(ContainSubstring("Server Encryption Hashes: All hashes match")) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Prepares for Secrets-Encryption Rotation", func() { |
||||||
|
cmd := "k3s secrets-encrypt prepare" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
for i, nodeName := range serverNodeNames { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
Expect(res).Should(ContainSubstring("Server Encryption Hashes: hash does not match")) |
||||||
|
if i == 0 { |
||||||
|
Expect(res).Should(ContainSubstring("Current Rotation Stage: prepare")) |
||||||
|
} else { |
||||||
|
Expect(res).Should(ContainSubstring("Current Rotation Stage: start")) |
||||||
|
} |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Restarts K3s servers", func() { |
||||||
|
Expect(e2e.RestartCluster(serverNodeNames)).To(Succeed(), e2e.GetVagrantLog(nil)) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Checks node and pod status", func() { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
nodes, err := e2e.ParseNodes(kubeConfigFile, false) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
for _, node := range nodes { |
||||||
|
g.Expect(node.Status).Should(Equal("Ready")) |
||||||
|
} |
||||||
|
}, "420s", "5s").Should(Succeed()) |
||||||
|
|
||||||
|
Eventually(func(g Gomega) { |
||||||
|
pods, err := e2e.ParsePods(kubeConfigFile, false) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
for _, pod := range pods { |
||||||
|
if strings.Contains(pod.Name, "helm-install") { |
||||||
|
g.Expect(pod.Status).Should(Equal("Completed"), pod.Name) |
||||||
|
} else { |
||||||
|
g.Expect(pod.Status).Should(Equal("Running"), pod.Name) |
||||||
|
} |
||||||
|
} |
||||||
|
}, "420s", "5s").Should(Succeed()) |
||||||
|
_, _ = e2e.ParseNodes(kubeConfigFile, true) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Verifies encryption prepare stage", func() { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
for _, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
g.Expect(res).Should(ContainSubstring("Encryption Status: Enabled")) |
||||||
|
g.Expect(res).Should(ContainSubstring("Current Rotation Stage: prepare")) |
||||||
|
g.Expect(res).Should(ContainSubstring("Server Encryption Hashes: All hashes match")) |
||||||
|
}, "420s", "2s").Should(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Rotates the Secrets-Encryption Keys", func() { |
||||||
|
cmd := "k3s secrets-encrypt rotate" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
for i, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
g.Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
g.Expect(res).Should(ContainSubstring("Server Encryption Hashes: hash does not match")) |
||||||
|
if i == 0 { |
||||||
|
g.Expect(res).Should(ContainSubstring("Current Rotation Stage: rotate")) |
||||||
|
} else { |
||||||
|
g.Expect(res).Should(ContainSubstring("Current Rotation Stage: prepare")) |
||||||
|
} |
||||||
|
}, "420s", "2s").Should(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Restarts K3s servers", func() { |
||||||
|
Expect(e2e.RestartCluster(serverNodeNames)).To(Succeed(), e2e.GetVagrantLog(nil)) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Verifies encryption rotate stage", func() { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
for _, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
g.Expect(res).Should(ContainSubstring("Encryption Status: Enabled")) |
||||||
|
g.Expect(res).Should(ContainSubstring("Current Rotation Stage: rotate")) |
||||||
|
g.Expect(res).Should(ContainSubstring("Server Encryption Hashes: All hashes match")) |
||||||
|
}, "420s", "2s").Should(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Reencrypts the Secrets-Encryption Keys", func() { |
||||||
|
cmd := "k3s secrets-encrypt reencrypt" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
|
||||||
|
cmd = "k3s secrets-encrypt status" |
||||||
|
Eventually(func() (string, error) { |
||||||
|
return e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
}, "240s", "10s").Should(ContainSubstring("Current Rotation Stage: reencrypt_finished")) |
||||||
|
|
||||||
|
for _, nodeName := range serverNodeNames[1:] { |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
Expect(res).Should(ContainSubstring("Server Encryption Hashes: hash does not match")) |
||||||
|
Expect(res).Should(ContainSubstring("Current Rotation Stage: rotate")) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Restarts K3s Servers", func() { |
||||||
|
Expect(e2e.RestartCluster(serverNodeNames)).To(Succeed(), e2e.GetVagrantLog(nil)) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Verifies Encryption Reencrypt Stage", func() { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
for _, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
g.Expect(err).NotTo(HaveOccurred()) |
||||||
|
g.Expect(res).Should(ContainSubstring("Encryption Status: Enabled")) |
||||||
|
g.Expect(res).Should(ContainSubstring("Current Rotation Stage: reencrypt_finished")) |
||||||
|
g.Expect(res).Should(ContainSubstring("Server Encryption Hashes: All hashes match")) |
||||||
|
}, "420s", "5s").Should(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
|
}) |
||||||
|
|
||||||
|
Context("Disabling Secrets-Encryption", func() { |
||||||
|
It("Disables encryption", func() { |
||||||
|
cmd := "k3s secrets-encrypt disable" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
|
||||||
|
cmd = "k3s secrets-encrypt reencrypt -f --skip" |
||||||
|
res, err = e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
|
||||||
|
cmd = "k3s secrets-encrypt status" |
||||||
|
Eventually(func() (string, error) { |
||||||
|
return e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
}, "240s", "10s").Should(ContainSubstring("Current Rotation Stage: reencrypt_finished")) |
||||||
|
|
||||||
|
for i, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, nodeName) |
||||||
|
g.Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
if i == 0 { |
||||||
|
g.Expect(res).Should(ContainSubstring("Encryption Status: Disabled")) |
||||||
|
} else { |
||||||
|
g.Expect(res).Should(ContainSubstring("Encryption Status: Enabled")) |
||||||
|
} |
||||||
|
}, "420s", "2s").Should(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
It("Restarts K3s servers", func() { |
||||||
|
Expect(e2e.RestartCluster(serverNodeNames)).To(Succeed()) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Verifies encryption disabled on all nodes", func() { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
for _, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
g.Expect(e2e.RunCmdOnNode(cmd, nodeName)).Should(ContainSubstring("Encryption Status: Disabled")) |
||||||
|
}, "420s", "2s").Should(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
|
|
||||||
|
}) |
||||||
|
|
||||||
|
Context("Enabling Secrets-Encryption", func() { |
||||||
|
It("Enables encryption", func() { |
||||||
|
cmd := "k3s secrets-encrypt enable" |
||||||
|
res, err := e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
|
||||||
|
cmd = "k3s secrets-encrypt reencrypt -f --skip" |
||||||
|
res, err = e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
Expect(err).NotTo(HaveOccurred(), res) |
||||||
|
|
||||||
|
cmd = "k3s secrets-encrypt status" |
||||||
|
Eventually(func() (string, error) { |
||||||
|
return e2e.RunCmdOnNode(cmd, serverNodeNames[0]) |
||||||
|
}, "180s", "5s").Should(ContainSubstring("Current Rotation Stage: reencrypt_finished")) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Restarts K3s servers", func() { |
||||||
|
Expect(e2e.RestartCluster(serverNodeNames)).To(Succeed()) |
||||||
|
}) |
||||||
|
|
||||||
|
It("Verifies encryption enabled on all nodes", func() { |
||||||
|
cmd := "k3s secrets-encrypt status" |
||||||
|
for _, nodeName := range serverNodeNames { |
||||||
|
Eventually(func(g Gomega) { |
||||||
|
g.Expect(e2e.RunCmdOnNode(cmd, nodeName)).Should(ContainSubstring("Encryption Status: Enabled")) |
||||||
|
}, "420s", "2s").Should(Succeed()) |
||||||
|
} |
||||||
|
|
||||||
|
}) |
||||||
|
}) |
||||||
|
|
||||||
|
}) |
||||||
|
|
||||||
|
var failed bool |
||||||
|
var _ = AfterEach(func() { |
||||||
|
failed = failed || CurrentSpecReport().Failed() |
||||||
|
}) |
||||||
|
|
||||||
|
var _ = AfterSuite(func() { |
||||||
|
if failed && !*ci { |
||||||
|
fmt.Println("FAILED!") |
||||||
|
} else { |
||||||
|
Expect(e2e.GetCoverageReport(serverNodeNames)).To(Succeed()) |
||||||
|
Expect(e2e.DestroyCluster()).To(Succeed()) |
||||||
|
Expect(os.Remove(kubeConfigFile)).To(Succeed()) |
||||||
|
} |
||||||
|
}) |
||||||
Loading…
Reference in new issue