Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better Wait Handling and Installs #1469

Merged
merged 2 commits into from
Apr 17, 2020
Merged

Better Wait Handling and Installs #1469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b52ec23
better check on instance before install, remove plan wait
kensipe Apr 15, 2020
489c9a9
adding more godocs to the waitForInstance function
kensipe Apr 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions pkg/kudoctl/cmd/plan.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@ const (
`
planStatusExample = ` # View plan status
kubectl kudo plan status --instance=<instanceName>
`
planWaitExample = ` # Wait on the current plan status to finish
kubectl kudo plan wait --instance=<instanceName>
`
planTriggerExample = ` # Trigger an instance plan
kubectl kudo plan trigger <planName> --instance=<instanceName>
Expand All @@ -35,7 +32,6 @@ func newPlanCmd(out io.Writer) *cobra.Command {

cmd.AddCommand(NewPlanHistoryCmd())
cmd.AddCommand(NewPlanStatusCmd(out))
cmd.AddCommand(NewPlanWaitCmd(out))
cmd.AddCommand(NewPlanTriggerCmd())

return cmd
Expand Down Expand Up @@ -81,29 +77,6 @@ func NewPlanStatusCmd(out io.Writer) *cobra.Command {
return cmd
}

//NewPlanWaitCmd waits on the status of an instance to complete
func NewPlanWaitCmd(out io.Writer) *cobra.Command {
options := &plan.WaitOptions{Out: out, WaitTime: 300}
cmd := &cobra.Command{
Use: "wait",
Short: "Waits on a plan to finish for a particular instance.",
Example: planWaitExample,
RunE: func(cmd *cobra.Command, args []string) error {
return plan.Wait(options, &Settings)
},
}

cmd.Flags().StringVar(&options.Instance, "instance", "", "The instance name available from 'kubectl get instances'")
cmd.Flags().Int64Var(&options.WaitTime, "wait-time", 300, "Specify the max wait time in seconds for CLI to wait for the current plan to complete (default \"300\")")

if err := cmd.MarkFlagRequired("instance"); err != nil {
clog.Printf("Please choose the instance with '--instance=<instanceName>': %v", err)
os.Exit(1)
}

return cmd
}

// NewPlanTriggerCmd creates a command that triggers a specific plan for an instance.
func NewPlanTriggerCmd() *cobra.Command {
options := &plan.TriggerOptions{}
Expand Down
56 changes: 0 additions & 56 deletions pkg/kudoctl/cmd/plan/plan_wait.go
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions pkg/kudoctl/util/kudo/install.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ func InstallPackage(kc *Client, resources *packages.Resources, skipInstance bool
}

instanceName = resources.Instance.ObjectMeta.Name
instanceExists, err := kc.InstanceExistsInCluster(operatorName, namespace, resources.OperatorVersion.Spec.Version, instanceName)
instance, err := kc.GetInstance(instanceName, namespace)
if err != nil {
return fmt.Errorf("failed to verify existing instance: %v", err)
}

if !instanceExists {
if instance == nil {
if _, err := kc.InstallInstanceObjToCluster(resources.Instance, namespace); err != nil {
return fmt.Errorf("failed to install instance %s: %v", instanceName, err)
}
Expand Down
12 changes: 9 additions & 3 deletions pkg/kudoctl/util/kudo/kudo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,9 +207,15 @@ func (c *Client) UpdateInstance(instanceName, namespace string, operatorVersion
return err
}

// WaitForInstance waits for instance to be "finished". oldInstance is nil if there is no oldInstance. oldInstance
// should be provided if there was an update or upgrade. The wait will then initially wait for the "new" plan to activate
// then return when completed. The error is either an error in working with kubernetes or a wait.ErrWaitTimeout
// WaitForInstance waits for instance to be "complete".
// It uses controller-runtime `wait.PollImmediate`, the function passed to it returns done==false if it isn't done.
// For a situation where there is no previous state (like install), the "lastPlanStatus" will be nil until the manager
// sets it, then it's state will be watched (see InInstanceDone for more detail)
// For a situation where there is previous state (like update, upgrade, plan trigger) than it is important AND required
// that the "oldInstance" be provided. Without it, it is possible for this function to be "racy" and "flaky" meaning the
// "current" status could be the old "done" status or the new status... it's hard to know. If the oldInstance is provided
// the wait will then initially wait for the "new" plan to activate then return when completed.
// The error is either an error in working with kubernetes or a wait.ErrWaitTimeout
func (c *Client) WaitForInstance(name, namespace string, oldInstance *v1beta1.Instance, timeout time.Duration) error {
// polling interval 1 sec
interval := 1 * time.Second
Expand Down