initial commit after migrating from client-contrib

Author: rhuss

.gitignore

@@ -0,0 +1 @@
+kn-admin

OWNERS

@@ -0,0 +1,11 @@
+approvers:
+- zhanggbj
+- rhuss
+- maximilien
+- navidshaikh
+# Also including TOC members as backup:
+- evankanderson
+- grantr
+- markusthoemmes
+- mattmoor
+- tcnghia

README.adoc

@@ -0,0 +1,255 @@
+## kn-admin
+
+`kn admin` helps for Knative configuration when running on a Kubernetes cluster.
+
+### Description
+
+This kn-admin plugin is designed to help administrators and operators better manage a Knative platform installation with kn CLI.
+The plugin’s main objective is to make administration and operation workflows easier, for instance by making it easy to accomplish
+tasks such as feature flags enablement or disablement with one command, instead of many manual steps like modifying ConfigMaps or yaml files.
+
+### Usage
+
+----
+A plugin of kn client to manage Knative for administrators.
+
+For example:
+kn admin domain set - to set Knative route domain
+kn admin private-registry enable - to enable deployment from the private registry
+kn admin autoscaling update - to manage autoscaling config
+
+Usage:
+  kn admin [command]
+
+Available Commands:
+  autoscaling Manage autoscaling config
+  domain      Manage route domain
+  help        Help about any command
+  registry    Manage registry
+  version     Prints the plugin version
+
+Flags:
+      --config string   config file (default is $HOME/.config/kn/plugins/admin.yaml)
+  -h, --help            help for kn admin
+  -t, --toggle          Help message for toggle
+
+Use "kn admin [command] --help" for more information about a command.
+----
+
+#### `kn admin domain`
+
+----
+Set default route domain or route domain for Service with selectors. For example:
+
+kn admin domain set - to set Knative route domain
+
+Usage:
+  kn admin domain [flags]
+  kn admin domain [command]
+
+Available Commands:
+  set         set route domain
+  unset       unset route domain
+
+Flags:
+  -h, --help   help for domain
+
+Global Flags:
+      --config string   config file (default is $HOME/.config/kn/plugins/admin.yaml)
+
+Use "admin domain [command] --help" for more information about a command.
+
+----
+
+#### `kn admin registry`
+
+----
+Manage Service deployment from a private registry
+
+For example:
+
+kn admin registry add \
+  --secret=[SECRET_NAME]
+  --server=[REGISTRY_SERVER_URL] \
+  --email=[REGISTRY_EMAIL] \
+  --username=[REGISTRY_USER] \
+  --password=[REGISTRY_PASSWORD]
+
+Usage:
+  kn admin registry [command]
+
+Available Commands:
+  add         Add registry with credentials
+  help        Help about any command
+  remove      Remove registry settings
+
+Flags:
+  -h, --help                    help for registry
+  -n, --namespace string        the namespace to manage registries
+  -s, --serviceaccount string   the serviceaccount to save imagePullSecrets
+
+Global Flags:
+      --config string   config file (default is $HOME/.config/kn/plugins/admin.yaml)
+
+Use "kn admin registry [command] --help" for more information about a command.
+----
+
+#### `kn admin autoscaling`
+
+----
+Manage autoscaling provided by Knative Pod Autoscaler (KPA). For example:
+
+kn admin autoscaling update - to manage autoscaling config
+
+Usage:
+  kn admin autoscaling [command]
+
+Available Commands:
+  update      update autoscaling config
+
+Flags:
+  -h, --help   help for autoscaling
+
+Global Flags:
+      --config string   config file (default is $HOME/.config/kn/plugins/admin.yaml)
+
+Use "kn admin autoscaling [command] --help" for more information about a command.
+
+----
+
+#### `kn admin profiling`
+
+----
+Enable Knative Serving components profiling and download profiling data
+
+Usage:
+  kn admin profiling [flags]
+
+Aliases:
+  profiling, prof
+
+Examples:
+
+  # To enable Knative Serving profiling
+  kn admin profiling --enable
+
+  # To download heap profiling data of autoscaler
+  kn admin profiling --target autoscaler --heap
+
+  # To download 2 minutes execution trace data of networking-istio
+  kn admin profiling --target networking-istio --trace 2m
+
+  # To download go routing block and memory allocations data of activator and save them to /tmp
+  kn admin profiling --target activator --block --mem-allocs --save-to /tmp
+
+  # To download all available profiling data for specified pod activator-5979f56548
+  kn admin profiling --target activator-5979f56548 --all
+
+
+Flags:
+      --all              Download all available profiling data
+      --block            Download go routine blocking data
+      --cpu string       Download cpu profiling data, you can specify a profiling data duration with 's' for second(s), 'm' for minute(s) and 'h' for hour(s), e.g: '1m' for one minute (default "5s")
+      --disable          Disable Knative Serving profiling
+      --enable           Enable Knative Serving profiling
+      --goroutine        Download stack traces of all current goroutines data
+      --heap             Download heap profiling data
+  -h, --help             help for profiling
+      --mem-allocs       Download memory allocations data
+      --mutex            Download holders of contended mutexes data
+  -s, --save-to string   The path to save the downloaded profiling data, if not speicifed, the data will be saved in current working folder
+  -t, --target string    The profiling target. It can be a Knative Serving component name or a specific pod name, e.g: 'activator' or 'activator-586d468c99-w59cm'
+      --thread-create    Download stack traces that led to the creation of new OS threads data
+      --trace string     Download execution trace data, you can specify a trace data duration with 's' for second(s), 'm' for minute(s) and 'h' for hour(s), e.g: '1m' for one minute (default "5s")
+
+Global Flags:
+      --config string   config file (default is $HOME/.config/kn/plugins/admin.yaml)
+
+----
+### Examples
+
+#### As a Knative administrator, I want to update Knative route domain with my custom domain.
+
+
+.Update the default route domain if --selector no specified
+====
+----
+$ kn admin domain set --custom-domain mydomain.com
+Set Knative route domain mydomain.com
+----
+====
+
+.Update a custom domain with --selector and Service with a label app=v1 will use test.com
+====
+----
+$ kn admin domain set --custom-domain test.com --selector app=v1
+Set Knative route domain test.com with selector [app=v1]
+----
+====
+
+.Unset a route domain
+====
+----
+$ kn-admin domain unset --custom-domain mydomain.com
+Unset Knative route domain mydomain.com
+----
+====
+
+#### As a Knative administrator, I want to enable deploying from private registry.
+
+.Enable a private registry with given credentials for Service creation.
+=====
+-----
+$ kn admin registry add \
+  --secret=[SECRET_NAME] \
+  --server=[REGISTRY_SERVER_URL] \
+  --email=[REGISTRY_EMAIL] \
+  --username=[REGISTRY_USER] \
+  --password=[REGISTRY_PASSWORD] \
+  --namespace=[NAMESPACE] \
+  --serviceaccount=[SERVICE_ACCOUNT]
+-----
+=====
+
+.Remove a private registry by server and username.
+=====
+-----
+$ kn admin registry remove \
+  --username=[REGISTRY_USER] \
+  --server=[REGISTRY_SERVER_URL] \
+  --namespace=[NAMESPACE] \
+  --serviceaccount=[SERVICE_ACCOUNT]
+-----
+=====
+
+#### As a Knative administrator, I want to enable scale-to-zero for autoscaling.
+
+.Enable scale-to-zero for autoscaling.
+=====
+-----
+$ kn admin autoscaling update --scale-to-zero
+Updated Knative autoscaling config enable-scale-to-zero: true
+-----
+=====
+
+#### As a Knative administrator, I want to enable Knative Serving profiling and download profile data.
+
+.Enable Knative Serving profiling.
+=====
+-----
+$ kn admin profiling --enable
+Knative Serving profiling is enabled
+-----
+=====
+
+.Download 5 seconds cpu profiling data of activator component and save data to /tmp folder
+=====
+-----
+$ kn admin profiling --target activator --cpu 5s --save-to /tmp
+Starting to download profiling data for pod activator-586d468c99-w59cm...
+Saving 5 second(s) cpu profiling data to /tmp/activator-586d468c99-w59cm_cpu_5s_20200725165758
+Forwarding from 127.0.0.1:18008 -> 8008
+Forwarding from [::1]:18008 -> 8008
+Handling connection for 18008
+-----
+=====

cmd/kn-admin.go

@@ -0,0 +1,28 @@
+// Copyright © 2020 The Knative 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 main
+
+import (
+	"os"
+
+	_ "k8s.io/client-go/plugin/pkg/client/auth/gcp"
+	_ "k8s.io/client-go/plugin/pkg/client/auth/oidc"
+	"knative.dev/client-contrib/plugins/admin/core"
+)
+
+func main() {
+	if err := core.NewAdminCommand().Execute(); err != nil {
+		os.Exit(1)
+	}
+}

core/root.go

@@ -0,0 +1,86 @@
+// Copyright © 2020 The Knative 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 core
+
+import (
+	"fmt"
+	"os"
+
+	homedir "github.com/mitchellh/go-homedir"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+	"knative.dev/client-contrib/plugins/admin/pkg"
+	"knative.dev/client-contrib/plugins/admin/pkg/command"
+	"knative.dev/client-contrib/plugins/admin/pkg/command/autoscaling"
+	"knative.dev/client-contrib/plugins/admin/pkg/command/domain"
+	"knative.dev/client-contrib/plugins/admin/pkg/command/profiling"
+	private_registry "knative.dev/client-contrib/plugins/admin/pkg/command/registry"
+)
+
+var cfgFile string
+
+// NewAdminCommand represents the base command when called without any subcommands
+func NewAdminCommand(params ...pkg.AdminParams) *cobra.Command {
+	p := &pkg.AdminParams{}
+	p.Initialize()
+
+	rootCmd := &cobra.Command{
+		Use:   "kn\u00A0admin",
+		Short: "A plugin of kn client to manage Knative",
+		Long:  `kn admin: a plugin of kn client to manage Knative for administrators`,
+
+		// disable printing usage when error occurs
+		SilenceUsage: true,
+	}
+	cobra.OnInitialize(initConfig)
+	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.config/kn/plugins/admin.yaml)")
+	rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
+	rootCmd.SetOut(os.Stdout)
+	rootCmd.AddCommand(domain.NewDomainCmd(p))
+	rootCmd.AddCommand(private_registry.NewPrivateRegistryCmd(p))
+	rootCmd.AddCommand(autoscaling.NewAutoscalingCmd(p))
+	rootCmd.AddCommand(profiling.NewProfilingCommand(p))
+	rootCmd.AddCommand(command.NewVersionCommand())
+
+	// Add default help page if there's unknown command
+	rootCmd.InitDefaultHelpCmd()
+	return rootCmd
+}
+
+// initConfig reads in config file and ENV variables if set.
+func initConfig() {
+	if cfgFile != "" {
+		// Use config file from the flag.
+		viper.SetConfigFile(cfgFile)
+	} else {
+		// Find home directory.
+		home, err := homedir.Dir()
+		if err != nil {
+			fmt.Println(err)
+			os.Exit(1)
+		}
+
+		// Search config in home directory with name ".admin" (without extension).
+		viper.AddConfigPath(home)
+		viper.SetConfigName(".admin")
+	}
+
+	viper.AutomaticEnv() // read in environment variables that match
+
+	// If a config file is found, read it in.
+	if err := viper.ReadInConfig(); err == nil {
+		fmt.Println("Using config file:", viper.ConfigFileUsed())
+	}
+}