Skip to content

Commit

Permalink
Improve YAML processing in clusterctl (#716)
Browse files Browse the repository at this point in the history 
* util: Extend YAML processing to handle more varieties of configuration

Allow clusterctl to handle a variety of groups of objects under
`--cluster` and `--machine`. Search for the correct objects instead
of assuming a single document.

This opens up being able to use a single configuration file, kustomize
and combining cluster, machine and other objects together.

Signed-off-by: Naadir Jeewa <[email protected]>

* Update pkg/util/util.go

Co-Authored-By: randomvariable <[email protected]>

* util: Fixups

Signed-off-by: Naadir Jeewa <[email protected]>

* util: Additional fixups

Signed-off-by: Naadir Jeewa <[email protected]>

* util: linter fixes

Signed-off-by: Naadir Jeewa <[email protected]>

* util: Reference issue in TODO

Signed-off-by: Naadir Jeewa <[email protected]>
  • Loading branch information
@randomvariable @k8s-ci-robot
randomvariable authored and k8s-ci-robot committed Jan 28, 2019
1 parent 86f4e2c commit 9d16c16
Show file tree
Hide file tree
Showing 4 changed files with 291 additions and 21 deletions.
4 changes: 3 additions & 1 deletion Gopkg.lock
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion pkg/util/BUILD.bazel
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ go_library(
"//pkg/apis/cluster/v1alpha1:go_default_library",
"//vendor/k8s.io/api/core/v1:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/api/errors:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/apis/meta/v1/unstructured:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/json:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/wait:go_default_library",
"//vendor/k8s.io/apimachinery/pkg/util/yaml:go_default_library",
"//vendor/k8s.io/klog:go_default_library",
"//vendor/sigs.k8s.io/controller-runtime/pkg/client:go_default_library",
"//vendor/sigs.k8s.io/yaml:go_default_library",
],
)

Expand Down
139 changes: 125 additions & 14 deletions pkg/util/util.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ package util
import (
"context"
"fmt"
"io/ioutil"
"io"
"math/rand"
"os"
"os/exec"
Expand All @@ -28,25 +28,30 @@ import (
"time"

v1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/json"
"k8s.io/apimachinery/pkg/util/yaml"
"k8s.io/klog"
clusterv1 "sigs.k8s.io/cluster-api/pkg/apis/cluster/v1alpha1"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/yaml"
)

const (
// CharSet defines the alphanumeric set for random string generation
CharSet = "0123456789abcdefghijklmnopqrstuvwxyz"
)

var (
r = rand.New(rand.NewSource(time.Now().UnixNano()))
)

// RandomToken returns a random token
func RandomToken() string {
return fmt.Sprintf("%s.%s", RandomString(6), RandomString(16))
}

// RandomString returns a random alphanumeric string
func RandomString(n int) string {
result := make([]byte, n)
for i := range result {
Expand All @@ -55,6 +60,7 @@ func RandomString(n int) string {
return string(result)
}

// GetControlPlaneMachine returns the control plane machine from a slice
func GetControlPlaneMachine(machines []*clusterv1.Machine) *clusterv1.Machine {
for _, machine := range machines {
if IsControlPlaneMachine(machine) {
Expand All @@ -64,6 +70,7 @@ func GetControlPlaneMachine(machines []*clusterv1.Machine) *clusterv1.Machine {
return nil
}

// MachineP converts a slice of machines into a slice of machine pointers
func MachineP(machines []clusterv1.Machine) []*clusterv1.Machine {
// Convert to list of pointers
ret := make([]*clusterv1.Machine, 0, len(machines))
Expand All @@ -73,6 +80,7 @@ func MachineP(machines []clusterv1.Machine) []*clusterv1.Machine {
return ret
}

// Home returns the user home directory
func Home() string {
home := os.Getenv("HOME")
if strings.Contains(home, "root") {
Expand All @@ -87,6 +95,7 @@ func Home() string {
return usr.HomeDir
}

// GetDefaultKubeConfigPath returns the standard user kubeconfig
func GetDefaultKubeConfigPath() string {
localDir := fmt.Sprintf("%s/.kube", Home())
if _, err := os.Stat(localDir); os.IsNotExist(err) {
Expand All @@ -97,6 +106,7 @@ func GetDefaultKubeConfigPath() string {
return fmt.Sprintf("%s/config", localDir)
}

// GetMachineIfExists gets a machine from the API server if it exists
func GetMachineIfExists(c client.Client, namespace, name string) (*clusterv1.Machine, error) {
if c == nil {
// Being called before k8s is setup as part of control plane VM creation
Expand All @@ -107,7 +117,7 @@ func GetMachineIfExists(c client.Client, namespace, name string) (*clusterv1.Mac
machine := &clusterv1.Machine{}
err := c.Get(context.Background(), client.ObjectKey{Namespace: namespace, Name: name}, machine)
if err != nil {
if errors.IsNotFound(err) {
if apierrors.IsNotFound(err) {
return nil, nil
}
return nil, err
Expand All @@ -116,11 +126,13 @@ func GetMachineIfExists(c client.Client, namespace, name string) (*clusterv1.Mac
return machine, nil
}

// IsControlPlaneMachine checks machine is a control plane node
// TODO(robertbailey): Remove this function
func IsControlPlaneMachine(machine *clusterv1.Machine) bool {
return machine.Spec.Versions.ControlPlane != ""
}

// IsNodeReady returns true if a node is ready
func IsNodeReady(node *v1.Node) bool {
for _, condition := range node.Status.Conditions {
if condition.Type == v1.NodeReady {
Expand All @@ -131,6 +143,7 @@ func IsNodeReady(node *v1.Node) bool {
return false
}

// Copy deep copies a Machine object
func Copy(m *clusterv1.Machine) *clusterv1.Machine {
ret := &clusterv1.Machine{}
ret.APIVersion = m.APIVersion
Expand All @@ -143,6 +156,7 @@ func Copy(m *clusterv1.Machine) *clusterv1.Machine {
return ret
}

// ExecCommand Executes a local command in the current shell
func ExecCommand(name string, args ...string) string {
cmdOut, err := exec.Command(name, args...).Output()
if err != nil {
Expand All @@ -152,6 +166,7 @@ func ExecCommand(name string, args ...string) string {
return string(cmdOut)
}

// Filter filters a list for a string
func Filter(list []string, strToFilter string) (newList []string) {
for _, item := range list {
if item != strToFilter {
Expand All @@ -161,6 +176,7 @@ func Filter(list []string, strToFilter string) (newList []string) {
return
}

// Contains returns true if a list contains a string
func Contains(list []string, strToSearch string) bool {
for _, item := range list {
if item == strToSearch {
Expand All @@ -170,41 +186,136 @@ func Contains(list []string, strToSearch string) bool {
return false
}

// GetNamespaceOrDefault returns the default namespace if given empty
// output
func GetNamespaceOrDefault(namespace string) string {
if namespace == "" {
return v1.NamespaceDefault
}
return namespace
}

// ParseClusterYaml parses a YAML file for cluster objects
func ParseClusterYaml(file string) (*clusterv1.Cluster, error) {
bytes, err := ioutil.ReadFile(file)
reader, err := os.Open(file)

if err != nil {
return nil, err
}

cluster := &clusterv1.Cluster{}
if err := yaml.Unmarshal(bytes, cluster); err != nil {
defer reader.Close()

decoder := yaml.NewYAMLOrJSONDecoder(reader, 32)

bytes, err := decodeClusterV1Kinds(decoder, "Cluster")
if err != nil {
return nil, err
}

return cluster, nil
var cluster clusterv1.Cluster

if err := json.Unmarshal(bytes[0], &cluster); err != nil {
return nil, err
}

return &cluster, nil
}

// ParseMachinesYaml extracts machine objects from a file
func ParseMachinesYaml(file string) ([]*clusterv1.Machine, error) {
bytes, err := ioutil.ReadFile(file)
reader, err := os.Open(file)

if err != nil {
return nil, err
}

list := &clusterv1.MachineList{}
if err := yaml.Unmarshal(bytes, &list); err != nil {
defer reader.Close()

decoder := yaml.NewYAMLOrJSONDecoder(reader, 32)
machineList, err := decodeMachineLists(decoder)

if err != nil {
return nil, err
}

// Will reread the file to find items which aren't a list.
// TODO: Make the Kind field mandatory on machines.yaml and then use the
// universal decoder instead of doing this.
// https://github.com/kubernetes-sigs/cluster-api/issues/717
if _, err := reader.Seek(0, 0); err != nil {
return nil, err
}

bytes, err := decodeClusterV1Kinds(decoder, "Machine")

// Original set of MachineLists did not have Kind field
if err != nil && !isMissingKind(err) {
return nil, err
}

if list == nil {
return []*clusterv1.Machine{}, nil
machines := []clusterv1.Machine{}

for _, m := range bytes {
var machine clusterv1.Machine
err = json.Unmarshal(m, &machine)
if err != nil {
return nil, err
}
machines = append(machines, machine)
}

machinesP := MachineP(machines)

return append(machinesP, machineList...), nil
}

// decodeMachineLists extracts MachineLists from a byte reader
func decodeMachineLists(decoder *yaml.YAMLOrJSONDecoder) ([]*clusterv1.Machine, error) {

outs := []clusterv1.Machine{}

for {
var out clusterv1.MachineList
err := decoder.Decode(&out)

if err == io.EOF {
break
}
outs = append(outs, out.Items...)
}
return MachineP(outs), nil
}

// isMissingKind reimplements runtime.IsMissingKind as the YAMLOrJSONDecoder
// hides the error type
func isMissingKind(err error) bool {
return strings.Contains(err.Error(), "Object 'Kind' is missing in")
}

// decodeClusterV1Kinds returns a slice of objects matching the clusterv1 kind
func decodeClusterV1Kinds(decoder *yaml.YAMLOrJSONDecoder, kind string) ([][]byte, error) {

outs := [][]byte{}

for {
var out unstructured.Unstructured
err := decoder.Decode(&out)

if err == io.EOF {
break
} else if err != nil {
return nil, err
}

if out.GetKind() == kind && out.GetAPIVersion() == clusterv1.SchemeGroupVersion.String() {
var marshaled []byte
marshaled, err = out.MarshalJSON()
if err != nil {
return outs, err
}
outs = append(outs, marshaled)
}
}

return MachineP(list.Items), nil
return outs, nil
}
Loading

0 comments on commit 9d16c16

Please sign in to comment.