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.

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

Improve description for machine deployment.spec.strategy.type #9376

Closed
jayunit100 opened this issue Sep 5, 2023 · 2 comments · Fixed by #9386
Closed

Improve description for machine deployment.spec.strategy.type #9376

jayunit100 opened this issue Sep 5, 2023 · 2 comments · Fixed by #9386
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@jayunit100
Copy link
Contributor

What steps did you take and what happened?

For folks doing things w/ i.e. GPU where theres resource constraints its important to know the alterantvies RolloutStrategies....

kubo@PmilRMT2e4lE2:~$ kubectl explain md.spec.strategy
KIND:     MachineDeployment
VERSION:  cluster.x-k8s.io/v1beta1

RESOURCE: strategy <Object>

DESCRIPTION:
     The deployment strategy to use to replace existing machines with new ones.

FIELDS:
   rollingUpdate        <Object>
     Rolling update config params. Present only if MachineDeploymentStrategyType
     = RollingUpdate.


*** WHAT ELSE :) ***

   type <string>
     Type of deployment. Default is RollingUpdate.

kubo@PmilRMT2e4lE2:~$ kubectl explain md.spec.strategy.type
KIND:     MachineDeployment
VERSION:  cluster.x-k8s.io/v1beta1

FIELD:    type <string>

DESCRIPTION:
     Type of deployment. Default is RollingUpdate.

What did you expect to happen?

The description would have valid rollout values since they are strongly typed

Cluster API version

cluster-api/cluster-api-controller:v1.4.5

Kubernetes version

No response

Anything else you would like to add?

No response

Label(s) to be applied

/kind bug
One or more /area label. See https://github.com/kubernetes-sigs/cluster-api/labels?q=area for the list of labels.

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 5, 2023
@fabriziopandini
Copy link
Member

fabriziopandini commented Sep 7, 2023

/triage accepted

The OnDelete strategy doesn't have options, so there is no missing types.

But let's change

// Type of deployment.
into

// Type of deployment, allowed values RollingUpdate, OnDelete. Default is RollingUpdate.

/help
/good-first-issue

@k8s-ci-robot
Copy link
Contributor

@fabriziopandini:
This request has been marked as suitable for new contributors.

Guidelines

Please ensure that the issue body includes answers to the following questions:

  • Why are we solving this issue?
  • To address this issue, are there any code changes? If there are code changes, what needs to be done in the code and what places can the assignee treat as reference points?
  • Does this issue have zero to low barrier of entry?
  • How can the assignee reach out to you for help?

For more details on the requirements of such an issue, please see here and ensure that they are met.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/triage accepted

Let's change

// Type of deployment.
into

// Type of deployment, allowed values RollingUpdate, OnDelete. Default is RollingUpdate.

/help
/good-first-issue

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Sep 7, 2023
@fabriziopandini fabriziopandini changed the title Missing types for the machine deployment in the "describe" Improve description for machine deployment.spec.strategy.type Sep 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants