knative-extensions / kn-plugin-operator Goto Github PK

View Code? Open in Web Editor NEW

5.0 8.0 11.0 11.67 MB

Kn plugin for managing Knative with Knative Operator.

License: Apache License 2.0

Go 92.66% Shell 7.34%

kn-plugin-operator's Introduction

kn-plugin-operator

kn-plugin-operator is a plugin of Knative Client, for managing Knative with Knative Operator from the command line.

Description

With this plugin, you can install/uninstall Knative Operator, install/uninstall Knative components, and configure Knative.

Build and Install

You must set up your development environment before you build.

Building:

Once you've set up your development environment, let's build the plugin.

$ go build -o kn-operator ./cmd/kn-operator.go

You'll get an executable plugin binary namely kn-operator in your current dir. You're ready to use kn-operator as a stand alone binary, check the available commands ./kn-operator -h.

Installing:

If you'd like to use the plugin with kn CLI, install the plugin by simply copying the executable file under kn plugins directory as:

mkdir -p ~/.config/kn/plugins
cp kn-operator ~/.config/kn/plugins

Note: The plugins directory defaults to $base_dir/plugins relative to your kn config file location.

On Windows, the default plugins directory is in %APPDATA%\kn\plugins

Check if plugin is loaded

kn -h

Run it

kn operator -h

You can use the built binary to run the commands. You can also use the bash scripts directly to run your commands. All the bash scripts are available under the directory scripts.

kn-plugin-operator's People

Contributors

Stargazers

Watchers

Forkers

houshengbo knative-automation dsimansk rhuss knative-prow-robot psschwei dprotaso lionelvillard joshualyon evankanderson fossabot

kn-plugin-operator's Issues

The command does not work on enabling the Ingress and the eventing source

Add the progress indicator to all long-running jobs

Some commands, like installing knative components, may take a long time to finish.
Implement the progress indicator to show the progress of these jobs.

Help menu shows `kn operation` instead of `kn operator`

When running kn operator --help, the example commands are listed as kn operation rather than kn operator. It also lists the parent kn commands, which I don't think is the standard behavior.

$ kn operator --help
kn operation: a plugin of kn client to operate Knative components.
For example:
kn operation install
kn operation install -c serving
kn operation install -c eventing

Usage:
  kn [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  configure   Configure the Knative Serving or Eventing
  enable      Enable the ingress for Knative Serving
  help        Help about any command
  install     Install Knative Operator or Knative components
  remove      Remove the ingress for Knative Serving
  uninstall   Uninstall Knative Operator or Knative components

Flags:
  -h, --help   help for kn

Use "kn [command] --help" for more information about a command.

Implement upgrade across multiple minor versions for serving and eventing.

Link to the original one: knative/operator#744.

Uninstall command is not complete

uninstall command only removes the operator deployment. Install command, uses the overlay to install many other resources including the webhook.

here, we should just use the same overlay and remove the resources.

Configuration of resouces by setting the cpu and the memory in the limits and requests

Operator support to configure the the cpu and the memory in the limits and requests for a certain deployment.
kn-plugin-operator needs to support it in the roadmap.

All the configuration options need to be removed

The command line needs to provide the option to remove all the possible configurations.

Configuration of affinity for the deployment

Feature Request: show current installation and configuration

It'd be nice to have a command showing what Knative components have been installed instead of relying on kubectl

Bug with running the replica removal commands

The removal of the replicas globally for all deployments and one specific deployment will lead to the crash of the operator itself.
Need to investigate on the root causes.

Support of uninstalling knative operator, serving and eventing

This plugin needs to implement the following commands to uninstall knative operator or knative component:

To remove the knative operator

kn operation uninstall

To remove Knative Serving

kn operation uninstall -c serving

To remove Knative Eventing

kn operation uninstall -c eventing

The namespace can be specified with the flag --namespace for each command.

Check the version in the knativeserving or knativeeventing. whether they exist and what namespace they are under. Check whether the existing ns is consistent with the target ns.
If knativeserving or knativeeventing does not exist, check whether the deployments of knative exists. check whether ns is consistent.
if the ns is not consistent, return an error.

The command does not work on the installating operator under a certain namespace

  status:
    conditions:
    - lastTransitionTime: "2022-07-14T22:27:16Z"
      status: Unknown
      type: DependenciesInstalled
    - lastTransitionTime: "2022-07-14T22:27:16Z"
      status: Unknown
      type: DeploymentsAvailable
    - lastTransitionTime: "2022-07-14T22:30:07Z"
      message: |-
        Install failed with message: clusterrolebindings.rbac.authorization.k8s.io "knative-serving-controller-admin" is forbidden: user "system:serviceaccount:knative-operator:knative-operator" (groups=["system:serviceaccounts" "system:serviceaccounts:knative-operator" "system:authenticated"]) is attempting to grant RBAC permissions not currently held:
        {APIGroups:[""], Resources:["endpoints/restricted"], Verbs:["create"]}
        {APIGroups:["apiextensions.k8s.io"], Resources:["customresourcedefinitions/status"], Verbs:["create" "delete"]}
        {APIGroups:["apps"], Resources:["deployments/finalizers"], Verbs:["get" "list" "create" "delete" "patch" "watch"]}
        {APIGroups:["autoscaling"], Resources:["horizontalpodautoscalers"], Verbs:["patch" "watch"]}
        {APIGroups:["autoscaling.internal.knative.dev"], Resources:["*"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["autoscaling.internal.knative.dev"], Resources:["*/finalizers"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["autoscaling.internal.knative.dev"], Resources:["*/status"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.internal.knative.dev"], Resources:["*"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.internal.knative.dev"], Resources:["*/finalizers"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.internal.knative.dev"], Resources:["*/status"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.istio.io"], Resources:["destinationrules"], Verbs:["get" "list" "create" "update" "delete" "patch" "watch"]}
        {APIGroups:["networking.istio.io"], Resources:["gateways"], Verbs:["get" "list" "create" "update" "delete" "patch" "watch"]}
        {APIGroups:["networking.istio.io"], Resources:["virtualservices"], Verbs:["get" "list" "create" "update" "delete" "patch" "watch"]}
        {APIGroups:["serving.knative.dev"], Resources:["*"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["serving.knative.dev"], Resources:["*/finalizers"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["serving.knative.dev"], Resources:["*/status"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
      reason: Error
      status: "False"
      type: InstallSucceeded
    - lastTransitionTime: "2022-07-14T22:30:07Z"
      message: |-
        Install failed with message: clusterrolebindings.rbac.authorization.k8s.io "knative-serving-controller-admin" is forbidden: user "system:serviceaccount:knative-operator:knative-operator" (groups=["system:serviceaccounts" "system:serviceaccounts:knative-operator" "system:authenticated"]) is attempting to grant RBAC permissions not currently held:
        {APIGroups:[""], Resources:["endpoints/restricted"], Verbs:["create"]}
        {APIGroups:["apiextensions.k8s.io"], Resources:["customresourcedefinitions/status"], Verbs:["create" "delete"]}
        {APIGroups:["apps"], Resources:["deployments/finalizers"], Verbs:["get" "list" "create" "delete" "patch" "watch"]}
        {APIGroups:["autoscaling"], Resources:["horizontalpodautoscalers"], Verbs:["patch" "watch"]}
        {APIGroups:["autoscaling.internal.knative.dev"], Resources:["*"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["autoscaling.internal.knative.dev"], Resources:["*/finalizers"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["autoscaling.internal.knative.dev"], Resources:["*/status"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.internal.knative.dev"], Resources:["*"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.internal.knative.dev"], Resources:["*/finalizers"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.internal.knative.dev"], Resources:["*/status"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["networking.istio.io"], Resources:["destinationrules"], Verbs:["get" "list" "create" "update" "delete" "patch" "watch"]}
        {APIGroups:["networking.istio.io"], Resources:["gateways"], Verbs:["get" "list" "create" "update" "delete" "patch" "watch"]}
        {APIGroups:["networking.istio.io"], Resources:["virtualservices"], Verbs:["get" "list" "create" "update" "delete" "patch" "watch"]}
        {APIGroups:["serving.knative.dev"], Resources:["*"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["serving.knative.dev"], Resources:["*/finalizers"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
        {APIGroups:["serving.knative.dev"], Resources:["*/status"], Verbs:["get" "list" "create" "update" "delete" "deletecollection" "patch" "watch"]}
      reason: Error
      status: "False"
      type: Ready
    - lastTransitionTime: "2022-07-14T22:27:16Z"
      status: "True"
      type: VersionMigrationEligible
    observedGeneration: 1

Support of enabling the ingresses and eventing sources

Based on the description in the design document: https://docs.google.com/document/d/1OzYKB75ZaaXzLTpCuccYj2Pbb_3KQ5BANOg7acylrzQ/edit Search for the section "Enable/install the ingress plugin and the event sources" to read the details.

The operator plugin is about to implement the installation/enablement of ingresses and eventing sources.
To enable a certain ingress, e.g. istio, we run the command:

kn-operator enable ingress --istio --namespace <namespace>

To enable a certain eventing source, like github, we can run the command:

kn-operator enable eventing-source --github --namespace <namespace>

Multiple sources can be enabled as follows:

kn-operator enable eventing-source --ceph --couchdb --github … --namespace <namespace>