Add plugin skeleton

cmd/plugin/cmd/delete.go

@@ -0,0 +1,146 @@
+/*
+Copyright 2023 The Kubernetes 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 cmd
+
+import (
+	"context"
+
+	"github.com/go-errors/errors"
+	"github.com/spf13/cobra"
+)
+
+type deleteOptions struct {
+	kubeconfig                string
+	kubeconfigContext         string
+	coreProvider              string
+	bootstrapProviders        []string
+	controlPlaneProviders     []string
+	infrastructureProviders   []string
+	ipamProviders             []string
+	runtimeExtensionProviders []string
+	addonProviders            []string
+	includeNamespace          bool
+	includeCRDs               bool
+	deleteAll                 bool
+}
+
+var deleteOpts = &deleteOptions{}
+
+var deleteCmd = &cobra.Command{
+	Use:     "delete [providers]",
+	GroupID: groupManagement,
+	Short:   "Delete one or more providers from the management cluster",
+	Long: LongDesc(`
+		Delete one or more providers from the management cluster.`),
+
+	Example: Examples(`
+		# Deletes the AWS provider
+		# Please note that this implies the deletion of all provider components except the hosting namespace
+		# and the CRDs.
+		capioperator delete --infrastructure aws
+
+		# Deletes all the providers
+		# Important! As a consequence of this operation, all the corresponding resources managed by
+		# Cluster API Providers are orphaned and there might be ongoing costs incurred as a result of this.
+		capioperator delete --all
+
+		# Delete the AWS infrastructure provider and Core provider. This will leave behind Bootstrap and ControlPlane
+		# providers
+		# Important! As a consequence of this operation, all the corresponding resources managed by
+		# the AWS infrastructure provider and Cluster API Providers are orphaned and there might be
+		# ongoing costs incurred as a result of this.
+		capioperator delete --core cluster-api --infrastructure aws
+
+		# Delete the AWS infrastructure provider and related CRDs. Please note that this forces deletion of
+		# all the related objects (e.g. AWSClusters, AWSMachines etc.).
+		# Important! As a consequence of this operation, all the corresponding resources managed by
+		# the AWS infrastructure provider are orphaned and there might be ongoing costs incurred as a result of this.
+		capioperator delete --infrastructure aws --include-crd
+
+		# Delete the AWS infrastructure provider and its hosting Namespace. Please note that this forces deletion of
+		# all objects existing in the namespace.
+		# Important! As a consequence of this operation, all the corresponding resources managed by
+		# Cluster API Providers are orphaned and there might be ongoing costs incurred as a result of this.
+		capioperator delete --infrastructure aws --include-namespace
+
+		# Reset the management cluster to its original state
+		# Important! As a consequence of this operation all the corresponding resources on target clouds
+		# are "orphaned" and thus there may be ongoing costs incurred as a result of this.
+		capioperator delete --all --include-crd  --include-namespace`),
+	Args: cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runDelete()
+	},
+}
+
+func init() {
+	deleteCmd.Flags().StringVar(&deleteOpts.kubeconfig, "kubeconfig", "",
+		"Path to the kubeconfig file to use for accessing the management cluster. If unspecified, default discovery rules apply.")
+	deleteCmd.Flags().StringVar(&deleteOpts.kubeconfigContext, "kubeconfig-context", "",
+		"Context to be used within the kubeconfig file. If empty, current context will be used.")
+
+	deleteCmd.Flags().BoolVar(&deleteOpts.includeNamespace, "include-namespace", false,
+		"Forces the deletion of the namespace where the providers are hosted (and of all the contained objects)")
+	deleteCmd.Flags().BoolVar(&deleteOpts.includeCRDs, "include-crd", false,
+		"Forces the deletion of the provider's CRDs (and of all the related objects)")
+
+	deleteCmd.Flags().StringVar(&deleteOpts.coreProvider, "core", "",
+		"Core provider version (e.g. cluster-api:v1.1.5) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVarP(&deleteOpts.infrastructureProviders, "infrastructure", "i", nil,
+		"Infrastructure providers and versions (e.g. aws:v0.5.0) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVarP(&deleteOpts.bootstrapProviders, "bootstrap", "b", nil,
+		"Bootstrap providers and versions (e.g. kubeadm:v1.1.5) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVarP(&deleteOpts.controlPlaneProviders, "control-plane", "c", nil,
+		"ControlPlane providers and versions (e.g. kubeadm:v1.1.5) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVar(&deleteOpts.ipamProviders, "ipam", nil,
+		"IPAM providers and versions (e.g. infoblox:v0.0.1) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVar(&deleteOpts.runtimeExtensionProviders, "runtime-extension", nil,
+		"Runtime extension providers and versions (e.g. test:v0.0.1) to delete from the management cluster")
+	deleteCmd.Flags().StringSliceVar(&deleteOpts.addonProviders, "addon", nil,
+		"Add-on providers and versions (e.g. helm:v0.1.0) to delete from the management cluster")
+
+	deleteCmd.Flags().BoolVar(&deleteOpts.deleteAll, "all", false,
+		"Force deletion of all the providers")
+
+	RootCmd.AddCommand(deleteCmd)
+}
+
+func runDelete() error {
+	ctx := context.Background()
+
+	hasProviderNames := (deleteOpts.coreProvider != "") ||
+		(len(deleteOpts.bootstrapProviders) > 0) ||
+		(len(deleteOpts.controlPlaneProviders) > 0) ||
+		(len(deleteOpts.infrastructureProviders) > 0) ||
+		(len(deleteOpts.ipamProviders) > 0) ||
+		(len(deleteOpts.runtimeExtensionProviders) > 0) ||
+		(len(deleteOpts.addonProviders) > 0)
+
+	if deleteOpts.deleteAll && hasProviderNames {
+		return errors.New("The --all flag can't be used in combination with --core, --bootstrap, --control-plane, --infrastructure, --ipam, --extension, --addon")
+	}
+
+	if !deleteOpts.deleteAll && !hasProviderNames {
+		return errors.New("At least one of --core, --bootstrap, --control-plane, --infrastructure, --ipam, --extension, --addon should be specified or the --all flag should be set")
+	}
+
+	return deleteProvider(ctx, deleteOpts)
+}
+
+func deleteProvider(ctx context.Context, opts *deleteOptions) error {
+	return errors.New("Not implemented")
+}

cmd/plugin/cmd/doc.go

@@ -0,0 +1,18 @@
+/*
+Copyright 2023 The Kubernetes 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 cmd implements capioperator commands.
+package cmd

cmd/plugin/cmd/init.go

@@ -0,0 +1,131 @@
+/*
+Copyright 2023 The Kubernetes 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 cmd
+
+import (
+	"context"
+
+	"github.com/go-errors/errors"
+	"github.com/spf13/cobra"
+)
+
+type initOptions struct {
+	kubeconfig                string
+	kubeconfigContext         string
+	coreProvider              string
+	bootstrapProviders        []string
+	controlPlaneProviders     []string
+	infrastructureProviders   []string
+	ipamProviders             []string
+	runtimeExtensionProviders []string
+	addonProviders            []string
+	targetNamespace           string
+	validate                  bool
+	waitProviders             bool
+	waitProviderTimeout       int
+}
+
+var initOpts = &initOptions{}
+
+var initCmd = &cobra.Command{
+	Use:     "init",
+	GroupID: groupManagement,
+	Short:   "Initialize a management cluster",
+	Long: LongDesc(`
+		Initialize a management cluster.
+
+		Installs Cluster API operator, core components, the kubeadm bootstrap provider,
+		and the selected bootstrap and infrastructure providers.
+
+		The management cluster must be an existing Kubernetes cluster, make sure
+		to have enough privileges to install the desired components.
+
+		Some providers require secrets to be created before running 'capioperator init'.
+		Refer to the provider documentation, or use 'clusterctl config provider [name]' to get a list of required variables.
+
+		See https://cluster-api.sigs.k8s.io and https://github.com/kubernetes-sigs/cluster-api-operator/blob/main/docs/README.md for more details.`),
+
+	Example: Examples(`
+		# Initialize CAPI operator only without installing any providers.
+		# capioperator init
+
+		# Initialize a management cluster, by installing the given infrastructure provider.
+		#
+		# Note: when this command is executed on an empty management cluster,
+ 		#       it automatically triggers the installation of the Cluster API core provider.
+		capioperator init --infrastructure=aws
+
+		# Initialize a management cluster with a specific version of the given infrastructure provider.
+		capioperator init --infrastructure=aws:v0.4.1
+
+		# Initialize a management cluster with a specific version and namespace of the given infrastructure provider.
+		capioperator init --infrastructure=custom-namespace:aws:v0.4.1
+
+		# Initialize a management cluster with a custom kubeconfig path and the given infrastructure provider.
+		capioperator init --kubeconfig=foo.yaml --infrastructure=aws
+
+		# Initialize a management cluster with multiple infrastructure providers.
+		capioperator init --infrastructure=aws;vsphere
+
+		# Initialize a management cluster with a custom target namespace for the operator.
+		capioperator init --infrastructure aws --target-namespace foo`),
+	Args: cobra.NoArgs,
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runInit()
+	},
+}
+
+func init() {
+	initCmd.PersistentFlags().StringVar(&initOpts.kubeconfig, "kubeconfig", "",
+		"Path to the kubeconfig for the management cluster. If unspecified, default discovery rules apply.")
+	initCmd.PersistentFlags().StringVar(&initOpts.kubeconfigContext, "kubeconfig-context", "",
+		"Context to be used within the kubeconfig file. If empty, current context will be used.")
+	initCmd.PersistentFlags().StringVar(&initOpts.coreProvider, "core", "",
+		"Core provider version (e.g. cluster-api:v1.1.5) to add to the management cluster. If unspecified, Cluster API's latest release is used.")
+	initCmd.PersistentFlags().StringSliceVarP(&initOpts.infrastructureProviders, "infrastructure", "i", nil,
+		"Infrastructure providers and versions (e.g. aws:v0.5.0) to add to the management cluster.")
+	initCmd.PersistentFlags().StringSliceVarP(&initOpts.bootstrapProviders, "bootstrap", "b", nil,
+		"Bootstrap providers and versions (e.g. kubeadm:v1.1.5) to add to the management cluster. If unspecified, Kubeadm bootstrap provider's latest release is used.")
+	initCmd.PersistentFlags().StringSliceVarP(&initOpts.controlPlaneProviders, "control-plane", "c", nil,
+		"Control plane providers and versions (e.g. kubeadm:v1.1.5) to add to the management cluster. If unspecified, the Kubeadm control plane provider's latest release is used.")
+	initCmd.PersistentFlags().StringSliceVar(&initOpts.ipamProviders, "ipam", nil,
+		"IPAM providers and versions (e.g. infoblox:v0.0.1) to add to the management cluster.")
+	initCmd.PersistentFlags().StringSliceVar(&initOpts.runtimeExtensionProviders, "runtime-extension", nil,
+		"Runtime extension providers and versions (e.g. test:v0.0.1) to add to the management cluster.")
+	initCmd.PersistentFlags().StringSliceVar(&initOpts.addonProviders, "addon", nil,
+		"Add-on providers and versions (e.g. helm:v0.1.0) to add to the management cluster.")
+	initCmd.Flags().StringVarP(&initOpts.targetNamespace, "target-namespace", "n", "capi-operator-system",
+		"The target namespace where the operator should be deployed. If unspecified, the 'capi-operator-system' namespace is used.")
+	initCmd.Flags().BoolVar(&initOpts.waitProviders, "wait-providers", false,
+		"Wait for providers to be installed.")
+	initCmd.Flags().IntVar(&initOpts.waitProviderTimeout, "wait-provider-timeout", 5*60,
+		"Wait timeout per provider installation in seconds. This value is ignored if --wait-providers is false")
+	initCmd.Flags().BoolVar(&initOpts.validate, "validate", true,
+		"If true, capioperator will validate that the deployments will succeed on the management cluster.")
+
+	RootCmd.AddCommand(initCmd)
+}
+
+func runInit() error {
+	ctx := context.Background()
+
+	return initProvider(ctx, initOpts)
+}
+
+func initProvider(ctx context.Context, opts *initOptions) error {
+	return errors.New("Not implemented")
+}