Refactor support dump CLI (#1301)

This commit is contained in:
Ta-Ching Chen
2019-09-04 14:42:47 +08:00
committed by GitHub
parent 62016b2f83
commit 0d872020e3
11 changed files with 104 additions and 40 deletions
+165
View File
@@ -0,0 +1,165 @@
/*
Copyright 2019 The Fission 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 support
import (
"fmt"
"os"
"path/filepath"
"sync"
"time"
"github.com/pkg/errors"
"github.com/fission/fission/pkg/controller/client"
"github.com/fission/fission/pkg/fission-cli/cliwrapper/cli"
"github.com/fission/fission/pkg/fission-cli/cmd"
"github.com/fission/fission/pkg/fission-cli/cmd/support/resources"
"github.com/fission/fission/pkg/fission-cli/util"
"github.com/fission/fission/pkg/utils"
)
const (
DUMP_ARCHIVE_PREFIX = "fission-dump"
DEFAULT_OUTPUT_DIR = "fission-dump"
)
type DumpSubCommand struct {
client *client.Client
}
func Dump(flags cli.Input) error {
opts := &DumpSubCommand{
client: cmd.GetServer(flags),
}
return opts.do(flags)
}
func (opts *DumpSubCommand) do(flags cli.Input) error {
fmt.Println("Start dumping process...")
nozip := flags.Bool("nozip")
outputDir := flags.String("output")
// check whether the dump directory exists.
_, err := os.Stat(outputDir)
if err != nil && os.IsNotExist(err) {
err = os.Mkdir(outputDir, 0755)
if err != nil {
panic(err)
}
} else if err != nil {
panic(errors.Wrap(err, "Error checking dump directory status"))
}
outputDir, err = filepath.Abs(outputDir)
if err != nil {
panic(errors.Wrap(err, "Error creating dump directory for dumping files"))
}
_, k8sClient := util.GetKubernetesClient()
ress := map[string]resources.Resource{
// kubernetes info
"kubernetes-version": resources.NewKubernetesVersion(k8sClient),
"kubernetes-nodes": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesNode, ""),
// fission info
"fission-version": resources.NewFissionVersion(opts.client),
// fission component logs & spec
"fission-components-svc-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesService,
"svc in (buildermgr, controller, executor, influxdb, kubewatcher, logger, mqtrigger, nats-streaming, redis, router, storagesvc, timer)"),
"fission-components-deployment-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesDeployment,
"svc in (buildermgr, controller, executor, influxdb, kubewatcher, logger, mqtrigger, nats-streaming, redis, router, storagesvc, timer)"),
"fission-components-daemonset-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesDaemonSet,
"svc in (buildermgr, controller, executor, influxdb, kubewatcher, logger, mqtrigger, nats-streaming, redis, router, storagesvc, timer)"),
"fission-components-pod-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesPod,
"svc in (buildermgr, controller, executor, influxdb, kubewatcher, logger, mqtrigger, nats-streaming, redis, router, storagesvc, timer)"),
"fission-components-pod-log": resources.NewKubernetesPodLogDumper(k8sClient,
"svc in (buildermgr, controller, executor, influxdb, kubewatcher, logger, mqtrigger, nats-streaming, redis, router, storagesvc, timer)"),
// fission builder logs & spec
"fission-builder-svc-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesService, "owner=buildermgr"),
"fission-builder-deployment-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesDeployment, "owner=buildermgr"),
"fission-builder-pod-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesPod, "owner=buildermgr"),
"fission-builder-pod-log": resources.NewKubernetesPodLogDumper(k8sClient, "owner=buildermgr"),
// fission function logs & spec
"fission-function-svc-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesService, "executorType=newdeploy"),
"fission-function-deployment-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesDeployment, "executorType in (poolmgr, newdeploy)"),
"fission-function-pod-spec": resources.NewKubernetesObjectDumper(k8sClient, resources.KubernetesPod, "executorType in (poolmgr, newdeploy)"),
"fission-function-pod-log": resources.NewKubernetesPodLogDumper(k8sClient, "executorType in (poolmgr, newdeploy)"),
// CRD resources
"fission-crd-packages": resources.NewCrdDumper(opts.client, resources.CrdPackage),
"fission-crd-environments": resources.NewCrdDumper(opts.client, resources.CrdEnvironment),
"fission-crd-functions": resources.NewCrdDumper(opts.client, resources.CrdFunction),
"fission-crd-httptriggers": resources.NewCrdDumper(opts.client, resources.CrdHttpTrigger),
"fission-crd-kubewatchers": resources.NewCrdDumper(opts.client, resources.CrdKubeWatcher),
"fission-crd-mqtriggers": resources.NewCrdDumper(opts.client, resources.CrdMessageQueueTrigger),
"fission-crd-timetriggers": resources.NewCrdDumper(opts.client, resources.CrdTimeTrigger),
}
dumpName := fmt.Sprintf("%v_%v", DUMP_ARCHIVE_PREFIX, time.Now().Unix())
dumpDir := filepath.Join(outputDir, dumpName)
wg := &sync.WaitGroup{}
tempDir, err := utils.GetTempDir()
if err != nil {
fmt.Printf("Error creating temporary directory: %v\n", err.Error())
return err
}
for key, res := range ress {
dir := fmt.Sprintf("%v/%v/", tempDir, key)
if _, err := os.Stat(dir); os.IsNotExist(err) {
err = os.MkdirAll(dir, 0755)
if err != nil {
panic(err)
}
}
wg.Add(1)
go func(res resources.Resource, dir string) {
defer wg.Done()
res.Dump(dir)
}(res, dir)
}
wg.Wait()
if !nozip {
defer os.RemoveAll(tempDir)
path := filepath.Join(outputDir, fmt.Sprintf("%v.zip", dumpName))
_, err := utils.MakeArchive(path, tempDir)
if err != nil {
fmt.Printf("Error creating archive for dump files: %v", err)
return err
}
fmt.Printf("The archive dump file is %v\n", path)
} else {
err = os.Rename(tempDir, dumpDir)
if err != nil {
fmt.Printf("Error creating dump directory: %v\n", err.Error())
return err
}
fmt.Printf("The dump files are placed at %v\n", dumpDir)
}
return nil
}
@@ -0,0 +1,158 @@
/*
Copyright 2018 The Fission 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 resources
import (
"fmt"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
fv1 "github.com/fission/fission/pkg/apis/fission.io/v1"
"github.com/fission/fission/pkg/controller/client"
"github.com/fission/fission/pkg/fission-cli/log"
"github.com/fission/fission/pkg/types"
)
const (
CrdEnvironment = "Environment"
CrdFunction = "Function"
CrdPackage = "Packages"
CrdHttpTrigger = "HTTPTrigger"
CrdKubeWatcher = "KubeWatcher"
CrdMessageQueueTrigger = "MessageQueue"
CrdTimeTrigger = "TimeTrigger"
)
type CrdDumper struct {
client *client.Client
crdType string
}
func NewCrdDumper(client *client.Client, crdType string) Resource {
return CrdDumper{client: client, crdType: crdType}
}
func (res CrdDumper) Dump(dumpDir string) {
switch res.crdType {
case CrdEnvironment:
items, err := res.client.EnvironmentList(metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
return
}
for _, item := range items {
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
case CrdFunction:
items, err := res.client.FunctionList(metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
return
}
for _, item := range items {
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
case CrdPackage:
items, err := res.client.PackageList(metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
return
}
for _, item := range items {
item = pkgClean(item)
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
case CrdHttpTrigger:
items, err := res.client.HTTPTriggerList(metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
return
}
for _, item := range items {
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
case CrdKubeWatcher:
items, err := res.client.WatchList(metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
return
}
for _, item := range items {
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
case CrdMessageQueueTrigger:
var triggers []fv1.MessageQueueTrigger
for _, mqType := range []string{types.MessageQueueTypeNats, types.MessageQueueTypeASQ} {
l, err := res.client.MessageQueueTriggerList(mqType, metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
break
}
triggers = append(triggers, l...)
}
for _, item := range triggers {
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
case CrdTimeTrigger:
items, err := res.client.TimeTriggerList(metav1.NamespaceAll)
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list: %v", res.crdType, err))
return
}
for _, item := range items {
f := getFileName(dumpDir, item.Metadata)
writeToFile(f, item)
}
default:
log.Info(fmt.Sprintf("Unknown type: %v", res.crdType))
}
}
func pkgClean(pkg fv1.Package) fv1.Package {
// mask the sensitive information
// use "-" as mask value to indicate the field wasn't empty
if pkg.Spec.Source.Literal != nil {
pkg.Spec.Source.Literal = []byte("-")
}
if pkg.Spec.Deployment.Literal != nil {
pkg.Spec.Deployment.Literal = []byte("-")
}
return pkg
}
@@ -0,0 +1,39 @@
/*
Copyright 2018 The Fission 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 resources
import (
"fmt"
"path/filepath"
"github.com/fission/fission/pkg/controller/client"
"github.com/fission/fission/pkg/fission-cli/util"
)
type FissionVersion struct {
client *client.Client
}
func NewFissionVersion(client *client.Client) Resource {
return FissionVersion{client: client}
}
func (res FissionVersion) Dump(dumpDir string) {
ver := util.GetVersion(res.client)
file := filepath.Clean(fmt.Sprintf("%v/%v", dumpDir, "fission-version.txt"))
writeToFile(file, ver)
}
@@ -0,0 +1,254 @@
/*
Copyright 2018 The Fission 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 resources
import (
"bufio"
"bytes"
"fmt"
"io"
"path/filepath"
"sync"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"github.com/fission/fission/pkg/fission-cli/log"
)
const (
KubernetesService = "Service"
KubernetesDeployment = "Deployment"
KubernetesPod = "Pod"
KubernetesHPA = "HPA"
KubernetesNode = "Node"
KubernetesDaemonSet = "DaemonSet"
)
// Kubernetes Version
type KubernetesVersion struct {
client *kubernetes.Clientset
}
func NewKubernetesVersion(clientset *kubernetes.Clientset) Resource {
return KubernetesVersion{client: clientset}
}
func (res KubernetesVersion) Dump(dumpDir string) {
serverVer, err := res.client.ServerVersion()
if err != nil {
log.Info(fmt.Sprintf("Error setting up kubernetes client: %v", err))
return
}
file := fmt.Sprintf("%v/%v", dumpDir, "kubernetes-version.txt")
writeToFile(file, serverVer)
}
// Kubernetes Object Dumper
type KubernetesObjectDumper struct {
client *kubernetes.Clientset
objType string
selector string
}
func NewKubernetesObjectDumper(clientset *kubernetes.Clientset, objType string, selector string) Resource {
return KubernetesObjectDumper{
client: clientset,
objType: objType,
selector: selector,
}
}
func (res KubernetesObjectDumper) Dump(dumpDir string) {
switch res.objType {
case KubernetesService:
objs, err := res.client.CoreV1().Services(metav1.NamespaceAll).List(metav1.ListOptions{LabelSelector: res.selector})
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list with selector %v: %v", res.objType, res.selector, err))
return
}
for _, item := range objs.Items {
item = serviceClean(item)
f := getFileName(dumpDir, item.ObjectMeta)
writeToFile(f, item)
}
case KubernetesDeployment:
objs, err := res.client.AppsV1().Deployments(metav1.NamespaceAll).List(metav1.ListOptions{LabelSelector: res.selector})
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list with selector %v: %v", res.objType, res.selector, err))
return
}
for _, item := range objs.Items {
f := getFileName(dumpDir, item.ObjectMeta)
writeToFile(f, item)
}
case KubernetesPod:
objs, err := res.client.CoreV1().Pods(metav1.NamespaceAll).List(metav1.ListOptions{LabelSelector: res.selector})
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list with selector %v: %v", res.objType, res.selector, err))
return
}
for _, item := range objs.Items {
f := getFileName(dumpDir, item.ObjectMeta)
writeToFile(f, item)
}
case KubernetesHPA:
objs, err := res.client.AutoscalingV2beta1().HorizontalPodAutoscalers(metav1.NamespaceAll).List(metav1.ListOptions{LabelSelector: res.selector})
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list with selector %v: %v", res.objType, res.selector, err))
return
}
for _, item := range objs.Items {
f := getFileName(dumpDir, item.ObjectMeta)
writeToFile(f, item)
}
case KubernetesDaemonSet:
objs, err := res.client.AppsV1().DaemonSets(metav1.NamespaceAll).List(metav1.ListOptions{LabelSelector: res.selector})
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list with selector %v: %v", res.objType, res.selector, err))
return
}
for _, item := range objs.Items {
f := getFileName(dumpDir, item.ObjectMeta)
writeToFile(f, item)
}
case KubernetesNode:
objs, err := res.client.CoreV1().Nodes().List(metav1.ListOptions{LabelSelector: res.selector})
if err != nil {
log.Info(fmt.Sprintf("Error getting %v list with selector %v: %v", res.objType, res.selector, err))
return
}
for _, item := range objs.Items {
item = nodeClean(item)
// Node doesn't have namespace value, use name here
f := filepath.Clean(fmt.Sprintf("%v/%v", dumpDir, item.Name))
writeToFile(f, item)
}
default:
log.Info(fmt.Sprintf("Unknown type: %v", res.objType))
return
}
}
// serviceClean remove sensitive data(e.g. public IP, external name) from service objects
func serviceClean(svc corev1.Service) corev1.Service {
svc.Spec.ExternalIPs = []string{}
svc.Spec.LoadBalancerIP = ""
svc.Spec.LoadBalancerSourceRanges = []string{}
svc.Spec.ExternalName = ""
svc.Status.LoadBalancer = corev1.LoadBalancerStatus{}
return svc
}
func nodeClean(node corev1.Node) corev1.Node {
var nodeAddresses []corev1.NodeAddress
for _, address := range node.Status.Addresses {
// use whitelist to filter the necessary information for debugging
if address.Type == "InternalIP" || address.Type == "Hostname" {
nodeAddresses = append(nodeAddresses, address)
}
}
node.Status.Addresses = nodeAddresses
return node
}
type KubernetesPodLogDumper struct {
client *kubernetes.Clientset
labelSelector string
}
func NewKubernetesPodLogDumper(clientset *kubernetes.Clientset, selector string) Resource {
return KubernetesPodLogDumper{
client: clientset,
labelSelector: selector,
}
}
func (res KubernetesPodLogDumper) Dump(dumpDir string) {
l, err := res.client.CoreV1().
Pods(metav1.NamespaceAll).
List(metav1.ListOptions{LabelSelector: res.labelSelector})
if err != nil {
log.Info(fmt.Sprintf("Error getting controller list: %v", err))
return
}
wg := &sync.WaitGroup{}
for _, p := range l.Items {
wg.Add(1)
go func(pod corev1.Pod) {
defer wg.Done()
// dump logs from each containers
for _, container := range append(pod.Spec.Containers, pod.Spec.InitContainers...) {
req := res.client.CoreV1().Pods(pod.Namespace).
GetLogs(pod.Name, &corev1.PodLogOptions{Container: container.Name})
stream, err := req.Stream()
if err != nil {
log.Info(fmt.Sprintf("Error streaming logs for pod %v: %v", pod.Name, err))
return
}
reader := bufio.NewReader(stream)
var buffer bytes.Buffer
for {
line, _, err := reader.ReadLine()
if err != nil {
if err == io.EOF {
stream.Close()
break
}
log.Info(fmt.Sprintf("Error reading logs from buffer: %v", err))
return
}
_, err = buffer.WriteString(string(line) + "\n")
if err != nil {
log.Info(fmt.Sprintf("Error writing bytes to buffer: %v", err))
}
}
f := getPodFileName(dumpDir, pod.ObjectMeta, container.Name)
writeToFile(f, buffer.String())
stream.Close()
}
}(p)
}
wg.Wait()
}
@@ -0,0 +1,62 @@
/*
Copyright 2018 The Fission 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 resources
import (
"fmt"
"io/ioutil"
"path/filepath"
"github.com/ghodss/yaml"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"github.com/fission/fission/pkg/fission-cli/log"
"github.com/fission/fission/pkg/utils"
)
type Resource interface {
Dump(string)
}
func getFileName(dumpdir string, meta metav1.ObjectMeta) string {
f := fmt.Sprintf("%v/%v_%v_%v.txt", dumpdir, meta.Namespace, meta.Name, meta.ResourceVersion)
return filepath.Clean(f)
}
func getPodFileName(dumpdir string, pod metav1.ObjectMeta, containerName string) string {
f := fmt.Sprintf("%v/%v_%v_%v_%v.txt", dumpdir, pod.Namespace, pod.Name, pod.ResourceVersion, containerName)
return filepath.Clean(f)
}
func writeToFile(file string, obj interface{}) {
bs, err := yaml.Marshal(obj)
if err != nil {
log.Info(fmt.Sprintf("Error encoding object: %v", err))
return
}
// Due to unknown reason, the kubernetes objectMeta fields contain
// empty byte and will fail os.Create/os.Openfile with error message
// "open <file> invalid argument". To fix the problem, we need to
// remove the empty byte from string.
file = string(utils.RemoveZeroBytes([]byte(file)))
err = ioutil.WriteFile(file, bs, 0644)
if err != nil {
log.Info(fmt.Sprintf("Error writing file %v: %v", file, err))
}
}